diff options
| author | Florian Riedl <friedel@adiscon.com> | 2012-09-28 08:24:13 +0200 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2012-09-28 08:24:13 +0200 |
| commit | cf0fd87e17db12dd28edd260d02d0e5aa96deb71 (patch) | |
| tree | 8c3fc0a484dff1196f9f22ef6cacdaa9c4ee06ab /doc/imudp.html | |
| parent | 43da91636a5d8f60c21f1795d25fb0755e356d9f (diff) | |
| download | rsyslog-cf0fd87e17db12dd28edd260d02d0e5aa96deb71.tar.gz rsyslog-cf0fd87e17db12dd28edd260d02d0e5aa96deb71.tar.xz rsyslog-cf0fd87e17db12dd28edd260d02d0e5aa96deb71.zip | |
doc: update module doc to new config format
Diffstat (limited to 'doc/imudp.html')
| -rw-r--r-- | doc/imudp.html | 55 |
1 files changed, 44 insertions, 11 deletions
diff --git a/doc/imudp.html b/doc/imudp.html index ea985b60..3512d474 100644 --- a/doc/imudp.html +++ b/doc/imudp.html @@ -15,16 +15,13 @@ <p><b>Description</b>:</p> <p>Provides the ability to receive syslog messages via UDP. <p>Multiple receivers may be configured by specifying -$UDPServerRun multiple times. +multiple input actions. </p> + <p><b>Configuration Directives</b>:</p> +<p><b>Global Directives</b>:</p> <ul> -<li>$UDPServerAddress <IP><br> -local IP address (or name) the UDP listens should bind to</li> -<li>$UDPServerRun <port><br> -former -r<port> option, default 514, start UDP server on this -port, "*" means all addresses</li> -<li>$UDPServerTimeRequery <nbr-of-times><br> +<li><b>TimeRequery</b> <nbr-of-times><br> 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 @@ -33,15 +30,51 @@ time calls should usually be acceptable. The default value is two, because we ha 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. -<li>$InputUDPServerBindRuleset <ruleset><br> -Binds the listener to a specific <a href="multi_ruleset.html">ruleset</a>.</li> -<li>$IMUDPSchedulingPolicy <rr/fifo/other><br> +<li><b>SchedulingPolicy</b> <rr/fifo/other><br> Can be used the set the scheduler priority, if the necessary functionality is provided by the platform. Most useful to select "fifo" for real-time processing under Linux (and thus reduce chance of packet loss). Available since 4.7.4+, 5.7.3+, 6.1.3+. -<li>$IMUDPSchedulingPriority <number><br> +<li><b>SchedulingPriority</b> <number><br> Scheduling priority to use. Available since 4.7.4+, 5.7.3+, 6.1.3+. </ul> +<p><b>Action Directives</b>:</p> +<ul> +<li><b>Address</b> <IP><br> +local IP address (or name) the UDP listens should bind to</li> +<li><b>Port</b> <port><br> +default 514, start UDP server on this port</li> +<li><b>Ruleset</b> <ruleset><br> +Binds the listener to a specific <a href="multi_ruleset.html">ruleset</a>.</li> +</ul> +<b>Caveats/Known Bugs:</b> +<ul> +<li>currently none known</li> +</ul> +<p><b>Sample:</b></p> +<p>This sets up an UPD server on port 514:<br> +</p> +<textarea rows="15" cols="60">module(load="/folder/to/rsyslog/plugins/imudp/.libs/imudp") # needs to be done just once +input(type="imudp" port="514") +</textarea> + +<p><b>Legacy Configuration Directives</b>:</p> +<p>Multiple receivers may be configured by specifying +$UDPServerRun multiple times. +</p> +<ul> +<li>$UDPServerAddress <IP><br> +equivalent to: Address </li> +<li>$UDPServerRun <port><br> +equivalent to: Port </li> +<li>$UDPServerTimeRequery <nbr-of-times><br> +equivalent to: TimeRequery +<li>$InputUDPServerBindRuleset <ruleset><br> +equivalent to: Ruleset </li> +<li>$IMUDPSchedulingPolicy <rr/fifo/other><br> +equivalent to: SchedulingPolicy +<li>$IMUDPSchedulingPriority <number><br> +equivalent to: SchedulingPriority +</ul> <b>Caveats/Known Bugs:</b> <ul> <li>currently none known</li> |