redis

Status: beta

send events to a redis database using RPUSH

For more information about redis, see http://redis.io/

Synopsis

This is what it might look like in your config file:

output {
  redis {
    data_type => ... # ["list", "channel"] (optional)
    db => ... # number (optional), default: 0
    host => ... # string (optional), default: "127.0.0.1"
    key => ... # string (optional)
    password => ... # password (optional)
    port => ... # number (optional), default: 6379
    tags => ... # array (optional), default: []
    timeout => ... # number (optional), default: 5
    type => ... # string (optional), default: ""
  }
}

Details

data_type

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

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

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.

key

• 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

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is string
• Default value is "default"

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

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.

queue DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• 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

tags

• Value type is array
• Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

timeout

• Value type is number
• Default value is 5

Redis initial connection timeout in seconds.

type

• Value type is string
• Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin's "type" attribute for more. Optional.

---

This is documentation from lib/logstash/outputs/redis.rb