redis
editredis
edit
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
redis { }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|
||
No |
|
||
No |
|
||
string, one of |
No |
||
No |
|
||
No |
|
||
No |
|||
No |
|||
No |
|
||
No |
|||
No |
|
||
No |
|
||
No |
Details
edit
batch_count
edit- Value type is number
-
Default value is
1
The number of events to return from Redis using EVAL.
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.
data_type
edit-
Value can be any of:
list
,channel
,pattern_channel
- There is no default value for this setting.
Specify either list or channel. If redis\_type
is list
, then we will BLPOP the
key. 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.
key
edit- Value type is string
- There is no default value for this setting.
The name of a Redis list or channel.
name
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is string
-
Default value is
"default"
class LogStash::Inputs::Redis < LogStash::Inputs::Threadable
The name
configuration is used for logging in case there are multiple instances.
This feature has no real function and will be removed in future versions.
password
edit- Value type is password
- There is no default value for this setting.
Password to authenticate with. There is no authentication by default.
queue
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is string
- There is no default value for this setting.
The name of the Redis queue (we’ll use BLPOP against this).
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.