From 7d0075f01451f046ca04623d09a328e52bc28d11 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Fri, 27 Sep 2013 09:57:40 +0200 Subject: document "call" RainerScript statement --- doc/Makefile.am | 1 + doc/omruleset.html | 14 ++++++++++ doc/rainerscript_call.html | 51 +++++++++++++++++++++++++++++++++++ doc/rsyslog_conf_basic_structure.html | 2 +- 4 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 doc/rainerscript_call.html 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 @@

Module Name: omruleset

Author: Rainer Gerhards <rgerhards@adiscon.com>

Available Since: 5.3.4

Deprecated in: 7.2.0+

Deprecation note

This module exists only for backwards-compatibility +reasons. +Do no longer use it in new configurations. It has been +replaced by the much more efficient +"call" RainerScript statement. The +"call" statement supports everything omruleset does, but in an easier +to use way. +
+
+
+
+

Description:

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 @@ + + +rsyslog "call" statement + + +back + +

The rsyslog "call" statement

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. + +

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. + +

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. + +

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. + +

syntax

call rulesetname

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. + +

The rsyslog "call" statement

syntax

related links