index.asciidoc

Redis output plugin

../../../../logstash/docs/include/plugin_header.asciidoc

Description

This output will send events to a Redis queue using RPUSH (or, optionally, LPUSH). The RPUSH and LPUSH commands are supported in Redis v1.0.0+. Using PUBLISH to a channel requires at least v1.3.8+. While you may be able to make these Redis versions work, the best performance and stability will be found in more recent stable versions. Versions 2.6.0+ are recommended.

For more information, see the Redis homepage

Redis Output Configuration Options

This plugin supports the following configuration options plus the [plugins-outputs-redis-common-options] described later.

Setting	Input type	Required
batch	boolean	No
batch_events	number	No
batch_timeout	number	No
congestion_interval	number	No
congestion_threshold	number	No
data_type	string, one of ["list", "channel"]	No
db	number	No
host	array	No
key	string	No
password	password	No
port	number	No
reconnect_interval	number	No
shuffle_hosts	boolean	No
timeout	number	No

Also see [plugins-outputs-redis-common-options] for a list of options supported by all output plugins.

 

batch

• Value type is boolean

• Default value is false

Set to true if you want Redis to batch up values and send 1 RPUSH command instead of one command per value to push on the list. Note that this only works with data_type="list" mode right now.

If true, we send an RPUSH every "batch_events" events or "batch_timeout" seconds (whichever comes first). Only supported for data_type is "list".

batch_events

• Value type is number

• Default value is 50

If batch is set to true, the number of events we queue up for an RPUSH.

batch_timeout

• Value type is number

• Default value is 5

If batch is set to true, the maximum amount of time between RPUSH commands when there are pending events to flush.

congestion_interval

• Value type is number

• Default value is 1

How often to check for congestion. Default is one second. Zero means to check on every event.

congestion_threshold

• Value type is number

• Default value is 0

In case Redis data_type is list and has more than @congestion_threshold items, block until someone consumes them and reduces congestion, otherwise if there are no consumers Redis will run out of memory, unless it was configured with OOM protection. But even with OOM protection, a single Redis list can block all other users of Redis, until Redis CPU consumption reaches the max allowed RAM size. A default value of 0 means that this limit is disabled. Only supported for list Redis data_type.

data_type

• Value can be any of: list, channel

• There is no default value for this setting.

Either list or channel. If data_type is list, then we will set RPUSH to key. If data_type is channel, then we will PUBLISH to key.

db

• Value type is number

• Default value is 0

The Redis database number.

host

• Value type is array

• Default value is ["127.0.0.1"]

The hostname(s) of your Redis server(s). Ports may be specified on any hostname, which will override the global port config. If the hosts list is an array, Logstash will pick one random host to connect to, if that host is disconnected it will then pick another.

For example:

    "127.0.0.1"
    ["127.0.0.1", "127.0.0.2"]
    ["127.0.0.1:6380", "127.0.0.1"]

key

• Value type is string

• There is no default value for this setting.

The name of a Redis list or channel. Dynamic names are valid here, for example logstash-%output.

password

• Value type is password

• There is no default value for this setting.

Password to authenticate with. There is no authentication by default.

port

• Value type is number

• Default value is 6379

The default port to connect on. Can be overridden on any hostname.

reconnect_interval

• Value type is number

• Default value is 1

Interval for reconnecting to failed Redis connections

shuffle_hosts

• Value type is boolean

• Default value is true

Shuffle the host list during Logstash startup.

timeout

• Value type is number

• Default value is 5

Redis initial connection timeout in seconds.

../../../../logstash/docs/include/output.asciidoc