Redis output plugin
editRedis output plugin
edit- Plugin version: v4.0.4
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-redis
. See Working with plugins for more details.
Getting Help
editFor 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.
Description
editThis 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
Redis Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
string, one of |
No |
|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
Also see Common Options for a list of options supported by all output plugins.
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.
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 data_type
is list, then we will set
RPUSH to key. If data_type
is channel, then we will PUBLISH to key
.
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. If the hosts list is an array, Logstash will pick one random host to connect to, if that host is disconnected it will then pick another.
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}
.
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.
reconnect_interval
edit- Value type is number
-
Default value is
1
Interval for reconnecting to failed Redis connections
Common Options
editThe following configuration options are supported by all output plugins:
codec
edit- Value type is codec
-
Default value is
"json"
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.
enable_metric
edit- Value type is boolean
-
Default value is
true
Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.
id
edit- Value type is string
- There is no default value for this setting.
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 useful
when you have two or more plugins of the same type. For example, if you have 2 redis outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { redis { id => "my_plugin_id" } }