Telegraf output plugins

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

Supported Telegraf output plugins

Amazon CloudWatch

Plugin ID: cloudwatch

The Amazon CloudWatch output plugin send metrics to Amazon CloudWatch.

Amazon Kinesis

Plugin ID: kinesis

The Amazon Kinesis output plugin is an experimental plugin that is still in the early stages of development. It will batch up all of the points into one PUT request to Kinesis. This should save the number of API requests by a considerable level.

Amon

Plugin ID: amon

The Amon output plugin writes metrics to an Amon server. For details on the Amon Agent, see Monitoring Agent and requires a apikey and amoninstance URL.

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

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

AMQP

Plugin ID: amqp

The AMQP output plugin writes to an AMQP 0-9-1 exchange, a prominent implementation of the Advanced Message Queuing Protocol (AMQP) protocol being RabbitMQ.

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

Apache Kafka

Plugin ID: kafka

The Apache Kafka output plugin writes to a Kafka Broker acting a Kafka Producer.

CrateDB

Plugin ID: cratedb

The CrateDB output plugin writes to CrateDB, a real-time SQL database for machine data and IoT, using its PostgreSQL protocol.

Datadog

Plugin ID: datadog

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

Discard

Plugin ID: discard

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

Elasticsearch

Plugin ID: elasticsearch

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

File

Plugin ID: file

The File output plugin writes Telegraf metrics to files.

Graphite

Plugin ID: graphite

The Graphite output plugin writes to Graphite via raw TCP.

Graylog

Plugin ID: graylog

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

HTTP

Plugin ID: http

The HTTP output plugin sends metrics in a HTTP message encoded using one of the output data formats. For data_formats that support batching, metrics are sent in batch format.

InfluxDB v1.x

Plugin ID: influxdb

The InfluxDB v1.x output plugin writes to InfluxDB using HTTP or UDP.

InfluxDB v2

Plugin ID: influxdb_v2

The InfluxDB v2 output plugin writes metrics to the InfluxDB 2.0 HTTP service.

Instrumental

Plugin ID: instrumental

The Instrumental 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]].

Librato

Plugin ID: librato

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

Microsoft Azure Application Insights

Plugin ID: application_insights

The Microsoft Azure Application Insights output plugin writes Telegraf metrics to Application Insights (Microsoft Azure).

Microsoft Azure Monitor

Plugin ID: azure_monitor

Note: The Azure Monitor custom metrics service is currently in preview and not available in a subset of Azure regions.

The Microsoft Azure Monitor output plugin sends custom metrics to Microsoft Azure Monitor. Azure Monitor has a metric resolution of one minute. To handle this in Telegraf, the Azure Monitor output plugin automatically aggregates metrics into one minute buckets, which are then sent to Azure Monitor on every flush interval.

For a Microsoft blog posting on using Telegraf with Microsoft Azure Monitor, see Collect custom metrics for a Linux VM with the InfluxData Telegraf Agent.

The metrics from each input plugin will be written to a separate Azure Monitor namespace, prefixed with Telegraf/ by default. The field name for each metric is written as the Azure Monitor metric name. All field values are written as a summarized set that includes min, max, sum, and count. Tags are written as a dimension on each Azure Monitor metric.

MQTT Producer

Plugin ID: mqtt

The MQTT Producer output plugin writes to the MQTT server using supported output data formats.

NATS Output

Plugin ID: nats

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

NSQ

Plugin ID: nsq

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

OpenTSDB

Plugin ID: opentsdb

The OpenTSDB 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

Plugin ID: prometheus_client

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

Riemann

Plugin ID: riemann

The Riemann output plugin writes to Riemann using TCP or UDP.

Socket Writer

Plugin ID: socket_writer

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

Stackdriver

Plugin ID: stackdriver

The Stackdriver output plugin writes to the Google Cloud Stackdriver API and requires Google Cloud authentication with Google Cloud using either a service account or user credentials. For details on pricing, see the Stackdriver documentation.

Requires project to specify where Stackdriver metrics will be delivered to.

Metrics are grouped by the namespace variable and metric key, for example custom.googleapis.com/telegraf/system/load5.

Wavefront

Plugin ID: wavefront

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

Deprecated Telegraf output plugins

Riemann Legacy

Plugin ID: riemann_legacy

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

This documentation is open source. See a typo? Please, open an issue.


Need help getting up and running? Get Support