:plugin: opentsdb
:type: output

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Opentsdb output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

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.


[id="plugins-{type}s-{plugin}-options"]
==== Opentsdb Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-metrics>> |<<array,array>>|Yes
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-host"]
===== `host` 

  * Value type is <<string,string>>
  * Default value is `"localhost"`

The address of the opentsdb server.

[id="plugins-{type}s-{plugin}-metrics"]
===== `metrics` 

  * This is a required setting.
  * Value type is <<array,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:
[source,ruby]
    [
      "%{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)

[id="plugins-{type}s-{plugin}-port"]
===== `port` 

  * Value type is <<number,number>>
  * Default value is `4242`

The port to connect on your graphite server.



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]