Skip to content

Commit

Permalink
omelasticsearch: add support for rebindinterval (#796)
Browse files Browse the repository at this point in the history
Documentation for PR
rsyslog/rsyslog#3557
  • Loading branch information
richm authored and rgerhards committed Apr 1, 2019
1 parent eb54adb commit d7d69c3
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions source/configuration/modules/omelasticsearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,28 @@ this parameter has no effect. Specifies the maximum number of messages that
can be emitted within the ratelimit.interval interval. For futher information,
see description there.

.. _omelasticsearch-rebindinterval:

rebindinterval
^^^^^^^^^^^^^^

.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table

"integer", "-1", "no", "none"

This parameter tells omelasticsearch to close the connection and reconnect
to Elasticsearch after this many operations have been submitted. The default
value `-1` means that omelasticsearch will not reconnect. A value greater
than `-1` tells omelasticsearch, after this many operations have been
submitted to Elasticsearch, to drop the connection and establish a new
connection. This is useful when rsyslog connects to multiple Elasticsearch
nodes through a router or load balancer, and you need to periodically drop
and reestablish connections to help the router balance the connections. Use
the counter `rebinds` to monitor the number of times this has happened.

.. _omelasticsearch-statistic-counter:

Statistic Counter
Expand Down Expand Up @@ -729,6 +751,9 @@ The following counters are available when `retryfailures="on"` is used:
response not recognized as one of the above responses, typically some other
`4xx` or `5xx` http status.

- **rebinds** - if using `rebindinterval` this will be the number of
times omelasticsearch has reconnected to Elasticsearch

**The fail.httprequests and fail.http counters reflect only failures that
omelasticsearch detected.** Once it detects problems, it (usually, depends on
circumstances) tell the rsyslog core that it wants to be suspended until the
Expand Down

0 comments on commit d7d69c3

Please sign in to comment.