InfluxDB Docs

Automatically configure Telegraf

The InfluxDB user interface (UI) can automatically create 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.

Only a subset of plugins are configurable using the InfluxDB UI. To use plugins other than those listed, you must manually configure Telegraf.

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

Create a Telegraf configuration

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

  3. Select Telegrafs.

  4. Click Create Configuration.

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

  6. Select one or more of the available plugin groups and click Continue.

  7. 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.

  8. Provide a Telegraf Configuration Name and an optional Telegraf Configuration Description.

  9. Click Create and Verify.

  10. 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.

  11. Once Telegraf is running, click Listen for Data to confirm Telegraf is successfully sending data to InfluxDB. Once confirmed, a Connection Found! message appears.

  12. Click Finish. Your Telegraf configuration name and the associated bucket name appears in the list of Telegraf configurations.

    Windows

    If you plan to monitor a Windows host using the System plugin, you must complete the following steps.

    1. In the list of Telegraf configurations, double-click your Telegraf configuration, and then click Download Config.
    2. Open the downloaded Telegraf configuration file and replace the [[inputs.processes]] plugin with one of the following Windows plugins, depending on your Windows configuration:

    3. Save the file and place it in a directory that telegraf.exe can access.

Start Telegraf

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

Configure your token as an environment variable

  1. Find your authentication token. For information about viewing tokens, see View tokens.

  2. To configure your token as the INFLUX_TOKEN environment variable, run the command appropriate for your operating system and command-line tool:

export INFLUX_TOKEN=YourAuthenticationToken
$env:INFLUX_TOKEN = “YourAuthenticationToken"
set INFLUX_TOKEN=YourAuthenticationToken 
# Make sure to include a space character at the end of this command.

Start the Telegraf service

Start the Telegraf service using the -config flag to specify the location of the generated Telegraf configuration file.

  • For Windows, the location is always a local file path.
  • For Linux and macOS, the location can be a local file path or URL.

Telegraf starts using the Telegraf configuration pulled from InfluxDB API.

InfluxDB host URLs and ports differ between InfluxDB OSS and InfluxDB Cloud. For the exact command, see the Telegraf configuration Setup Instructions in the InfluxDB UI.

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

Manage Telegraf configurations

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