For other versions, see theVersioned 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 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+, andthe 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 performanceand 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 ornewer. Anything older does not support the operations used by batching.
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
string, one of |
Yes |
|
No |
||
No |
||
Yes |
||
No |
||
No |
||
No |
||
No |
Also see Common Options for a list of options supported by allinput plugins.
125
The number of events to return from Redis using EVAL.
list
, channel
, pattern_channel
Specify either list or channel. If redis\_type
is list
, then we will BLPOP thekey. If redis\_type
is channel
, then we will SUBSCRIBE to the key.If redis\_type
is pattern_channel
, then we will PSUBSCRIBE to the key.
The name of a Redis list or channel.
Password to authenticate with. There is no authentication by default.
1
The following configuration options are supported by all input plugins:
"plain"
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.
true
Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor 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 usefulwhen 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" }}
Add any number of arbitrary tags to your event.
This can help with processing later.
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 canalso use the type to search for it in Kibana.
If you try to set a type on an event that already has one (forexample when you send an event from a shipper to an indexer) thena new input will not override the existing type. A type set atthe shipper stays with that event for its life evenwhen sent to another Logstash server.