Back to Influxdb

telegraf config

content/telegraf/v1/commands/config/_index.md

latest3.3 KB
Original Source

The telegraf config command generates Telegraf configuration files and migrates deprecated plugins in configuration files.

Usage

sh
telegraf [global-flags] config [subcommand] [flags]

Subcommands

SubcommandDescription
create <em class="op50">(default)</em>Create and output a Telegraf configuration
migrateMigrate deprecated plugins to supported plugins
help, hShow command help

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

{{% caption %}} Also see Telegraf global flags. {{% /caption %}}

Examples

Create a full configuration

sh
telegraf config

Create a full configuration as save it to a file

sh
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:

sh
telegraf config \
  --section-filter "inputs:outputs" \
  --input-filter "modbus" \
  --output-filter "influxdb_v2"