back to rsyslog module documentation

# RELP Output Module (omrelp)

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 that librelp is required for imrelp (it provides the core relp protocol implementation).

Action Configuration Parameters:

This module supports RainerScript configuration starting with rsyslog 7.3.10. For older versions, legacy configuration directives must be used.

- target (mandatory)
  The target server to connect to.
- template (not mandatory, default "RSYSLOG_ForwardFormat")
  Defines the template to be used for the output.
- timeout (not mandatory, default 90)
  Timeout for relp sessions. If set too low, valid sessions may be considered dead and tried to recover.

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).

module(load="omrelp") action(type="omrelp" target="centralserv" port="2514")

Legacy 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.

Legacy 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).

$ModLoad omrelp *.* :omrelp:centralserv:2514

Note: to use IPv6 addresses, encode them in [::1] format.

[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.