For other versions, see theVersioned plugin docs.
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.
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.
Riemann is a network event stream processing system.
While Riemann is very similar conceptually to Logstash, it hasmuch more in terms of being a monitoring system replacement.
Riemann is used in Logstash much like statsd or other metric-relatedoutputs
You can learn about Riemann here:
This plugin supports the following configuration options plus the Common Options described later.
| Setting | Input type | Required |
|---|---|---|
No |
||
No |
||
No |
||
No |
||
string, one of |
No |
|
No |
||
No |
Also see Common Options for a list of options supported by alloutput plugins.
falseIf 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 keysseparated 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 fromriemann_event instead of the logstash event itself.
tcp, udp"tcp"The protocol to useUDP is non-blockingTCP is blocking
Logstash’s default output behaviouris to never lose eventsAs such, we use tcp as default here
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 theRiemann 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 messagebut can be overridden here.
"%{host}"The name of the sender.This sets the host valuein the Riemann event
The following configuration options are supported by all output plugins:
"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.
trueDisable or enable metric logging for this specific plugin instance.By default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
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 usefulwhen 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" }}