index.asciidoc

Redis input plugin

../../../../logstash/docs/include/plugin_header.asciidoc

Description

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

This plugin supports the following configuration options plus the [plugins-inputs-redis-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 [plugins-inputs-redis-common-options] for a list of options supported by all input plugins.

 

batch_count

• Value type is number

• Default value is 125

The number of events to return from Redis using EVAL.

command_map

• 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

• 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

• Value type is number

• Default value is 0

The Redis database number.

host

• Value type is string

• Default value is "127.0.0.1"

The hostname of your Redis server.

path

• 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

• 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

• Value type is password

• There is no default value for this setting.

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

port

• Value type is number

• Default value is 6379

The port to connect on.

ssl

• Value type is boolean

• Default value is false

Enable SSL support.

threads

• Value type is number

• Default value is 1

timeout

• Value type is number

• Default value is 5

Initial connection timeout in seconds.

../../../../logstash/docs/include/input.asciidoc