librato
editlibrato
editThis is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/plugin install logstash-output-librato
.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
librato { account_id => ... api_token => ... }
Available configuration options:
Details
edit
account_id
edit- 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
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["@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 [source,ruby] { "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.
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.
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
exclude_tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events without any of these tags. Optional.
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: [source,ruby] { "value" => "%{bytes_received}" "source" => "%{host}" "name" => "apache_bytes" "measure_time" => "%{my_unixtime_field} } Default is to use the event's timestamp
tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events with all of these tags. Optional.
type
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- 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.