IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Kafka output plugin Loggly output plugin »

› ›

Librato output plugin

edit

Librato output plugin

edit

Plugin version: v3.0.6
Released on: 2018-04-06
Changelog

Installation

edit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-librato. 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

This output lets you send metrics, annotations, and alerts to Librato based on Logstash events

This is VERY experimental and inefficient right now.

Librato Output Configuration Options

edit

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

Setting	Input type	Required
`account_id`	string	Yes
`annotation`	hash	No
`api_token`	string	Yes
`batch_size`	string	No
`counter`	hash	No
`gauge`	hash	No

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

`account_id`

edit

This is a required setting.
Value type is string
There is no default value for this setting.

Your Librato account usually an email address

`annotation`

edit

Value type is hash
Default value is {}

Annotations Registers an annotation with Librato The only required field is title and name. start_time and end_time will be set to event.get("@timestamp").to_i You can add any other optional annotation values as well. All values will be passed through event.sprintf

Example:

  {
      "title" => "Logstash event on %{host}"
      "name" => "logstash_stream"
  }

   {
      "title" => "Logstash event"
      "description" => "%{message}"
      "name" => "logstash_stream"
   }

`api_token`

edit

This is a required setting.
Value type is string
There is no default value for this setting.

Your Librato API Token

`batch_size`

edit

Value type is string
Default value is "10"

Batch size Number of events to batch up before sending to Librato.

`counter`

edit

Value type is hash
Default value is {}

Counters Send data to Librato as a counter

Example:

    {
        "value" => "1"
        "source" => "%{host}"
        "name" => "messages_received"
    }

Additionally, you can override the measure_time for the event. Must be a unix timestamp:

    {
        "value" => "1"
        "source" => "%{host}"
        "name" => "messages_received"
        "measure_time" => "%{my_unixtime_field}"
    }

Default is to use the event’s timestamp

`gauge`

edit

Value type is hash
Default value is {}

Gauges Send data to Librato as a gauge

Example:

    {
        "value" => "%{bytes_received}"
        "source" => "%{host}"
        "name" => "apache_bytes"
    }

Additionally, you can override the measure_time for the event. Must be a unix timestamp:

    {
        "value" => "%{bytes_received}"
        "source" => "%{host}"
        "name" => "apache_bytes"
        "measure_time" => "%{my_unixtime_field}
    }

Default is to use the event’s timestamp

Common Options

edit

The following configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`workers`	number	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 librato outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

`workers`

edit

Value type is string
Default value is 1

« Kafka output plugin Loggly output plugin »