Configure Telegraf for InfluxDB

Use the Telegraf influxdb_v2 output plugin to collect and write metrics to {{< product-name >}}. Learn how to enable the plugin in new and existing Telegraf configurations, and then start Telegraf using the custom configuration file.

[!Note] View the requirements for using Telegraf with {{< product-name >}}.

• Configure Telegraf input and output plugins
  • Add Telegraf plugins
  • Enable and configure the InfluxDB v2 output plugin
    • urls
    • token
    • organization
    • bucket
    • Write to InfluxDB v1.x and {{< product-name >}}
  • Other Telegraf configuration options
• Start Telegraf

Configure Telegraf input and output plugins

Configure Telegraf input and output plugins in the Telegraf configuration file (typically named telegraf.conf). Input plugins collect metrics. Output plugins define destinations where metrics are sent.

This guide assumes you followed Setup instructions in the Get Started tutorial to set up InfluxDB and configure authentication credentials.

Add Telegraf plugins

To add any of the available Telegraf plugins, follow the steps below.

1. Find the plugin you want to enable from the complete list of available Telegraf plugins.
2. Click View to the right of the plugin name to open the plugin page on GitHub. For example, view the MQTT plugin GitHub page.
3. Copy and paste the example configuration into your Telegraf configuration file (typically named telegraf.conf).

Enable and configure the InfluxDB v2 output plugin

To send data to {{< product-name >}}, enable the influxdb_v2 output plugin in the telegraf.conf.

{{% code-placeholders "DATABASE_NAME" %}}

[[outputs.influxdb_v2]]
  urls = ["https://{{< influxdb/host >}}"]
  # INFLUX_TOKEN is an environment variable you created for your database WRITE token

  token = "${INFLUX_TOKEN}"
  organization = ""
  bucket = "DATABASE_NAME"

{{% /code-placeholders %}}

Replace the following:

• DATABASE_NAME: the name of the InfluxDB database to write data to

The InfluxDB output plugin configuration contains the following options:

urls

An array of URL strings. To write to {{% product-name %}}, include your {{% product-name omit=" Clustered" %}} cluster URL using the HTTPS protocol:

["https://{{< influxdb/host >}}"]

token

Your {{% product-name %}} database token with write permission to the database.

In the examples, INFLUX_TOKEN is an environment variable assigned to a database token that has write permission to the database.

organization

For {{% product-name %}}, set this to an empty string ("").

bucket

The name of the {{% product-name %}} database to write data to.

[!Note]

Write to InfluxDB v1.x and {{% product-name %}}

If a Telegraf agent is already writing to an InfluxDB v1.x database, enabling the InfluxDB v2 output plugin will write data to both v1.x and your {{< product-name omit="Clustered" >}} cluster.

Other Telegraf configuration options

influx_uint_support: supported in InfluxDB 3.

For more plugin options, see influxdb on GitHub.

Start Telegraf

Start the Telegraf service using the --config flag to specify the location of your telegraf.conf.

telegraf --config /path/to/custom/telegraf.conf