From f7575cb9a81ed80848e21ea0cb31b6657f908f5d Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Tue, 13 Oct 2009 09:08:40 +0200 Subject: added multi-ruleset support to imudp also bumped version number and corrected ChangeLog, where I merged some post 5.3.1 changes into the 5.3.1 section. --- doc/imtcp.html | 47 +++++++++++++++++++---------------- doc/imudp.html | 58 +++++++++++++++++++++++++++++++++++++++++++ doc/manual.html | 2 +- doc/rsyslog_conf_global.html | 13 ---------- doc/rsyslog_conf_modules.html | 2 +- 5 files changed, 86 insertions(+), 36 deletions(-) create mode 100644 doc/imudp.html (limited to 'doc') diff --git a/doc/imtcp.html b/doc/imtcp.html index 0ccdecc7..0671d6d5 100644 --- a/doc/imtcp.html +++ b/doc/imtcp.html @@ -1,21 +1,23 @@ - -TCP Syslog Input Module + + + +TCP Syslog Input Module + + -back +back to rsyslog module overview

TCP Syslog Input Module

Module Name: imtcp

Author: Rainer Gerhards -<rgerhards@adiscon.com>

Author: Rainer Gerhards <rgerhards@adiscon.com>

Multi-Ruleset Support: since 4.5.0 and 5.1.1

Description:

Provides the ability to receive syslog messages via TCP. -Encryption can be provided by using stunnel -(an alternative is the use -the imgssapi -modul).

Multiple receivers may be configured by -specifying +Encryption is natively provided by selecting the approprioate network stream driver and +can also be provided by using stunnel +(an alternative is the use the imgssapi module).

Multiple receivers may be configured by specifying $InputTCPServerRun multiple times. This is available since version 4.3.1, earlier versions do NOT support it.

@@ -49,8 +51,7 @@ after loading imtcp, otherwise it may have no effect. Starts a TCP server on selected port

$InputTCPMaxListeners <number>
Sets the maximum number of listeners (server ports) supported. Default is 20. This must be set before the first $InputTCPServerRun directive.

$InputTCPMaxSessions <number>
-Sets the maximum number of sessions supported. Default is 200. This must be set before the first $InputTCPServerRun directive

$InputTCPMaxSessions <number>
Sets the maximum number of sessions supported. Default is 200. This must be set before the first $InputTCPServerRun directive

$InputTCPServerStreamDriverMode <number>
Sets the driver mode for the currently selected network stream driver. <number> is driver specifc.

$InputTCPServerInputName <name>
@@ -63,6 +64,8 @@ Sets the authentication mode for the currently selected network stream driver. PermittedPeers may not be set in anonymous modes.

$InputTCPServerBindRuleset <ruleset>
+Binds the listener to a specific ruleset.

Caveats/Known Bugs:

network stream driver

Sample:

This sets up a TCP server on port 514:
+

This sets up a TCP server on port 514 and permits it to accept up to 500 connections:

- +

Note that the parameters (here: max sessions) need to be set before the listener +is activated. Otherwise, the parameters will not apply. +

[rsyslog.conf overview] [manual index] [rsyslog site]

This documentation is part of the -rsyslog +

This documentation is part of the rsyslog project.
-Copyright © 2008 by Rainer -Gerhards and +Copyright © 2008,2009 by Rainer Gerhards and Adiscon. Released under the GNU GPL version 3 or higher.

- + + diff --git a/doc/imudp.html b/doc/imudp.html new file mode 100644 index 00000000..f0e86307 --- /dev/null +++ b/doc/imudp.html @@ -0,0 +1,58 @@ + + + + +TCP Syslog Input Module + + + +back to rsyslog module overview + +

UDP Syslog Input Module

Module Name: imudp

Author: Rainer Gerhards <rgerhards@adiscon.com>

Multi-Ruleset Support: since 5.3.2 +

Description:

Provides the ability to receive syslog messages via UDP. +

Multiple receivers may be configured by specifying +$UDPServerRun multiple times. +

Configuration Directives:

$UDPServerAddress <IP>
+local IP address (or name) the UDP listens should bind to
$UDPServerRun <port>
+former -r<port> option, default 514, start UDP server on this +port, "*" means all addresses
$UDPServerTimeRequery <nbr-of-times>
+this is a performance +optimization. Getting the system time is very costly. With this setting, imudp can +be instructed to obtain the precise time only once every n-times. This logic is +only activated if messages come in at a very fast rate, so doing less frequent +time calls should usually be acceptable. The default value is two, because we have +seen that even without optimization the kernel often returns twice the identical time. +You can set this value as high as you like, but do so at your own risk. The higher +the value, the less precise the timestamp. +
$InputUDPServerBindRuleset <ruleset>
+Binds the listener to a specific ruleset.

+Caveats/Known Bugs: +

currently none known

Sample:

This sets up an UPD server on port 514:
+

+ +

[rsyslog.conf overview] +[manual index] [rsyslog site]

+ diff --git a/doc/manual.html b/doc/manual.html index 6b96d94c..a6d64872 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -19,7 +19,7 @@ rsyslog support available directly from the source!

Please visit the rsyslog sponsor's page to honor the project sponsors or become one yourself! We are very grateful for any help towards the project goals.

This documentation is for version 5.3.1 (devel branch) of rsyslog. +

This documentation is for version 5.3.2 (devel branch) of rsyslog. Visit the rsyslog status page to obtain current version information and project status.

If you like rsyslog, you might diff --git a/doc/rsyslog_conf_global.html b/doc/rsyslog_conf_global.html index 874ad30e..885dbdc7 100644 --- a/doc/rsyslog_conf_global.html +++ b/doc/rsyslog_conf_global.html @@ -260,19 +260,6 @@ default may change as uniprocessor systems become less common. [available since to sysklogd), the domain part from a name that is within the same domain as the receiving system is stripped. If set to on, full names are always used.

$WorkDirectory <name> (directory for spool and other work files)

-
$UDPServerAddress <IP> (imudp) -- local IP -address (or name) the UDP listens should bind to
-
$UDPServerRun <port> (imudp) -- former --r<port> option, default 514, start UDP server on this -port, "*" means all addresses
-
$UDPServerTimeRequery <nbr-of-times> (imudp) -- this is a performance -optimization. Getting the system time is very costly. With this setting, imudp can -be instructed to obtain the precise time only once every n-times. This logic is -only activated if messages come in at a very fast rate, so doing less frequent -time calls should usually be acceptable. The default value is two, because we have -seen that even without optimization the kernel often returns twice the identical time. -You can set this value as high as you like, but do so at your own risk. The higher -the value, the less precise the timestamp.
$PrivDropToGroup

$PrivDropToGroupID

$PrivDropToUser
diff --git a/doc/rsyslog_conf_modules.html b/doc/rsyslog_conf_modules.html index f9bdad4a..d408fc60 100644 --- a/doc/rsyslog_conf_modules.html +++ b/doc/rsyslog_conf_modules.html @@ -25,7 +25,7 @@ permits rsyslog to alert folks by mail if something important happens - input module for text files
imrelp - RELP input module
-
imudp - udp syslog message input
+
imudp - udp syslog message input

imtcp - input plugin for plain tcp syslog

imgssapi - -- cgit