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
Open the InfluxDB Cloud UI.
In the navigation menu on the left, select Data (Load Data) > Telegraf.
Click Create Configuration.
In the Bucket dropdown, select the bucket where Telegraf will store collected data.
Select one or more of the available plugin groups and click Continue.
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.
Not all available plugins are listed on this screen. For more information on manually configuring additional plugins, see Manually add Telegraf plugins.
Provide a Telegraf Configuration Name and an optional Telegraf Configuration Description.
Click Create and Verify.
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.
Once Telegraf is running, click Listen for Data to confirm Telegraf is successfully sending data to InfluxDB. Once confirmed, a Connection Found! message appears.
Click Finish. Your Telegraf configuration name and the associated bucket name appears in the list of Telegraf configurations.
If you plan to monitor a Windows host using the System plugin, you must complete the following steps.
- In the list of Telegraf configurations, double-click your Telegraf configuration, and then click Download Config.
- Open the downloaded Telegraf configuration file and replace the
[[inputs.processes]]plugin with one of the following Windows plugins, depending on your Windows configuration:
- Save the file and place it in a directory that telegraf.exe can access.
Requests to the InfluxDB v2 API must include an API token. A token identifies specific permissions to the InfluxDB instance.
Configure your token as an environment variable
Find your API token. For information about viewing tokens, see View tokens.
To configure your token as the
INFLUX_TOKENenvironment variable, run the command appropriate for your operating system and command-line tool:
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 https://cloud2.influxdata.com/api/v2/telegrafs/0xoX00oOx0xoX00o
Manage Telegraf configurations
For more information about managing Telegraf configurations in InfluxDB, see Telegraf configurations.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.