Librato output plugin
editLibrato output plugin
edit- Plugin version: v3.0.7
- Released on: 2019-10-09
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor 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
editFor 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
editThis 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
editThis plugin supports the following configuration options plus the Common options described later.
Setting | Input type | Required |
---|---|---|
Yes |
||
No |
||
Yes |
||
No |
||
No |
||
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" }
or
{ "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
editThese configuration options are supported by all output plugins:
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" } }
Variable substitution in the id
field only supports environment variables
and does not support the use of values from the secret store.