summaryrefslogtreecommitdiffstats
path: root/doc/omfwd.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/omfwd.html')
-rw-r--r--doc/omfwd.html30
1 files changed, 21 insertions, 9 deletions
diff --git a/doc/omfwd.html b/doc/omfwd.html
index 554c98ac..848ecdd3 100644
--- a/doc/omfwd.html
+++ b/doc/omfwd.html
@@ -20,14 +20,14 @@ If you prefer, you can also
a specific version of the rsyslog documentation</a>.
<p>&nbsp;</p>
-<p><b>Global Configuration Directives</b>:</p>
+<p><b>Module Parameters</b>:</p>
<ul>
<li><strong>Template </strong>[templateName]<br>
sets a non-standard default template for this module.<br></li>
</ul>
<p>&nbsp;</p>
-<p><b>Action specific Configuration Directives</b>:</p>
+<p><b>Action Parameters</b>:</p>
<ul>
<li><strong>Target </strong>string<br>
Name or IP-Address of the system that shall receive messages. Any resolvable name is fine. <br></li><br>
@@ -50,6 +50,19 @@ a specific version of the rsyslog documentation</a>.
compression mode, so pre 7.5.1 configuration will continue to work
as expected.
<br>The compression level is specified via the usual factor of 0 to 9, with 9 being the strongest compression (taking up most processing time) and 0 being no compression at all (taking up no extra processing time). <br></li><br>
+
+ <li><b>maxErrorMessages </b>integer [default 5], available since 7.5.4<br>
+ This sets the maximum number of error messages that omfwd
+ emits during regular operations. The reason for such an upper
+ limit is that error messages are conveyed back to rsyslog's
+ input message stream. So if there would be no limit, an endless
+ loop could be initiated if the failing action would need to
+ process its own error messages and the emit a new one. This is
+ also the reason why the default is very conservatively low.
+ Note that version prior to 7.5.4 did not report any error
+ messages for the same reason. Also note that with the initial
+ implementation only errors during UDP forwarding are logged.<br></li><br>
+
<li><b>compression.mode</b> <i>mode</i><br>
<i>mode</i> is one of "none", "single", or "stream:always". The
default is "none", in which no compression happens at all.
@@ -113,12 +126,11 @@ a specific version of the rsyslog documentation</a>.
<p><b>Caveats/Known Bugs:</b></p><ul><li>None.</li></ul>
<p><b>Sample:</b></p>
<p>The following command sends all syslog messages to a remote server via TCP port 10514.</p>
-<textarea rows="5" cols="60">Module (load="builtin:omfwd")
-*.* action(type="omfwd"
-Target="192.168.2.11"
-Port="10514"
-Protocol="tcp"
-)
+<textarea rows="5" cols="60">action(type="omfwd"
+ Target="192.168.2.11"
+ Port="10514"
+ Protocol="tcp"
+ )
</textarea>
<br><br>
@@ -165,7 +177,7 @@ Protocol="tcp"
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 © 2008 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+Copyright &copy; 2008-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 3 or higher.</font></p>