diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2008-02-18 10:52:02 +0000 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2008-02-18 10:52:02 +0000 |
| commit | 0754bda285f17e6fb750ce6dea1db788e9e0ccde (patch) | |
| tree | f2e854813607144d5a242b5a1216ef0562f683b1 | |
| parent | a914e3164e5c9522b6ac9a39327ed46628d3e045 (diff) | |
| download | rsyslog-0754bda285f17e6fb750ce6dea1db788e9e0ccde.tar.gz rsyslog-0754bda285f17e6fb750ce6dea1db788e9e0ccde.tar.xz rsyslog-0754bda285f17e6fb750ce6dea1db788e9e0ccde.zip | |
documented at least a bit about the debug settings
| -rw-r--r-- | doc/debug.html | 39 | ||||
| -rw-r--r-- | doc/manual.html | 133 |
2 files changed, 134 insertions, 38 deletions
diff --git a/doc/debug.html b/doc/debug.html new file mode 100644 index 00000000..ad53d94f --- /dev/null +++ b/doc/debug.html @@ -0,0 +1,39 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head> +<meta http-equiv="Content-Language" content="en"><title>Debug Support</title> + +</head> +<body> +<h1>Debug Support</h1> +<p> +Rsyslog provides a number of debug aids. Some of them are activated by +adding the --enable-rtinst ./configure option ("rtinst" means runtime +instrumentation). Turning debugging on obviously costs some performance +(in some cases considerable). +</p> +<p>This is document is just being created and thus terse.</p> +<p style="font-weight: bold;">Signals supported</p> +<p>SIGUSR1 - turns debug messages on and off (expect this signal +to go away over time)</p> +<p>SIGUSR2 - outputs debug information (including active threads +and a call stack) for the state when SIGUSR2 was received. This is a +one-time output. Can be sent as often as the user likes.</p> +<p style="font-weight: bold;">Environment Variables</p> +<p>Environment variables set several debug settings. This is +intended to become the primary way to configure debugging support. +Currently are defined:</p> +<ul> +<li>RSYSLOG_DEBUGLOG="/path/to/debuglog/" - writes (allmost) +all debug message to the specified log file in addition to stdout. Some +system messages (e.g. segfault or abort message) are not written to the +file as we can not capture them.</li> +</ul> +<p>[<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p> +<p><font size="2">This documentation is part of the +<a href="http://www.rsyslog.com/">rsyslog</a> +project.<br> +Copyright © 2008 by <a href="http://www.gerhards.net/rainer">Rainer +Gerhards</a> and +<a href="http://www.adiscon.com/">Adiscon</a>. +Released under the GNU GPL version 3 or higher.</font></p> +</body></html>
\ No newline at end of file diff --git a/doc/manual.html b/doc/manual.html index 9b99c9b5..f73ae83a 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -1,52 +1,109 @@ -<html> -<head> -<title>rsyslog documentation</title> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><title>rsyslog documentation</title> + </head> <body> <h1>RSyslog - Documentation</h1> -<p><b><a href="http://www.rsyslog.com/">Rsyslog</a> is an enhanced syslogd -supporting, among others, <a href="rsyslog_mysql.html">MySQL</a>, PostgreSQL, <a href="http://wiki.rsyslog.com/index.php/FailoverSyslogServer">failover log destinations</a>, syslog/tcp, -fine grain output format control, and the ability to filter on any message part.</b> -It is quite compatible to stock -sysklogd and can be used as a drop-in replacement. Its <a href="features.html"> -advanced features</a> make it suitable for enterprise-class, -<a href="rsyslog_stunnel.html">encryption protected syslog</a> -relay chains while at the same time being very easy to setup -for the novice user.</p> -<p><b>Visit the <i> <a href="status.html">rsyslog status page</a></i></b> to obtain current -version information and ports. <b>If you like rsyslog, you might want to lend us -a helping hand. </b>It doesn't require a lot of time - even a single mouse click -helps. Learn <a href="how2help.html">how to help the rsyslog project</a>. Due to popular demand, there is now a <a href="rsyslog_ng_comparison.html">side-by-side comparison between rsyslog and syslog-ng</a>.</p> <p><b><font color="#FF0000">Warning: rsyslog v3 is under active development and as of this writing has a number of backwards compatibility issues. </font>If you have never run it, <font color="#FF0000"><a href="v3compatibility.html">be sure to read the -rsyslog v3 compatibility document!</a></font> This also applies if you upgrade from stock sysklogd - you need to make some configuration file changes. </b><br> Documentation for 3.x is currently sparse. If you need assistance, please <a href="http://www.rsyslog.com/PNphpBB2.phtml">post in the rsyslog forums</a>!<br> <b><font color="#FF0000">If you do not like this, use a <a href="http://www.rsyslog.com/Downloads-req-viewsdownload-sid-1.phtml">stable branch release</a>!</font></b></p> +<p><b><a href="http://www.rsyslog.com/">Rsyslog</a> +is an enhanced syslogd +supporting, among others, <a href="rsyslog_mysql.html">MySQL</a>, +PostgreSQL, <a href="http://wiki.rsyslog.com/index.php/FailoverSyslogServer">failover +log destinations</a>, syslog/tcp, fine grain output format +control, and the ability to filter on any message part.</b> +It is quite compatible to stock sysklogd and can be used as a drop-in +replacement. Its <a href="features.html"> +advanced features</a> make it suitable for enterprise-class, <a href="rsyslog_stunnel.html">encryption protected syslog</a> +relay chains while at the same time being very easy to setup for the +novice user.</p> +<p><b>Visit the <i> <a href="status.html">rsyslog +status page</a></i></b> to obtain current +version information and ports. <b>If you like rsyslog, you might +want to lend us a helping hand. </b>It doesn't require a lot of +time - even a single mouse click helps. Learn <a href="how2help.html">how to help the rsyslog project</a>. +Due to popular demand, there is now a <a href="rsyslog_ng_comparison.html">side-by-side comparison +between rsyslog and syslog-ng</a>.</p> +<p><b><font color="#ff0000">Warning: rsyslog +v3 is under active development and as of this writing has a number of +backwards compatibility issues. </font>If you currently use v2, +<font color="#ff0000"><a href="v3compatibility.html">be +sure to read the rsyslog v3 compatibility document!</a></font> +This also applies if you upgrade from stock sysklogd - you need to make +some configuration file changes. </b><br> +Documentation for 3.x is currently sparse. If you need assistance, +please <a href="http://www.rsyslog.com/PNphpBB2.phtml">post +in the rsyslog forums</a>!<br> +<b><font color="#ff0000">If you do not like this, +use a <a href="http://www.rsyslog.com/Downloads-req-viewsdownload-sid-1.phtml">stable +branch release</a>!</font></b></p> <p><b>Follow the links below for the</b></p> <ul> <li><a href="man_rsyslogd.html">rsyslogd man page</a> -(somewhat outdated)<li><a href="rsyslog_conf.html">configuration file syntax (rsyslog.conf)</a><li> <a href="property_replacer.html">property replacer, an important core component</a><li>a commented <a href="sample.conf.html">sample rsyslog.conf</a> -<li><a href="bugs.html">rsyslog bug list</a><li><a href="rsyslog_packages.html"> rsyslog packages</a><li><a href="generic_design.html">backgrounder on generic syslog application design</a><!-- not good as it currently is ;) <li><a href="contributors.html">contributor "Hall of Fame"</a>--><li><a href="modules.html">description of rsyslog modules</a></ul> +(somewhat outdated)</li> +<li><a href="rsyslog_conf.html">configuration file +syntax (rsyslog.conf)</a></li> +<li> <a href="property_replacer.html">property +replacer, an important core component</a></li> +<li>a commented <a href="sample.conf.html">sample +rsyslog.conf</a> +</li> +<li><a href="bugs.html">rsyslog bug list</a></li> +<li><a href="rsyslog_packages.html"> rsyslog +packages</a></li> +<li><a href="generic_design.html">backgrounder on +generic syslog application design</a><!-- not good as it currently is ;) <li><a href="contributors.html">contributor "Hall of Fame"</a>--></li> +<li><a href="modules.html">description of rsyslog +modules</a></li> +</ul> <p><b>We have some in-depth papers on</b></p> <ul> - <li><a href="install.html">installing rsyslog</a></li> <li><a href="ipv6.html">rsyslog and IPv6</a> (which is fully supported)</li> - <li><a href="rsyslog_stunnel.html">ssl-encrypting syslog with stunnel</a></li> - <li><a href="rsyslog_mysql.html">writing syslog messages to MySQL</a></li> <li><a href="rsyslog_high_database_rate.html">writing massive amounts of syslog messages to a database</a></li> - <li><a href="rsyslog_php_syslog_ng.html">using php-syslog-ng with rsyslog</a></li> <li><a href="rsyslog_recording_pri.html">recording the syslog priority (severity and facility) to the log file</a></li> <li><a href="http://www.rsyslog.com/Article19.phtml">preserving syslog sender over NAT</a> (online only)</li> <li><a href="dev_queue.html">the rsyslog message queue object</a></li> +<li><a href="install.html">installing rsyslog</a></li> +<li><a href="ipv6.html">rsyslog and IPv6</a> +(which is fully supported)</li> +<li><a href="rsyslog_stunnel.html">ssl-encrypting +syslog with stunnel</a></li> +<li><a href="rsyslog_mysql.html">writing syslog +messages to MySQL</a></li> +<li><a href="rsyslog_high_database_rate.html">writing +massive amounts of syslog messages to a database</a></li> +<li><a href="rsyslog_php_syslog_ng.html">using +php-syslog-ng with rsyslog</a></li> +<li><a href="rsyslog_recording_pri.html">recording +the syslog priority (severity and facility) to the log file</a></li> +<li><a href="http://www.rsyslog.com/Article19.phtml">preserving +syslog sender over NAT</a> (online only)</li> +<li><a href="debug.html">debug support in rsyslog</a></li> +<li><a href="dev_queue.html">the rsyslog message +queue object</a></li> </ul> -<p>Our <a href="history.html">rsyslog history</a> page is for you if you would like to learn a little more -on why there is an rsyslog at all. If you are interested why you should care about rsyslog at all, you may want to read Rainer's essay on "<a href="http://rgerhards.blogspot.com/2007/08/why-does-world-need-another-syslogd.html">why the world needs another syslogd</a>".</p> -<p>Documentation is added continuously. Please note that the documentation here -matches only the current version of rsyslog. If you use an older version, be sure +<p>Our <a href="history.html">rsyslog history</a> +page is for you if you would like to learn a little more +on why there is an rsyslog at all. If you are interested why you should +care about rsyslog at all, you may want to read Rainer's essay on "<a href="http://rgerhards.blogspot.com/2007/08/why-does-world-need-another-syslogd.html">why +the world needs another syslogd</a>".</p> +<p>Documentation is added continuously. Please note that the +documentation here +matches only the current version of rsyslog. If you use an older +version, be sure to use the doc that came with it.</p> <p><b>You can also browse the following online resources:</b></p> <ul> -<li>the <a href="http://wiki.rsyslog.com/">rsyslog wiki</a>, a community resource</li> -<li><a href="http://www.rsyslog.com/module-Static_Docs-view-f-manual.html.phtml">rsyslog online documentation</a></li> -<li><a href="http://www.rsyslog.com/Topic3.phtml">rsyslog FAQ</a></li> -<li><a href="http://www.rsyslog.com/PNphpBB2.phtml">rsyslog discussion forum</a></li> -<li><a href="http://www.rsyslog.com/Topic4.phtml">rsyslog change log</a></li> -<li><a href="http://www.monitorware.com/en/syslog-enabled-products/">syslog device configuration guide</a> (off-site)</li> +<li>the <a href="http://wiki.rsyslog.com/">rsyslog +wiki</a>, a community resource</li> +<li><a href="http://www.rsyslog.com/module-Static_Docs-view-f-manual.html.phtml">rsyslog +online documentation</a></li> +<li><a href="http://www.rsyslog.com/Topic3.phtml">rsyslog +FAQ</a></li> +<li><a href="http://www.rsyslog.com/PNphpBB2.phtml">rsyslog +discussion forum</a></li> +<li><a href="http://www.rsyslog.com/Topic4.phtml">rsyslog +change log</a></li> +<li><a href="http://www.monitorware.com/en/syslog-enabled-products/">syslog +device configuration guide</a> (off-site)</li> </ul> -<p>And don't forget about the <a href="http://lists.adiscon.net/mailman/listinfo/rsyslog">rsyslog mailing list</a>. -If you are interested in the "backstage", you may find +<p>And don't forget about the <a href="http://lists.adiscon.net/mailman/listinfo/rsyslog">rsyslog +mailing list</a>. If you are interested in the "backstage", you +may find <a href="http://www.gerhards.net/rainer">Rainer</a>'s -<a href="http://rgerhards.blogspot.com/">blog</a> an interesting read (filter on syslog and rsyslog tags).</p> -</body> -</html> +<a href="http://rgerhards.blogspot.com/">blog</a> an +interesting read (filter on syslog and rsyslog tags).</p> +</body></html>
\ No newline at end of file |