Documentation

telegraf config

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

Usage

telegraf [global-flags] config [subcommand] [flags]
  • Copy
  • Fill window

Subcommands

SubcommandDescription
create (default)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

Examples

Create a full configuration

telegraf config
  • Copy
  • Fill window

Create a full configuration as save it to a file

telegraf config > telegraf.conf
  • Copy
  • Fill window

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"
  • Copy
  • Fill window

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.

Read more

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: