IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« rabbitmq riak »
Elastic Docs ›Logstash Reference [2.0] ›Logstash Reference ›Output plugins

redis

edit

redis

edit

This output will send events to a Redis queue using RPUSH. The RPUSH command is supported in Redis v0.0.7+. Using PUBLISH to a channel requires at least 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, see the Redis homepage

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

redis {
}

Available configuration options:

Setting Input type Required Default value

batch

boolean

No

false

batch_events

number

No

50

batch_timeout

number

No

5

codec

codec

No

"plain"

congestion_interval

number

No

1

congestion_threshold

number

No

0

data_type

string, one of ["list", "channel"]

No

db

number

No

0

host

array

No

["127.0.0.1"]

key

string

No

password

password

No

port

number

No

6379

reconnect_interval

number

No

1

shuffle_hosts

boolean

No

true

timeout

number

No

5

workers

number

No

1

Details

edit

 

batch

edit
  • Value type is boolean
  • Default value is false

Set to true if you want Redis to batch up values and send 1 RPUSH command instead of one command per value to push on the list. Note that this only works with data_type="list" mode right now.

If true, we send an RPUSH every "batch_events" events or "batch_timeout" seconds (whichever comes first). Only supported for data_type is "list".

batch_events

edit
  • Value type is number
  • Default value is 50

If batch is set to true, the number of events we queue up for an RPUSH.

batch_timeout

edit
  • Value type is number
  • Default value is 5

If batch is set to true, the maximum amount of time between RPUSH commands when there are pending events to flush.

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

congestion_interval

edit
  • Value type is number
  • Default value is 1

How often to check for congestion. Default is one second. Zero means to check on every event.

congestion_threshold

edit
  • Value type is number
  • Default value is 0

In case Redis data_type is list and has more than @congestion_threshold items, block until someone consumes them and reduces congestion, otherwise if there are no consumers Redis will run out of memory, unless it was configured with OOM protection. But even with OOM protection, a single Redis list can block all other users of Redis, until Redis CPU consumption reaches the max allowed RAM size. A default value of 0 means that this limit is disabled. Only supported for list Redis data_type.

data_type

edit
  • Value can be any of: list, channel
  • There is no default value for this setting.

Either list or channel. If redis_type is list, then we will set RPUSH to key. If redis_type is channel, then we will PUBLISH to key. TODO set required true

db

edit
  • Value type is number
  • Default value is 0

The Redis database number.

host

edit
  • Value type is array
  • Default value is ["127.0.0.1"]

The hostname(s) of your Redis server(s). Ports may be specified on any hostname, which will override the global port config.

For example:

    "127.0.0.1"
    ["127.0.0.1", "127.0.0.2"]
    ["127.0.0.1:6380", "127.0.0.1"]

key

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

The name of a Redis list or channel. Dynamic names are valid here, for example logstash-%{type}. TODO set required true

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"

Name is used for logging in case there are multiple instances. TODO: delete

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 default port to connect on. Can be overridden on any hostname.

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 RPUSH on this). Dynamic names are valid here, for example logstash-%{type} TODO: delete

reconnect_interval

edit
  • Value type is number
  • Default value is 1

Interval for reconnecting to failed Redis connections

shuffle_hosts

edit
  • Value type is boolean
  • Default value is true

Shuffle the host list during Logstash startup.

timeout

edit
  • Value type is number
  • Default value is 5

Redis initial connection timeout in seconds.

workers

edit
  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

« rabbitmq riak »