riakedit

  • Version: 3.0.0
  • Released on: 2016-09-10
  • Changelog
Note

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-riak.

Riak is a distributed k/v store from Basho. It’s based on the Dynamo model.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

riak {
}

Available configuration options:

Setting Input typeRequiredDefault value

bucket

array

No

["logstash-%{+YYYY.MM.dd}"]

bucket_props

hash

No

codec

codec

No

"plain"

enable_metric

boolean

No

true

enable_search

boolean

No

false

enable_ssl

boolean

No

false

id

string

No

indices

array

No

key_name

string

No

nodes

hash

No

{"localhost"=>"8098"}

proto

string, one of ["http", "pb"]

No

"http"

ssl_opts

hash

No

workers

<<,>>

No

1

Detailsedit

 

bucketedit

  • 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_propsedit

  • 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

codecedit

  • 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_metricedit

  • 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.

enable_searchedit

  • Value type is boolean
  • Default value is false

Search Enable search on the bucket defined above

enable_ssledit

  • Value type is boolean
  • Default value is false

SSL Enable SSL

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

``` output { stdout { id ⇒ "ABC" } } ```

If you don’t explicitely set this variable Logstash will generate a unique name.

indicesedit

  • 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_nameedit

  • 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.

nodesedit

  • 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"
}

protoedit

  • 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_optsedit

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

SSL Options 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

workersedit

  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne