diff options
Diffstat (limited to 'doc/impstats.html')
| -rw-r--r-- | doc/impstats.html | 32 |
1 files changed, 24 insertions, 8 deletions
diff --git a/doc/impstats.html b/doc/impstats.html index 392fc431..3b206941 100644 --- a/doc/impstats.html +++ b/doc/impstats.html @@ -12,7 +12,7 @@ <p><b>Description</b>:</p> <p>This module provides periodic output of rsyslog internal counters. Note that the whole statistics system is currently under development. So -availabilty and format of counters may change and is not yet stable (so be +availability and format of counters may change and is not yet stable (so be prepared to change your trending scripts when you upgrade to a newer rsyslog version). <p>The set of available counters will be output as a set of syslog messages. This output is periodic, with the interval being configurable (default is 5 minutes). @@ -20,41 +20,55 @@ Be sure that your configuration records the counter messages (default is syslog. Besides logging to the regular syslog stream, the module can also be configured to write statistics data into a (local) file. <p>Note that loading this module has impact on rsyslog performance. Depending on -settings, this impact may be noticable (for high-load environments). +settings, this impact may be noticeable (for high-load environments). <p>The rsyslog website has an updated overview of available <a href="http://rsyslog.com/rsyslog-statistic-counter/">rsyslog statistic counters</a>. </p> <p><b>Module Confguration Parameters</b>:</p> <p>This module supports module parameters, only. <ul> - <li><strong>interval </strong>[seconds] (default 300 [5minutes])<br> + <li><b>interval </b>[seconds] (default 300 [5minutes])<br> Sets the interval, in <b>seconds</b> at which messages are generated. Please note that the actual interval may be a bit longer. We do not try to be precise and so the interval is actually a sleep period which is entered after generating all messages. So the actual interval is what is configured here plus the actual time required to generate messages. In general, the difference should not really matter. <br></li> - <li><strong>facility </strong>[templateName]<br> + <li><b>facility </b>[facility number]<br> The numerical syslog facility code to be used for generated messages. Default is 5 (syslog). This is useful for filtering messages. <br></li> - <li><strong>severity </strong>[templateName]<br> + <li><b>severity </b>[severity number]<br> The numerical syslog severity code to be used for generated messages. Default is 6 (info).This is useful for filtering messages. <br></li> - <li><strong>format </strong>[json/cee/<b>legacy</b>](rsyslog v6.3.8+ only)<br> + <li><b>resetCounters </b>[<b>off</b>/on] - available since 7.5.3<br> + When set to "on", counters are automatically reset after they are emitted. In that + case, the contain only deltas to the last value emitted. When set + to "off", counters always accumulate their values. + Note that in auto-reset mode not all counters can be reset. Some counters (like queue size) + are directly obtained from internal object and cannot be modified. Also, auto-resetting + introduces some additional slight inaccuracies due to the multi-threaded nature of + rsyslog and the fact that for performance reasons it cannot serialize access + to counter variables.</br> + As an alternative to auto-reset mode, you can use rsyslog's statistics + manipulation scripts to create delta values from the regular statistic + logs. This is the suggested method if deltas are not necessarily needed in + real-time. + <br></li> + <li><b>format </b>[json/cee/<b>legacy</b>] - available since 6.3.8<br> Specifies the format of emitted stats messages. The default of "legacy" is compatible with pre v6-rsyslog. The other options provide support for structured formats (note the "cee" is actually "project lumberack" logging). <br></li> - <li><strong>log.syslog </strong>[<b>on</b>/off] - available since 7.3.6<br> + <li><b>log.syslog </b>[<b>on</b>/off] - available since 7.3.6<br> This is a boolean setting specifying if data should be sent to the usual syslog stream. This is useful if custom formatting or more elaborate processing is desired. However, output is placed under the same restrictions as regular syslog data, especially in regard to the queue position (stats data may sit for an extended period of time in queues if they are full).<br></li> - <li><strong>log.file </strong>[file name] - available since 7.3.6<br> + <li><b>log.file </b>[file name] - available since 7.3.6<br> If specified, statistics data is written the specified file. For robustness, this should be a local file. The file format cannot be customized, it consists of a date header, followed by a colon, @@ -66,6 +80,8 @@ settings, this impact may be noticable (for high-load environments). on file logging does NOT turn of syslog logging. If that is desired log.syslog="off" must be explicitely set. <br></li> + <li><b>Ruleset</b> [ruleset] - available since 7.5.6<br> + Binds the listener to a specific <a href="multi_ruleset.html">ruleset</a>.</li> </ul> <p><b>Legacx Configuration Directives</b>:</p> |