InfluxDB Docs

Automatically configure Telegraf

The InfluxDB user interface (UI) provides a workflow that automatically creates Telegraf configuration files based on user-selected Telegraf plugins. This article describes how to create a Telegraf configuration in the InfluxDB UI and start Telegraf using the generated configuration file.

View the requirements for using Telegraf with InfluxDB v2.0.

Create a Telegraf configuration

  1. Open the InfluxDB UI (default: localhost:9999).
  2. Click Organizations in the left navigation menu.

  3. Click on the name of your organization.

  4. Click the Telegraf tab.

  5. Click Create Configuration.

  6. In the Bucket dropdown, select the bucket where Telegraf will store collected data.

  7. Select one or more of the available plugin groups (e.g. System, Docker, Kubernetes, NGINX, or Redis), and click Continue.

All Telegraf plugins are supported, but only a subset are configurable using the InfluxDB UI. To use plugins other than those listed, you must manually configure Telegraf.

  1. Review the list of Plugins to Configure for configuration requirements. Plugins listed with a require no additional configuration. To configure a plugin or access plugin documentation, click the plugin name.
  2. Provide a Telegraf Configuration Name and an optional Telegraf Configuration Description.
  3. Click Create and Verify.
  4. The Test Your Configuration page provides instructions for how to start Telegraf using the generated configuration. See Start Telegraf below for detailed information about what each step does.
  5. Once Telegraf is running, click Listen for Data to confirm Telegraf is successfully sending data to InfluxDB. Once confirmed, a Connection Found! message appears.
  6. Click Finish. Your configuration name and the associated bucket name appears in the list of Telegraf connections.

Start Telegraf

Configure your API token as an environment variable

Requests to the InfluxDB v2 API must include an authentication token. A token identifies specific permissions to the InfluxDB instance.

Define the INFLUX_TOKEN environment variable using your token. For information about viewing tokens, see View tokens.

export INFLUX_TOKEN=YourAuthenticationToken

Start the Telegraf service

Start the Telegraf service using the -config flag to specify the URL of your generated configuration file. Telegraf starts using the Telegraf configuration pulled from InfluxDB API.

See the configuration Setup Instructions for the exact command.

telegraf -config http://localhost:9999/api/v2/telegrafs/0xoX00oOx0xoX00o

Manage Telegraf configurations

Create, view, and manage Telegraf configurations in the InfluxDB UI.