omrabbitmq: RabbitMQ output module

Purpose

This module sends syslog messages into RabbitMQ server. Only v6 configuration syntax is supported.

omrabbitmq is tested and is running in production with 8.x version of rsyslog.

Compile

To successfully compile omrabbitmq module you need rabbitmq-c library version >= 0.4.

./configure –enable-omrabbitmq …

Configuration Parameters

HA configuration

The module can use two rabbitmq server in a fail-over mode. To configure this mode, the host parameter has to reference the two rabbitmq servers separated by space. Each server can be optionally completed with the port (useful when they are different). One of the servers is chosen on startup as a preferred one. The module connects to this server with a fail-over policy which can be defined through the action parameter “recover_policy”.

The module launch a back-ground thread to monitor the connection. As soon as the connection fails, the thread retries to reestablish the connection and switch to the back-up server if needed to recover the service. While connected to backup server, the thread tries to reconnect to the preferred server using a “recover_policy”. This behaviour allow to load balance the client across the two rabbitmq servers on normal conditions, switch to the running server in case of failure and rebalanced on the two server as soon as the failed server is recovered without restarting clients.

The recover policy is based on 4 parameters :

• check_interval is the base duration between connection retries (default is 60 seconds)

• short_failure_interval is a duration under which two successive failures are considered as abnormal for the rabbitmq server (default is check_interval/10)

• short_failure_nb_max is the number of successive short failure are detected before to apply the graceful interval (default is 3)

• graceful_interval is a longer duration used if the rabbitmq server is unstable (default is check_interval*10).

The short failures detection is applied in case of unstable network or server and force to switch to back-up server for at least ‘graceful-interval’ avoiding heavy load on the unstable server. This can avoid dramatic scenarios in a multisites deployment.

Examples

module(load='omrabbitmq')
action(type="omrabbitmq"
       host="localhost"
       virtual_host="/"
       user="guest"
       password="guest"
       exchange="syslog"
       routing_key="syslog.all")

module(load='omrabbitmq')
template(name="rkTpl" type="string" string="%syslogtag%.%syslogfacility-text%.%syslogpriority-text%")

action(type="omrabbitmq"
       host="localhost"
       virtual_host="/"
       user="guest"
       password="guest"
       exchange="syslog"
       routing_key_template="rkTpl"
       template_body="")

module(load='omrabbitmq')
template(name="rkTpl" type="string" string="%syslogtag%.%syslogfacility-text%.%syslogpriority-text%")

action(type="omrabbitmq"
       host="server1 server2:1234"
       virtual_host="production"
       user="guest"
       password="guest"
       exchange="syslog"
       routing_key_template="rkTpl"
       template_body="RSYSLOG_ForwardFormat")

module(load='omrabbitmq')
action(type="omrabbitmq"
       host="localhost"
       virtual_host="/"
       user="guest"
       password="guest"
       ssl="on"
       verify_peer="off"
       verify_hostname="off"
       heartbeat_interval="20"
       exchange="syslog"
       routing_key="syslog.all")