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

For other versions, see theVersioned plugin docs.

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

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, seehttp://redis.io/

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

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

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

• Value type isnumber
• Default value is125

The number of events to return from Redis using EVAL.

• Value type ishash
• 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

• 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. Ifdata_type islist, then we will BLPOP the key. Ifdata_type ischannel, then we will SUBSCRIBE to the key. Ifdata_type ispattern_channel, then we will PSUBSCRIBE to the key.

• Value type isnumber
• Default value is0

The Redis database number.

• Value type isstring
• Default value is"127.0.0.1"

The hostname of your Redis server.

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

The unix socket path of your Redis server.

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

The name of a Redis list or channel.

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

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

• Value type isnumber
• Default value is6379

The port to connect on.

• Value type isboolean
• Default value isfalse

Enable SSL support.

• Value type isnumber
• Default value is1

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

• Value type isnumber
• Default value is5

Initial connection timeout in seconds.

These configuration options are supported by all input plugins:

• Value type ishash
• Default value is{}

Add a field to an event

• Value type iscodec
• 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.

• Value type isboolean
• Default value istrue

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 isstring
• There is no default value for this setting.

Add a uniqueID 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"  }}

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

Add any number of arbitrary tags to your event.

This can help with processing later.

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

Add atype 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.