summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2008-08-14 12:58:48 +0200
committerRainer Gerhards <rgerhards@adiscon.com>2008-08-14 12:58:48 +0200
commit8aa2b21f7fc97e09c02f40815be6e4635ec080ba (patch)
tree7fe99c8ae53e1dc78eb9789e3e994b7dd492fd99
parent14dddb70e94bf5c23935242a4f2872702626ff5d (diff)
downloadrsyslog-8aa2b21f7fc97e09c02f40815be6e4635ec080ba.tar.gz
rsyslog-8aa2b21f7fc97e09c02f40815be6e4635ec080ba.tar.xz
rsyslog-8aa2b21f7fc97e09c02f40815be6e4635ec080ba.zip
enhanced doc for $ActionExecOnlyEveryNthTimeTimeout
-rw-r--r--ChangeLog1
-rw-r--r--doc/rsyslog_conf.html22
2 files changed, 20 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index 797ffa72..b26ae3a9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,6 @@
---------------------------------------------------------------------------
Version 3.21.4 [DEVEL] (rgerhards), 2008-0????
+- enhanced doc for $ActionExecOnlyEveryNthTimeTimeout
---------------------------------------------------------------------------
Version 3.21.3 [DEVEL] (rgerhards), 2008-08-13
- added ability to specify flow control mode for imuxsock
diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html
index aab30f5e..69e16ac6 100644
--- a/doc/rsyslog_conf.html
+++ b/doc/rsyslog_conf.html
@@ -79,15 +79,31 @@ default, it is usually well-chosen and applicable in most cases.</p>
execute action only if the last execute is at last
&lt;seconds&gt; seconds in the past (more info in <a href="ommail.html">ommail</a>,
but may be used with any action)</li>
-<li>$ActionExecOnlyEveryNthTime &lt;number&gt; - If configured, the next action will
+<li><i><b>$ActionExecOnlyEveryNthTime</b> &lt;number&gt;</i> - If configured, the next action will
only be executed every n-th time. For example, if configured to 3, the first two messages
that go into the action will be dropped, the 3rd will actually cause the action to execute,
the 4th and 5th will be dropped, the 6th executed under the action, ... and so on. Note:
this setting is automatically re-set when the actual action is defined.</li>
-<li>$ActionExecOnlyEveryNthTimeTimeout &lt;number-of-seconds&gt; - has a meaning only if
+<li><i><b>$ActionExecOnlyEveryNthTimeTimeout</b> &lt;number-of-seconds&gt;</i> - has a meaning only if
$ActionExecOnlyEveryNthTime is also configured for the same action. If so, the timeout
setting specifies after which period the counting of "previous actions" expires and
-a new action count is begun. Specify 0 (the default) to disable timeouts.:w
+a new action count is begun. Specify 0 (the default) to disable timeouts.
+<br>
+<i>Why is this option needed?</i> Consider this case: a message comes in at, eg., 10am. That's
+count 1. Then, nothing happens for the next 10 hours. At 8pm, the next
+one occurs. That's count 2. Another 5 hours later, the next message
+occurs, bringing the total count to 3. Thus, this message now triggers
+the rule.
+<br>
+The question is if this is desired behavior? Or should the rule only be
+triggered if the messages occur within an e.g. 20 minute window? If the
+later is the case, you need a
+<br>
+$ActionExecOnlyEveryNthTimeTimeout 1200
+<br>
+This directive will timeout previous messages seen if they are older
+than 20 minutes. In the example above, the count would now be always 1
+and consequently no rule would ever be triggered.
<li>$ActionFileDefaultTemplate [templateName] - sets a new default template for file actions</li>
<li>$ActionFileEnableSync [on/<span style="font-weight: bold;">off</span>] - enables file