summaryrefslogtreecommitdiffstats
path: root/doc/debug.html
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2008-02-18 10:52:02 +0000
committerRainer Gerhards <rgerhards@adiscon.com>2008-02-18 10:52:02 +0000
commit0754bda285f17e6fb750ce6dea1db788e9e0ccde (patch)
treef2e854813607144d5a242b5a1216ef0562f683b1 /doc/debug.html
parenta914e3164e5c9522b6ac9a39327ed46628d3e045 (diff)
downloadrsyslog-0754bda285f17e6fb750ce6dea1db788e9e0ccde.tar.gz
rsyslog-0754bda285f17e6fb750ce6dea1db788e9e0ccde.tar.xz
rsyslog-0754bda285f17e6fb750ce6dea1db788e9e0ccde.zip
documented at least a bit about the debug settings
Diffstat (limited to 'doc/debug.html')
-rw-r--r--doc/debug.html39
1 files changed, 39 insertions, 0 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&nbsp;© 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