Redis output plugin

• Plugin version: v5.2.0
• Released on: 2024-06-04
• Changelog

For other versions, see the Versioned plugin docs.

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

This output will send events to a Redis queue using RPUSH. The RPUSH command is supported in Redis v0.0.7+. 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

This plugin supports the following configuration options plus the Common options described later.

Also see Common options for a list of options supported by all output plugins.

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

• Value type is number
• Default value is 50

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

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

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

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

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

• Value type is number
• Default value is 0

The Redis database number.

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

• 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-%{{type}}.

• Value type is password
• There is no default value for this setting.

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

• Value type is number
• Default value is 6379

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

• Value type is boolean
• Default value is false

Enable SSL support.

• Value type is number
• Default value is 1

Interval for reconnecting to failed Redis connections

• Value type is boolean
• Default value is true

Shuffle the host list during Logstash startup.

• Value type is path
• There is no default value for this setting.

Path to certificate in PEM format. This certificate will be presented to the other part of the TLS connection.

• Value type is array
• Default value is []

Validate the certificate chain against these authorities. You can define multiple files. All the certificates will be read and added to the trust store. The system CA path is automatically included.

• Value type is a list of string
• There is no default value for this setting

The list of cipher suites to use, listed by priorities. Supported cipher suites vary depending on the Java and protocol versions.

• Value type is boolean
• Default value is false

Enable SSL (must be set for other ssl_ options to take effect).

• Value type is path
• There is no default value for this setting.

SSL key path

• Value type is password
• Default value is nil

SSL key passphrase

• Value type is string
• Allowed values are: 'TLSv1.1', 'TLSv1.2', 'TLSv1.3'
• Default depends on the JDK being used. With up-to-date Logstash, the default is ['TLSv1.2', 'TLSv1.3']. 'TLSv1.1' is not considered secure and is only provided for legacy applications.

List of allowed SSL/TLS versions to use when establishing a secure connection.

• Value can be any of: full, none
• Default value is full

Defines how to verify the certificates presented by another part in the TLS connection:

full validates that the server certificate has an issue date that’s within the not_before and not_after dates; chains to a trusted Certificate Authority (CA), and has a hostname or IP address that matches the names within the certificate.

none performs no certificate validation.

• Value type is number
• Default value is 5

Redis initial connection timeout in seconds.

These configuration options are supported by all output plugins:

• Value type is codec
• Default value is "json"

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.

• Value type is boolean
• Default value is true

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.

• Value type is string
• There is no default value for this setting.

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