Telegraf output plugins

Warning! This page documents an earlier version of Telegraf, which is no longer actively developed. Telegraf v1.7 is the most recent stable version of Telegraf.

Telegraf allows users to specify multiple output sinks in the configuration file.

Note: Telegraf plugins added in the current release are noted with -- NEW in v1.5. The Release Notes/Changelog has a list of new plugins and updates for other plugins. See the plugin README files for more details.

Supported output plugins

Amon (amon_output)

The Amon (amon_output) output plugin writes to Amon and requires a serverkey and amoninstance URL which can be obtained here for the account.

If the point value being sent cannot be converted to a float64, the metric is skipped.

Metrics are grouped by converting any _ characters to . in the Point Name.

AMQP (amqp_output)

The AMQP (amqp_output) output plugin writes to a AMQP 0-9-1 Exchange, a prominent implementation of this protocol being RabbitMQ.

Metrics are written to a topic exchange using tag, defined in configuration file as RoutingTag, as a routing key.

CloudWatch (cloudwatch_output)

The CloudWatch (cloudwatch_output) output plugin send metrics to Amazon CloudWatch.

CrateDB (cratedb) – NEW in v1.5

The CrateDB (cratedb) output plugin writes to CrateDB using its PostgreSQL protocol.

Datadog (datadog_output)

The Datadog (datadog_output) output plugin writes to the Datadog Metrics API and requires an apikey which can be obtained here for the account.

Discard (discard)

The Discard (discard) output plugin simply drops all metrics that are sent to it. It is only meant to be used for testing purposes.

Elasticsearch (elasticsearch_output)

The Elasticsearch (elasticsearch_output) output plugin writes to Elasticsearch via HTTP using Elastic. Currently it only supports Elasticsearch 5.x series.

File (file)

The File (file) output plugin writes Telegraf metrics to files.

Graphite (graphite_output)

The Graphite (graphite_output) output plugin writes to Graphite via raw TCP.

Graylog (graylog_output)

The Graylog (graylog_output) output plugin writes to a Graylog instance using the gelf format.

InfluxDB (influxdb_output)

The InfluxDB (influxdb_output) output plugin writes to InfluxDB using HTTP or UDP.

Instrumental (instrumental_output)

The Instrumental (instrumental_output) output plugin writes to the Instrumental Collector API and requires a Project-specific API token.

Instrumental accepts stats in a format very close to Graphite, with the only difference being that the type of stat (gauge, increment) is the first token, separated from the metric itself by whitespace. The increment type is only used if the metric comes in as a counter through [[input.statsd]].

Kafka (kafka_output)

The Kafka (kafka_output) output plugin writes to a Kafka Broker acting a Kafka Producer.

Kinesis (kinesis_output)

The Kinesis (kinesis_output) output plugin is an experimental plugin that is still in the early stages of development. It will batch up all of the Points in one Put request to Kinesis. This should save the number of API requests by a considerable level.

Librato (librato_output)

The Librato (librato_output) output plugin writes to the Librato Metrics API and requires an api_user and api_token which can be obtained here for the account.

MQTT (mqtt_output)

The MQTT (mqtt_output) output plugin writes to the MQTT server using supported output data formats.

NATS Output (nats_output)

The NATS Output (nats_output) output plugin writes to a (list of) specified NATS instance(s).

NSQ (nsq_output)

The NSQ (nsq_output) output plugin writes to a specified NSQD instance, usually local to the producer. It requires a server name and a topic name.

OpenTSDB (opentsdb_output)

The OpenTSDB (opentsdb_output) output plugin writes to an OpenTSDB instance using either the telnet or HTTP mode.

Using the HTTP API is the recommended way of writing metrics since OpenTSDB 2.0 To use HTTP mode, set useHttp to true in config. You can also control how many metrics are sent in each HTTP request by setting batchSize in config. See http://opentsdb.net/docs/build/html/api_http/put.html for details.

Prometheus Client (prometheus_client_output)

The Prometheus Client (prometheus_client_output) output plugin starts a Prometheus Client, it exposes all metrics on /metrics (default) to be polled by a Prometheus server.

Riemann (riemann_output)

The Riemann (riemann_output) output plugin writes to Riemann using TCP or UDP.

Riemann Legacy (riemann_legacy_output)

The Riemann Legacy (riemann_legacy_output) output plugin will be deprecated in a future release, see https://github.com/influxdata/telegraf/issues/1878 for more details & discussion.

Socket Writer (socket_writer_output)

The Socket Writer (socket_writer_output) output plugin writes to a UDP, TCP, or UNIX socket. It can output data in any of the supported output formats.

Wavefront (wavefront) – NEW in v1.5

The Wavefront (wavefront) output plugin writes to a Wavefront proxy, in Wavefront data format over TCP.