Create a Telegraf configuration
Telegraf Controller is in Private Alpha
Telegraf Controller is in private alpha. If you are interested in being a part of the private alpha program, please sign up:
While in alpha, Telegraf Controller is not meant for production use. The Telegraf Controller documentation is a work in progress, and we are actively working to improve it. If you have any questions or suggestions, please submit an issue. We welcome any and all contributions.
Create a configuration to define how Telegraf collects, processes, and writes metrics. Telegraf Controller stores the configuration as TOML that you can use across agents. Upload existing configurations, write raw TOML in the Code Editor, or use the Telegraf Builder visual interface to manage and configure plugins.
Create a configuration
- In the Telegraf Controller web interface, select Configurations in the navigation bar.
- Click Add Config.
- Enter a configuration name and optional description.
- Use the Telegraf Controller Code Editor or Telegraf Builder to provide or build the Telegraf configuration TOML.
- Click Create Configuration.
Use the Code Editor
The Telegraf Controller Code Editor is an in-browser TOML editor that lets you upload or manually write Telegraf configuration TOML.
For detailed information about using the Code Editor, see Use the Code Editor.

Use the Telegraf Builder
The Telegraf Builder is a visual interface for adding and configuring Telegraf plugins in a Telegraf configuration.
For detailed information about using the Telegraf Builder, see Use the Telegraf Builder.

The Telegraf Builder does not support all Telegraf plugins
We are in the process of adding support for more Telegraf plugins in the Telegraf Builder. You can use plugins that are not currently supported by the builder, but you must add and edit them with the Code Editor.
Heartbeat output plugin
When adding a configuration, Telegraf Controller prepopulates the configuration with a Telegraf heartbeat output plugin. This plugin reports agent information back to the Telegraf Controller heartbeat API and lets you monitor the health of your deployed Telegraf agents.
[[outputs.heartbeat]]
url = "http://localhost:8000/agents/heartbeat"
instance_id = "&{agent_id}"
interval = "1m"
include = ["hostname", "statistics", "configs"]To monitor agents with Telegraf Controller, include a heartbeat plugin in your Telegraf configurations.
Next steps
- Use dynamic values to keep configurations portable across environments.
- Apply the configuration to your Telegraf agents.
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 Telegraf and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.