librato

Milestone: 1

Synopsis

This is what it might look like in your config file:

output {
  librato {
    account_id => ... # string (required)
    annotation => ... # hash (optional), default: {}
    api_token => ... # string (required)
    batch_size => ... # string (optional), default: "10"
    codec => ... # codec (optional), default: "plain"
    counter => ... # hash (optional), default: {}
    gauge => ... # hash (optional), default: {}
    workers => ... # number (optional), default: 1
  }
}

Details

account_id (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

annotation

• 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_token (required setting)

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

Your Librato API Token

batch_size

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

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

codec

• 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.

counter

• 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

exclude_tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

gauge

• Value type is hash
• Default value is {}

Gauges Send data to Librato as a gauge

Example: [“value”, “%{bytes_recieved}”, “source”, “%{host}”, “name”, “apache_bytes”] Additionally, you can override the measure_time for the event. Must be a unix timestamp: [“value”, “%{bytes_recieved}”, “source”, “%{host}”, “name”, “apache_bytes”,”measure_time”, “%{my_unixtime_field}] Default is to use the event’s timestamp

tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is string
• Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

• 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.

---

This is documentation from lib/logstash/outputs/librato.rb