opentsdb

Milestone: 1

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

This is what it might look like in your config file:
output {
  opentsdb {
    codec => ... # codec (optional), default: "plain"
    host => ... # string (optional), default: "localhost"
    metrics => ... # array (required)
    port => ... # number (optional), default: 4242
    workers => ... # number (optional), default: 1
  }
}

Details

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.

debug DEPRECATED

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

Enable debugging.

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.

host

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

The address of the opentsdb server.

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

  • Value type is number
  • Default value is 4242

The port to connect on your graphite server.

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/opentsdb.rb