telegraf config
The telegraf config command generates Telegraf configuration files and migrates deprecated plugins in configuration files.
Usage
telegraf [global-flags] config [subcommand] [flags]
Subcommands
| Subcommand | Description |
|---|---|
| create (default) | Create and output a Telegraf configuration |
| migrate | Migrate deprecated plugins to supported plugins |
| help, h | Show command help |
Flags
| Flag | Description | |
|---|---|---|
--section-filter |
Filter sections to print separated by : (Valid values are agent, global_tags, outputs, processors, aggregators and inputs) |
|
--input-filter |
Filter inputs to enable separated by : |
|
--output-filter |
Filter outputs to enable separated by : |
|
--aggregator-filter |
Filter aggregators to enable separated by : |
|
--processor-filter |
Filter processors to enable separated by : |
|
--secretstore-filter |
Filter secret-stores to enable separated by : |
|
-h |
--help |
Show command help |
Also see Telegraf global flags.
Examples
- Create a full configuration
- Create a full configuration as save it to a file
- Create a configuration with specific sections and plugins
Create a full configuration
telegraf config
Create a full configuration as save it to a file
telegraf config > telegraf.conf
Create a configuration with specific sections and plugins
To print a configuration containing only a Modbus input plugin and an InfluxDB v2 output plugin, run the following:
telegraf config \
--section-filter "inputs:outputs" \
--input-filter "modbus" \
--output-filter "influxdb_v2"
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.