﻿---
title: Riemann output plugin v3.0.1
description: Plugin version: v3.0.1, Released on: 2017-06-23, Changelog. For other versions, see the overview list. To learn more about Logstash, see the Logstash...
url: https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/v3-0-1-plugins-outputs-riemann
---

# Riemann output plugin v3.0.1
- Plugin version: v3.0.1
- Released on: 2017-06-23
- [Changelog](https://github.com/logstash-plugins/logstash-output-riemann/blob/v3.0.1/CHANGELOG.md)

For other versions, see the [overview list](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/output-riemann-index).
To learn more about Logstash, see the [Logstash Reference](https://www.elastic.co/guide/en/logstash/current/index.html).

## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-output-riemann). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

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:
- You can see the author talk about it here:
- 


## Riemann Output Configuration Options

This plugin supports the following configuration options plus the [Common options](#v3.0.1-plugins-outputs-riemann-common-options) described later.

| Setting                                                                         | Input type                                                                                          | Required |
|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|----------|
| [`debug`](#v3.0.1-plugins-outputs-riemann-debug)`debug`                         | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean                       | No       |
| [`host`](#v3.0.1-plugins-outputs-riemann-host)`host`                            | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                          | No       |
| [`map_fields`](#v3.0.1-plugins-outputs-riemann-map_fields)`map_fields`          | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean                       | No       |
| [`port`](#v3.0.1-plugins-outputs-riemann-port)`port`                            | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                          | No       |
| [`protocol`](#v3.0.1-plugins-outputs-riemann-protocol)`protocol`                | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string, one of `["tcp", "udp"]` | No       |
| [`riemann_event`](#v3.0.1-plugins-outputs-riemann-riemann_event)`riemann_event` | [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#hash)hash                                | No       |
| [`sender`](#v3.0.1-plugins-outputs-riemann-sender)`sender`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                          | No       |

Also see [Common options](#v3.0.1-plugins-outputs-riemann-common-options) for a list of options supported by all output plugins.

### `debug`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `false`

Enable debugging output?

### `host`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"localhost"`

The address of the Riemann server.

### `map_fields`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#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.example.com",
     "nested_field": {
                       "key": "value"
                     }
   }
Is mapped to this riemann event:
[source,ruby]
  {
    :time 1386686186,
    :host host.example.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`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `5555`

The port to connect to on your Riemann server.

### `protocol`

- 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`

- Value type is [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#hash)
- There is no default value for this setting.

A Hash to set Riemann event fields ().
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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"%{host}"`

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

## Common options

These configuration options are supported by all output plugins:

| Setting                                                                         | Input type                                                                    | Required |
|---------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`codec`](#v3.0.1-plugins-outputs-riemann-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#v3.0.1-plugins-outputs-riemann-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#v3.0.1-plugins-outputs-riemann-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `codec`

- Value type is [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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"
  }
}
```