← Back to branch summary

~arges/ubuntu/quantal/rsyslog/fix-lp1059592

« back to all changes in this revision

Viewing changes to doc/impstats.html

Tags: 5.7.3-1
* New upstream release.
* Upload to unstable.
* debian/patches/02-typo_fix_equation_sign.patch
  - Removed, merged upstream.
* debian/patches/03-atomic_operations.patch
  - Removed, merged upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/impstats.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head>
 
3
<title>Periodic Statistics of Internal Counters (impstats)</title>
 
4
</head>
 
5
<body>
 
6
<a href="rsyslog_conf_modules.html">back</a>
 
7
 
 
8
<h1>Input Module to Generate Periodic Statistics of Internal Counters</h1>
 
9
<p><b>Module Name:&nbsp;&nbsp;&nbsp; impstats</b></p>
 
10
<p><b>Available since: </b>5.7.0+, 6.1.1+
 
11
<p><b>Author: </b>Rainer Gerhards &lt;rgerhards@adiscon.com&gt;</p>
 
12
<p><b>Description</b>:</p>
 
13
<p>This module provides periodic output of rsyslog internal counters.
 
14
Note that the whole statistics system is currently under development. So
 
15
availabilty and format of counters may change and is not yet stable (so be
 
16
prepared to change your trending scripts when you upgrade to a newer rsyslog version).
 
17
<p>The set of available counters will be output as a set of syslog messages. This
 
18
output is periodic, with the interval being configurable (default is 5 minutes).
 
19
Be sure that your configuration records the counter messages (default is syslog.info).
 
20
<p>Note that loading this module has impact on rsyslog performance. Depending on
 
21
settings, this impact may be severe (for high-load environments).
 
22
</p>
 
23
<p><b>Configuration Directives</b>:</p>
 
24
<ul>
 
25
<li>$PStatsInterval &lt;Seconds&gt;<br>
 
26
Sets the interval, in <b>seconds</b> at which messages are generated. Please note that the
 
27
actual interval may be a bit longer. We do not try to be precise and so the interval is
 
28
actually a sleep period which is entered after generating all messages. So the actual 
 
29
interval is what is configured here plus the actual time required to generate messages.
 
30
In general, the difference should not really matter.
 
31
<li>$PStatsFacility &lt;numerical facility&gt;<br>
 
32
The numerical syslog facility code to be used for generated messages. Default
 
33
is 5 (syslog).This is useful for filtering messages.</li>
 
34
<li>$PStatsSeverity &lt;numerical severity&gt;<br>
 
35
The numerical syslog severity code to be used for generated messages. Default
 
36
is 6 (info).This is useful for filtering messages.</li>
 
37
</ul>
 
38
<b>Caveats/Known Bugs:</b>
 
39
<ul>
 
40
<li>This module MUST be loaded right at the top of rsyslog.conf, otherwise 
 
41
stats may not get turned on in all places.</li>
 
42
<li>experimental code</li>
 
43
</ul>
 
44
<p><b>Sample:</b></p>
 
45
<p>This activates the module and records messages to /var/log/rsyslog-stats in 10 minute intervals:<br>
 
46
</p>
 
47
<textarea rows="8" cols="60">$ModLoad impstats
 
48
$PStatsInterval 600
 
49
$PStatsSeverity 7
 
50
 
 
51
syslog.debug  /var/log/rsyslog-stats
 
52
</textarea>
 
53
<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>]
 
54
[<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
 
55
<p><font size="2">This documentation is part of the
 
56
<a href="http://www.rsyslog.com/">rsyslog</a>
 
57
project.<br>
 
58
Copyright &copy; 2010 by <a href="http://www.gerhards.net/rainer">Rainer
 
59
Gerhards</a> and
 
60
<a href="http://www.adiscon.com/">Adiscon</a>.
 
61
Released under the GNU GPL version 3 or higher.</font></p>
 
62
</body></html>