This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Rabbitmq input plugin Relp input plugin »

› ›

Redis input plugin

edit

Redis input plugin

edit

Plugin version: v3.7.1
Released on: 2024-08-01
Changelog

For other versions, see the Versioned plugin docs.

Getting help

edit

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.

Description

edit

This input will read events from a Redis instance; it supports both Redis channels and lists. The list command (BLPOP) used by Logstash is supported in Redis v1.3.1+, and the channel commands used by Logstash are found in Redis 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 about Redis, see http://redis.io/

batch_count note: If you use the batch_count setting, you must use a Redis version 2.6.0 or newer. Anything older does not support the operations used by batching.

Redis Input Configuration Options

edit

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

Setting	Input type	Required
`batch_count`	number	No
`command_map`	hash	No
`data_type`	string, one of `["list", "channel", "pattern_channel"]`	Yes
`db`	number	No
`host`	string	No
`path`	string	No
`key`	string	Yes
`password`	password	No
`port`	number	No
`ssl`	boolean	No
`threads`	number	No
`timeout`	number	No

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

`batch_count`

edit

Value type is number
Default value is 125

The number of events to return from Redis using EVAL.

`command_map`

edit

Value type is hash
There is no default value for this setting.
key is the default command name, value is the renamed command.

Configure renamed redis commands in the form of "oldname" ⇒ "newname". Redis allows for the renaming or disabling of commands in its protocol, see: https://redis.io/topics/security

`data_type`

edit

This is a required setting.
Value can be any of: list, channel, pattern_channel
There is no default value for this setting.

Specify either list or channel. If data_type is list, then we will BLPOP the key. If data_type is channel, then we will SUBSCRIBE to the key. If data_type is pattern_channel, then we will PSUBSCRIBE to the key.

`db`

edit

Value type is number
Default value is 0

The Redis database number.

`host`

edit

Value type is string
Default value is "127.0.0.1"

The hostname of your Redis server.

`path`

edit

Value type is string
There is no default value for this setting.
Path will override Host configuration if both specified.

The unix socket path of your Redis server.

`key`

edit

This is a required setting.
Value type is string
There is no default value for this setting.

The name of a Redis list or channel.

`password`

edit

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

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

`port`

edit

Value type is number
Default value is 6379

The port to connect on.

`ssl`

edit

Value type is boolean
Default value is false

Enable SSL support.

`threads`

edit

Value type is number
Default value is 1

Number of instances of the input to start, each on its own thread. Increase from one to improve concurrency in consuming messages from Redis.

Increasing the number of threads when consuming from a channel will result in duplicate messages since a SUBSCRIBE delivers each message to all subscribers.

`timeout`

edit

Value type is number
Default value is 5

Initial connection timeout in seconds.

Common options

edit

These configuration options are supported by all input plugins:

Setting	Input type	Required
`add_field`	hash	No
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`tags`	array	No
`type`	string	No

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`codec`

edit

Value type is codec
Default value is "json"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

`enable_metric`

edit

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.

`id`

edit

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 inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

`tags`

edit

Value type is array
There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

`type`

edit

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

« Rabbitmq input plugin Relp input plugin »