1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
**********************************
omrabbitmq: RabbitMQ output module
**********************************
=========================== ===========================================================================
**Module Name:** **omrabbitmq**
**Authors:** Jean-Philippe Hilaire <jean-philippe.hilaire@pmu.fr> / Philippe Duveau <philippe.duveau@free.fr> / Hamid Maadani <hamid@dexo.tech>
=========================== ===========================================================================
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 <https://github.com/alanxz/rabbitmq-c>`_ library version >= 0.4.
./configure --enable-omrabbitmq ...
Configuration Parameters
========================
Action Parameters
-----------------
host
^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "yes", "hostname\[:port\]\[ hostname2\[:port2\]\]",
rabbitmq server(s). See HA configuration
port
^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "port", "5672"
virtual\_host
^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "yes", "path",
virtual message broker
user
^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "yes", "user",
user name
password
^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "yes", "password",
user password
ssl
^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"binary", "no", , "off"
enable TLS for AMQP connection
init_openssl
^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"binary", "no", , "off"
should rabbitmq-c initialize OpenSSL? This is included to prevent crashes caused by OpenSSL double initialization. Should stay off in most cases. ONLY turn on if SSL does not work due to OpenSSL not being initialized.
verify_peer
^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"binary", "no", , "off"
SSL peer verification
verify_hostname
^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"binary", "no", , "off"
SSL certificate hostname verification
ca_cert
^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "file path",
CA certificate to be used for the SSL connection
heartbeat_interval
^^^^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"integer", "no", , "0"
AMQP heartbeat interval in seconds. 0 means disabled, which is default.
exchange
^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "name",
exchange name
routing\_key
^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "name",
value of routing key
routing\_key\_template
^^^^^^^^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "template_name",
template used to compute the routing key
body\_template
^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "template", "StdJSONFmt"
template used to compute the message body. If the template is an empty string the sent message will be %rawmsg%
delivery\_mode
^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "TRANSIENT\|PERSISTANT", "TRANSIENT"
persistence of the message in the broker
expiration
^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "milliseconds", no expiration
ttl of the amqp message
populate\_properties
^^^^^^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"binary", "no", , "off"
fill timestamp, appid, msgid, hostname (custom header) with message informations
content\_type
^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "value",
content type as a MIME value
declare\_exchange
^^^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"binary", "no", "off",
Rsyslog tries to declare the exchange on startup. Declaration failure (already exists with different parameters or insufficient rights) is warned but does not cancel the module instance.
recover\_policy
^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "mandatory", "format", "default"
:widths: auto
:class: parameter-table
"string", "no", "check\_interval;short\_failure_interval; short\_failure\_nb\_max;graceful\_interval", "60;6;3;600"
See HA configuration
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
========
Example 1
---------
This is the simplest action :
- No High Availability
- The routing-key is constant
- The sent message use JSON format
.. code-block:: none
module(load='omrabbitmq')
action(type="omrabbitmq"
host="localhost"
virtual_host="/"
user="guest"
password="guest"
exchange="syslog"
routing_key="syslog.all")
Example 2
---------
Action characteristics :
- No High Availability
- The routing-key is computed
- The sent message is a raw message
.. code-block:: none
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="")
Example 3
---------
HA action :
- High Availability between `server1:5672` and `server2:1234`
- The routing-key is computed
- The sent message is formatted using RSYSLOG_ForwardFormat standard template
.. code-block:: none
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")
Example 4
---------
SSL enabled connection, with Heartbeat :
- No High Availability
- The routing-key is constant
- The sent message use JSON format
- Heartbeat is set to 20 seconds
.. code-block:: none
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")
|
