Documentation

telegraf config create

The telegraf config create command returns a full Telegraf configuration containing all plugins as an example. You can also apply section or plugin filters to reduce the output to the plugins you need.

Usage

telegraf [global-flags] config create [flags]

Flags

FlagDescription
--section-filterFilter sections to print separated by : (Valid values are agent, global_tags, outputs, processors, aggregators and inputs)
--input-filterFilter inputs to enable separated by :
--output-filterFilter outputs to enable separated by :
--aggregator-filterFilter aggregators to enable separated by :
--processor-filterFilter processors to enable separated by :
--secretstore-filterFilter secret-stores to enable separated by :
-h--helpShow command help

Examples

Create a full configuration

telegraf config create

Create a full configuration as save it to a file

telegraf config create > 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 create \
  --section-filter "inputs:outputs" \
  --input-filter "modbus" \
  --output-filter "influxdb_v2"

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: