This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

› ›

Riemann output plugin

edit

Riemann output plugin

edit

Plugin version: v3.0.7
Released on: 2020-07-15
Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-riemann. See Working with plugins for more details.

Getting help

edit

For 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

edit

Riemann is a network event stream processing system.

While Riemann is very similar conceptually to Logstash, it has much more in terms of being a monitoring system replacement.

Riemann is used in Logstash much like statsd or other metric-related outputs

You can learn about Riemann here:

http://riemann.io/

You can see the author talk about it here:

http://vimeo.com/38377415

Riemann Output Configuration Options

edit

This plugin supports the following configuration options plus the Common options described later.

Setting	Input type	Required
`debug`	boolean	No
`host`	string	No
`map_fields`	boolean	No
`port`	number	No
`protocol`	string, one of `["tcp", "udp"]`	No
`riemann_event`	hash	No
`sender`	string	No

Also see Common options for a list of options supported by all output plugins.

`debug`

edit

Value type is boolean
Default value is false

Enable debugging output?

`host`

edit

Value type is string
Default value is "localhost"

The address of the Riemann server.

`map_fields`

edit

Value type is boolean
Default value is false

If set to true automatically map all logstash defined fields to riemann event fields. All nested logstash fields will be mapped to riemann fields containing all parent keys separated by dots and the deepest value.

As an example, the logstash event:

   {
     "@timestamp":"2013-12-10T14:36:26.151+0000",
     "@version": 1,
     "message":"log message",
     "host": "host.domain.com",
     "nested_field": {
                       "key": "value"
                     }
   }

Is mapped to this riemann event:

  {
    :time 1386686186,
    :host host.domain.com,
    :message log message,
    :nested_field.key value
  }

It can be used in conjunction with or independent of the riemann_event option. When used with the riemann_event any duplicate keys receive their value from riemann_event instead of the logstash event itself.

`port`

edit

Value type is number
Default value is 5555

The port to connect to on your Riemann server.

`protocol`

edit

Value can be any of: tcp, udp
Default value is "tcp"

The protocol to use UDP is non-blocking TCP is blocking

Logstash’s default output behaviour is to never lose events As such, we use tcp as default here

`riemann_event`

edit

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

A Hash to set Riemann event fields (http://riemann.io/concepts.html).

The following event fields are supported: description, state, metric, ttl, service

Tags found on the Logstash event will automatically be added to the Riemann event.

Any other field set here will be passed to Riemann as an event attribute.

Example:

    riemann {
        riemann_event => {
            "metric"  => "%{metric}"
            "service" => "%{service}"
        }
    }

metric and ttl values will be coerced to a floating point value. Values which cannot be coerced will zero (0.0).

description, by default, will be set to the event message but can be overridden here.

`sender`

edit

Value type is string
Default value is "%{host}"

The name of the sender. This sets the host value in the Riemann event

Common options

edit

These configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No

`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 riemann outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  riemann {
    id => "my_plugin_id"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

« Riak output plugin S3 output plugin »