diff options
Diffstat (limited to 'doc/rsyslog_conf_actions.html')
| -rw-r--r-- | doc/rsyslog_conf_actions.html | 36 |
1 files changed, 31 insertions, 5 deletions
diff --git a/doc/rsyslog_conf_actions.html b/doc/rsyslog_conf_actions.html index 50b13a07..260d1f2b 100644 --- a/doc/rsyslog_conf_actions.html +++ b/doc/rsyslog_conf_actions.html @@ -3,9 +3,14 @@ <body> <p>This is a part of the rsyslog.conf documentation.</p> <a href="rsyslog_conf.html">back</a> +<p><b><i>Note: this documentation describes features present in v7+ of +rsyslog. If you use an older version, scroll down to "legacy parameters".</i></b> +If you prefer, you can also +<a href="http://www.rsyslog.com/how-to-obtain-a-specific-doc-version/">obtain +a specific version of the rsyslog documentation</a>. <h2>Actions</h2> Action object describe what is to be done with a message. They are -implemented via <a href="rsyslog_conf_modules.html#om">outpout modules</a>. +implemented via <a href="rsyslog_conf_modules.html#om">output modules</a>. <p>The action object has different parameters: <ul> <li>those that apply to all actions and are action specific. These @@ -13,8 +18,11 @@ implemented via <a href="rsyslog_conf_modules.html#om">outpout modules</a>. <li>parameters for the action queue. While they also apply to all parameters, they are queue-specific, not action-specific (they are the same that are used in rulesets, for example). + The are documented separately under + <a href="queue_parameters.html">queue parameters</a>. <li>action-specific parameters. These are specific to a certain - type of actions. They are documented by the output module + type of actions. They are documented by the + <a href="rsyslog_conf_modules.html#om">output module</a> in question. </ul> <h3>General Action Parameters</h3> @@ -23,8 +31,14 @@ implemented via <a href="rsyslog_conf_modules.html#om">outpout modules</a>. <br>used for statistics gathering and documentation <li><b>type</b> string <br>Mandatory parameter for every action. The name of the module that should be used. </li> - <li><b>action.writeAllMarkMessages</b> on/off - <br>Normally, mark messages are written to actions only if the action was not recently executed (by default, recently means within the past 20 minutes). If this setting is switched to "on", mark messages are always sent to actions, no matter how recently they have been executed. In this mode, mark messages can be used as a kind of heartbeat.</li> + <li><b>action.writeAllMarkMessages</b> <i>on</i>/off + <br>This setting tells if mark messages are always written ("on", the default) or only + if the action was not recently executed ("off"). By default, recently means within the + past 20 minutes. If this setting is "on", mark messages are always sent to actions, no + matter how recently they have been executed. In this mode, mark messages can be used as + a kind of heartbeat. This mode also enables faster processing inside the rule engine. So + it should be set to "off" only when there is a good reason to do so. + </li> <li><b>action.execOnlyEveryNthTime</b> integer <br>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.</li> <li><b>action.execOnlyEveryNthTimeout</b> integer @@ -56,7 +70,19 @@ When an action is suspended (e.g. destination can not be connected), the action </ul> -<h2>Legacy Format</h2> +<h2>Useful Links</h2> +<ul> +<li>Rainer's blog posting on the performance of + <a href="http://blog.gerhards.net/2013/06/rsyslog-performance-main-and-action.html">main + and action queue worker threads</a> +</ul> + +<br> +<br> +<br> + + +<h1>Legacy Format</h1> <p><b>Be warned that legacy action format is hard to get right. It is recommended to use RainerScript-Style action format whenever possible!</b> A key problem with legacy format is that a single action is defined via |