From b4dbe03cfa862543a78a7abe18524f6e0c94b364 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Tue, 1 Apr 2008 17:05:13 +0000 Subject: added forgotten files --- doc/imrelp.html | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/omrelp.html | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 106 insertions(+) create mode 100644 doc/imrelp.html create mode 100644 doc/omrelp.html diff --git a/doc/imrelp.html b/doc/imrelp.html new file mode 100644 index 00000000..b6f1f2bc --- /dev/null +++ b/doc/imrelp.html @@ -0,0 +1,52 @@ + + +RELP Input Module + + + +

RELP Input Module

Module Name: imrelp

Author: Rainer Gerhards

Description:

Provides the ability to receive syslog messages via the +reliable RELP protocol. This module requires librelp to be +present on the system. From the user's point of view, imrelp works much +like imtcp or imgssapi, except that no message loss can occur. Please +note that with the currently supported relp protocol version, a minor +message duplication may occur if a network connection between the relp +client and relp server breaks after the client could successfully send +some messages but the server could not acknowledge them. The window of +opportunity is very slim, but in theory this is possible. Future +versions of RELP will prevent this. Please also note that rsyslogd may +lose a few messages if rsyslog is shutdown while a network conneciton +to the server is broken and could not yet be recovered. Future version +of RELP support in rsyslog will prevent that. Please note that both +scenarios also exists with plain tcp syslog. RELP, even with the small +nits outlined above, is a much more reliable solution than plain tcp +syslog and so it is highly suggested to use RELP instead of plain tcp. +Clients send messages to the RELP server via omrelp.

Configuration Directives:

InputRELPServerRun <port>
+Starts a RELP server on selected port

+Caveats/Known Bugs: +

see description

Sample:

This sets up a RELP server on port 2514.
+

+ +

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

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

+ \ No newline at end of file diff --git a/doc/omrelp.html b/doc/omrelp.html new file mode 100644 index 00000000..0952cc71 --- /dev/null +++ b/doc/omrelp.html @@ -0,0 +1,54 @@ + + +RELP Output Module (omrelp) + + + +

RELP Output Module (omlibdbi)

Module Name: omrelp

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

Description:

This module supports sending syslog messages over the reliable +RELP protocol. For RELP's advantages over plain tcp syslog, please see +the documentation for imrelp +(the server counterpart).

+Setup +

Please note the librelp +is required for imrelp (it provides the core relp protocol +implementation).

Configuration Directives:

This module uses old-style action configuration to keep +consistent with the forwarding rule. So far, no additional +configuration directives can be specified. To send a message via RELP, +use

*.* + :omrelp:<sever>:<port>;<template>

just as you use

*.* + @@<sever>:<port>;<template>

to forward a message via plain tcp syslog.

+Caveats/Known Bugs: +

See imrelp, +which documents them.

Sample:

The following sample sends all messages to the central server +"centralserv" at port 2514 (note that that server must run imrelp on +port 2514). Rsyslog's high-precision timestamp format is used, thus the +special "RSYSLOG_ForwardFormat" (case sensitive!) template is used.
+

+ +

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

+ \ No newline at end of file -- cgit