From 3ef61a981752e0b74168f683ce2633ab0610e1ac Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Fri, 27 Sep 2013 15:40:19 +0200 Subject: doc: better document & hyperlink action queue parameters --- doc/queue_parameters.html | 7 +++++++ doc/rsyslog_conf_actions.html | 26 +++++++++++++++++++++++--- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/doc/queue_parameters.html b/doc/queue_parameters.html index 83eae5d3..f2af7598 100644 --- a/doc/queue_parameters.html +++ b/doc/queue_parameters.html @@ -4,6 +4,13 @@ back

General Queue Parameters

Queue parameters can be used together with the following statements: +

action() +
ruleset() +
main_queue() +

Queues need to be configured in the action or ruleset it should affect. If nothing is configured, default values will be used. Thus, the default ruleset has only the default main queue. Specific Action queues are not set up by default.

diff --git a/doc/rsyslog_conf_actions.html b/doc/rsyslog_conf_actions.html index fa240d97..5d7a5bdb 100644 --- a/doc/rsyslog_conf_actions.html +++ b/doc/rsyslog_conf_actions.html @@ -3,9 +3,14 @@

This is a part of the rsyslog.conf documentation.

back +

Note: this documentation describes features present in v7+ of +rsyslog. If you use an older version, scroll down to "legacy parameters". +If you prefer, you can also +obtain +a specific version of the rsyslog documentation.

Actions

Action object describe what is to be done with a message. They are -implemented via outpout modules. +implemented via output modules.

The action object has different parameters:

those that apply to all actions and are action specific. These @@ -13,8 +18,11 @@ implemented via outpout modules.
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 + queue parameters.
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 + output module in question.

General Action Parameters

@@ -47,7 +55,19 @@ When an action is suspended (e.g. destination can not be connected), the action -

Legacy Format

Useful Links

Rainer's blog posting on the performance of + main + and action queue worker threads +

+ +
+
+
+ + +

Legacy Format

Be warned that legacy action format is hard to get right. It is recommended to use RainerScript-Style action format whenever possible! A key problem with legacy format is that a single action is defined via -- cgit v1.2.3