libratoedit

Note

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-librato.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

librato {
    account_id => ...
    api_token => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

account_id

string

Yes

annotation

hash

No

{}

api_token

string

Yes

batch_size

string

No

"10"

codec

codec

No

"plain"

counter

hash

No

{}

gauge

hash

No

{}

workers

number

No

1

Detailsedit

 

account_idedit

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

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

This is VERY experimental and inefficient right now. Your Librato account usually an email address

annotationedit

  • 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["@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"
  }
or
{
   "title" => "Logstash event"
   "description" => "%{message}"
   "name" => "logstash_stream"
}

api_tokenedit

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

Your Librato API Token

batch_sizeedit

  • Value type is string
  • Default value is "10"

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

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.

counteredit

  • 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

gaugeedit

  • 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

workersedit

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.