diff options
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/omruleset.html | 14 | ||||
| -rw-r--r-- | doc/rainerscript_call.html | 51 | ||||
| -rw-r--r-- | doc/rsyslog_conf_basic_structure.html | 2 |
4 files changed, 67 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index e1757644..b37fd642 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -153,6 +153,7 @@ html_files = \ rsyslog_conf_basic_structure.html \ rsyslog_conf_sysklogd_compatibility.html \ imkmsg.html \ + rainerscript_call.html \ src/classes.dia grfx_files = \ diff --git a/doc/omruleset.html b/doc/omruleset.html index 41d6ccfc..d0154095 100644 --- a/doc/omruleset.html +++ b/doc/omruleset.html @@ -10,6 +10,20 @@ <p><b>Module Name: omruleset</b></p> <p><b>Author: </b>Rainer Gerhards <rgerhards@adiscon.com></p> <p><b>Available Since</b>: 5.3.4</p> +<p><b><font color="red">Deprecated in</font></b>: 7.2.0+</p> +<p><b>Deprecation note</b></p> +<p><font color="red">This module exists only for backwards-compatibility +reasons.</font> +<b>Do no longer use it in new configurations.</b> It has been +replaced by the much more efficient +<a href="rainerscript_call.html">"call" RainerScript statement</a>. The +"call" statement supports everything omruleset does, but in an easier +to use way. +<br> +<br> +<br> +<br> +<br> <p><b>Description</b>:</p> <p>This is a very special "output" module. It permits to pass a message object to another rule set. While this is a very simple action, it enables very diff --git a/doc/rainerscript_call.html b/doc/rainerscript_call.html new file mode 100644 index 00000000..faab5c24 --- /dev/null +++ b/doc/rainerscript_call.html @@ -0,0 +1,51 @@ +<html> +<head> +<title>rsyslog "call" statement</title> +</head> +<body> +<a href="rsyslog_conf_global.html">back</a> + +<h1>The rsyslog "call" statement</h1> +<p>The rsyslog "call" statement is used to tie rulesets together. +It is modelled after the usual programming langauge "call" statement. Think +of a ruleset as a subroutine (what it really is!) and you get the picture. + +<p>The "call" statement can be used to call into any type of rulesets. +If a rule set has a queue assigned, the message will be posted to that queue +and processed asynchronously. Otherwise, the ruleset will be executed +synchronously and control returns to right after the call when the rule set +has finished execution. + +<p>Note that there is an important difference between asynchronous and +synchronous execution in regard to the "stop" statement. It will not affect +processing of the original message when run asynchronously. + +<p>The "call" statement replaces the deprecated omruleset module. It offers +all capabilities omruleset has, but works in a much more efficient way. +Note that omruleset was a hack that made calling rulesets possible +within the constraints of the pre-v7 engine. "call" is the clean solution for +the new engine. Especially for rulesets without associated queues (synchronous +operation), it has zero overhead (really!). omruleset always needs to +duplicate messages, which usually means at least ~250 bytes of memory writes, +some allocs and frees - and even more performance-intense operations. + +<h2>syntax</h2> +<p><code>call rulesetname</code></p> +<p>Where "rulesetname" is the name of a ruleset that is defined elsewhere +inside the configration. If the call is synchronous or asynchronous depends +on the ruleset parameters. This cannot be overriden by the "call" statement. + +<h2>related links</h2> +<ul> +<li><a href="http://blog.gerhards.net/2012/10/how-to-use-rsyslogs-ruleset-and-call.html">Blog posting announcing "call" statement (with sample)</a> +</ul> + +<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>] [<a href="manual.html">manual +index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p> +<p><font size="2">This documentation is part of the +<a href="http://www.rsyslog.com/">rsyslog</a> project.<br> +Copyright © 2013 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and +<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL +version 2 or higher.</font></p> +</body> +</html> diff --git a/doc/rsyslog_conf_basic_structure.html b/doc/rsyslog_conf_basic_structure.html index f5d4891a..54fb721c 100644 --- a/doc/rsyslog_conf_basic_structure.html +++ b/doc/rsyslog_conf_basic_structure.html @@ -43,7 +43,7 @@ after the stop statement are never evaluated. <ul> <li><b>if expr then ... else ...</b> - conditional execution <li><b>stop</b> - stops processing the current message -<li><b>call</b> - calls a ruleset (just like a subroutine call) +<li><b><a href="rainerscript_call.html">call</a></b> - calls a ruleset (just like a subroutine call) <li><b>continue</b> - a NOP, useful e.g. inside the then part of an if </ul> |