Redis output plugin

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

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

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

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

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.

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

The Redis database number.

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"]

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

Name is used for logging in case there are multiple instances.

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

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

The name of the Redis queue (we’ll use RPUSH on this). Dynamic names are valid here, for example logstash-%{type}

Interval for reconnecting to failed Redis connections

Shuffle the host list during Logstash startup.

Redis initial connection timeout in seconds.

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 redis outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  redis {
    id => "my_plugin_id"
  }
}