summaryrefslogtreecommitdiffstats
path: root/doc/impstats.html
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2013-09-09 15:41:07 +0200
committerRainer Gerhards <rgerhards@adiscon.com>2013-09-09 15:41:07 +0200
commit490b083326f9254e86853f77f6fd71a2d3928513 (patch)
tree412f12f1e2108de49166e29024b4b123c412c850 /doc/impstats.html
parent452821e4fa2e60ae7fc5bf0a94e394e81289569e (diff)
downloadrsyslog-490b083326f9254e86853f77f6fd71a2d3928513.tar.gz
rsyslog-490b083326f9254e86853f77f6fd71a2d3928513.tar.bz2
rsyslog-490b083326f9254e86853f77f6fd71a2d3928513.zip
impstats: implement parameter "resetCounters"
it provides the capability to make impstats emit deltas in contrast to accumulated counter values (see doc for details).
Diffstat (limited to 'doc/impstats.html')
-rw-r--r--doc/impstats.html18
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/impstats.html b/doc/impstats.html
index 1da09ced..45208ef1 100644
--- a/doc/impstats.html
+++ b/doc/impstats.html
@@ -34,14 +34,28 @@ settings, this impact may be noticeable (for high-load environments).
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><strong>facility </strong>[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><strong>severity </strong>[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>resetCounters </strong>[<b>off</b>/on]<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><strong>format </strong>[json/cee/<b>legacy</b>](rsyslog v6.3.8+ only)<br>
Specifies the format of emitted stats messages. The default of "legacy" is
compatible with pre v6-rsyslog. The other options provide support for