Documentation

Telegraf commands and flags

The telegraf command starts and runs all the processes necessary for Telegraf to function.

Usage

telegraf [commands]
telegraf [flags]

Commands

CommandDescription
configPrint out full sample configuration to stdout.
versionPrint version to stdout.

Flags

FlagDescription
--aggregator-filter <filter>Filter aggregators to enable. Separator is :.
--config <file>Configuration file to load.
--config-directory <directory>Directory containing additional *.conf files.
--deprecation-listPrint all deprecated plugins or plugin options.
--watch-configRestart Telegraf on local configuration changes. Use either fs notifications (inotify) or polling (poll). Disabled by default
--plugin-directory <directory>Directory containing *.so files to search recursively for plugins. Found plugins are loaded, tagged, and identified.
--debugEnable debug logging.
--input-filter <filter>Filter input plugins to enable. Separator is :.
--input-listPrint available input plugins.
--output-filterFilter output plugins to enable. Separator is :.
--output-listPrint available output plugins.
--pidfile <file>File to write PID to.
--pprof-addr <address>pprof address to listen on. Disabled by default.
--processor-filter <filter>Filter processor plugins to enable. Separator is :.
--quietRun in quiet mode.
--section-filter <filter>Filter configuration sections to output (agent, global_tags, outputs, processors, aggregators and inputs). Separator is :.
--sample-configPrint full sample configuration.
--onceGather metrics once, write them, and exit.
--testGather metrics once and print them.
--test-waitNumber of seconds to wait for service inputs to complete in test or once mode.
--usage <plugin>Print plugin usage (example: telegraf --usage mysql).
--versionPrint Telegraf version.

Examples

Generate a Telegraf configuration file

telegraf config > telegraf.conf

Generate configuration with only CPU input and InfluxDB output plugins defined

telegraf --input-filter cpu --output-filter influxdb config

Run a single Telegraf configuration, outputting metrics to stdout

telegraf --config telegraf.conf --test

Run Telegraf with all plugins defined in configuration file**

telegraf --config telegraf.conf

Run Telegraf, enabling the CPU and memory input plugins and InfluxDB output plugin**

telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb

Run Telegraf with pprof

telegraf --config telegraf.conf --pprof-addr localhost:6060

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

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:

State of the InfluxDB Cloud Serverless documentation

InfluxDB Cloud Serverless documentation is a work in progress.

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.