Riak output plugin
editRiak output plugin
edit- Plugin version: v3.0.5
- Released on: 2019-10-09
- 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-riak
. 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
editRiak is a distributed k/v store from Basho. It’s based on the Dynamo model.
Riak 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 |
||
No |
||
No |
||
string, one of |
No |
|
No |
Also see Common Options for a list of options supported by all output plugins.
bucket
edit- Value type is array
-
Default value is
["logstash-%{+YYYY.MM.dd}"]
The bucket name to write events to Expansion is supported here as values are passed through event.sprintf Multiple buckets can be specified here but any bucket-specific settings defined apply to ALL the buckets.
bucket_props
edit- Value type is hash
- There is no default value for this setting.
Bucket properties (NYI) Logstash hash of properties for the bucket i.e.
bucket_props => { "r" => "one" "w" => "one" "dw", "one }
or
bucket_props => { "n_val" => "3" }
Properties will be passed as-is
enable_search
edit- Value type is boolean
-
Default value is
false
Search Enable search on the bucket defined above
indices
edit- Value type is array
- There is no default value for this setting.
Indices Array of fields to add 2i on e.g.
`indices => ["source_host", "type"]
Off by default as not everyone runs eleveldb
key_name
edit- Value type is string
- There is no default value for this setting.
The event key name variables are valid here.
Choose this carefully. Best to let riak decide.
nodes
edit- Value type is hash
-
Default value is
{"localhost"=>"8098"}
The nodes of your Riak cluster This can be a single host or a Logstash hash of node/port pairs e.g
{ "node1" => "8098" "node2" => "8098" }
proto
edit-
Value can be any of:
http
,pb
-
Default value is
"http"
The protocol to use HTTP or ProtoBuf Applies to ALL backends listed above No mix and match
ssl_opts
edit- Value type is hash
- There is no default value for this setting.
Options for SSL connections. Only applied if SSL is enabled. Logstash hash that maps to the riak-client options here: https://github.com/basho/riak-ruby-client/wiki/Connecting-to-Riak.
You’ll likely want something like this:
ssl_opts => { "pem" => "/etc/riak.pem" "ca_path" => "/usr/share/certificates" }
Per the riak client docs, the above sample options
will turn on SSL VERIFY_PEER
Common Options
editThe following configuration options are supported by all output plugins:
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.
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 riak outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { riak { id => "my_plugin_id" } }