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

« newrelic pagerduty »

› ›

opentsdb

edit

opentsdb

edit

Version: 3.1.1
Released on: 2016-07-14
Changelog
Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-opentsdb.

This output allows you to pull metrics from your logs and ship them to opentsdb. Opentsdb is an open source tool for storing and graphing metrics.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

opentsdb {
    metrics => ...
}

Available configuration options:

Setting	Input type	Required	Default value
`codec`	codec	No	`"plain"`
`enable_metric`	boolean	No	`true`
`host`	string	No	`"localhost"`
`id`	string	No
`metrics`	array	Yes
`port`	number	No	`4242`
`workers`	<<,>>	No	`1`

Details

edit

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

`host`

edit

Value type is string
Default value is "localhost"

The address of the opentsdb server.

`id`

edit

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

`metrics`

edit

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

The metric(s) to use. This supports dynamic strings like %{source_host} for metric names and also for values. This is an array field with key of the metric name, value of the metric value, and multiple tag,values . Example:

    [
      "%{host}/uptime",
      %{uptime_1m} " ,
      "hostname" ,
      "%{host}
      "anotherhostname" ,
      "%{host}
    ]

The value will be coerced to a floating point value. Values which cannot be coerced will zero (0)

`port`

edit

Value type is number
Default value is 4242

The port to connect on your graphite server.

`workers`

edit

Value type is string
Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne

« newrelic pagerduty »