mirror of
https://github.com/rsyslog/rsyslog.git
synced 2025-12-19 06:50:43 +01:00
41 lines
3.3 KiB
HTML
41 lines
3.3 KiB
HTML
<!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>There are two environment variables that set several debug settings. The "RSYSLOG_DEBUGLOG" (sample: 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. Runtime debug support is controlled by
|
||
"RSYSLOG_DEBUG". It contains an option string with the following
|
||
options possible (all are case insensitive):</p><ul><li><span style="font-weight: bold;">LogFuncFlow</span> - print out the logical flow of functions (entering and exiting them)</li><li><span style="font-weight: bold;">FileTrace</span> - specifies which files to trace LogFuncFlow. If <span style="font-weight: bold;">not</span>
|
||
set (the default), a LogFuncFlow trace is provided for all files. Set
|
||
to limit it to the files specified. FileTrace may be specified multiple
|
||
times, one file each (e.g. export RSYSLOG_DEBUG="LogFuncFlow
|
||
FileTrace=vm.c FileTrace=expr.c"</li><li><span style="font-weight: bold;">PrintFuncDB</span> - print the content of the debug function database whenever debug information is printed (e.g. abort case)!</li><li><span style="font-weight: bold;">PrintAllDebugInfoOnExit</span> - print all debug information immediately before rsyslogd exits (<span style="font-weight: bold; font-style: italic;">currently not implemented!</span>)</li><li><span style="font-weight: bold;">PrintMutexAction</span> - print mutex action as it happens. Useful for finding deadlocks and such.</li><li><span style="font-weight: bold;">NoLogTimeStamp</span> - do not prefix log lines with a timestamp (default is to do that).</li><li><span style="font-weight: bold;">NoStdOut</span> - do not emit debug messages to stdout. If RSYSLOG_DEBUGLOG is not set, this means no messages will be displayed at all.</li><li><span style="font-weight: bold;">help</span> - display a very short list of commands - hopefully a life saver if you can't access the documentation...</li></ul>
|
||
<ul>
|
||
</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 <EFBFBD> 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> |