content/telegraf/v1/commands/_index.md
The telegraf command starts and runs all the processes necessary for Telegraf to function.
telegraf [commands]
telegraf [flags]
| Command | Description |
|---|---|
| config | Generate and migrate Telegraf configurations |
| secrets | Manage secrets in secret stores |
| plugins | Print available plugins |
| version | Print current version to stdout |
| Flag | Description |
|---|---|
--config <file> | Configuration file to load. |
--config-directory <directory> | Directory containing additional *.conf files. |
--test-wait | Number of seconds to wait for service inputs to complete in test or once mode. |
--usage <plugin> | Print plugin usage (example: telegraf --usage mysql). |
--pprof-addr <address> | pprof address to listen on. Disabled by default. |
--watch-config | Restart Telegraf on local configuration changes. Use either fs notifications (notify) or polling (poll). Disabled by default. |
--pidfile <file> | File to write PID to. |
--password <password> | Password to unlock secret stores. |
--old-env-behavior | Switch back to pre-v1.27 environment replacement behavior. |
--once | Gather metrics once, write them, and exit. |
--debug | Enable debug logging. |
--quiet | Run in quiet mode. |
--unprotected | Do not protect secrets in memory. |
--test | Gather metrics once and print them. |
--deprecation-list | Print all deprecated plugins or plugin options. |
--input-list | Print available input plugins. |
--output-list | Print available output plugins. |
--version | ({{< req "Deprecated" >}}) Print Telegraf version. |
--sample-config | ({{< req "Deprecated" >}}) Print full sample configuration. |
--plugin-directory <directory> | ({{< req "Deprecated" >}}) Directory containing *.so files to search recursively for plugins. Found plugins are loaded, tagged, and identified. |
--section-filter <filter> | Filter configuration sections to output (agent, global_tags, outputs, processors, aggregators and inputs). Separator is :. |
--input-filter <filter> | Filter input plugins to enable. Separator is :. |
--output-filter | Filter output plugins to enable. Separator is :. |
--aggregator-filter <filter> | Filter aggregators to enable. Separator is :. |
--processor-filter <filter> | Filter processor plugins to enable. Separator is :. |
--secretstore-filter <filter> | Filter secretstore plugins to enable. Separator is :. |
telegraf config > telegraf.conf
telegraf config \
--input-filter cpu \
--output-filter influxdb
telegraf --config telegraf.conf --test
telegraf --config telegraf.conf
telegraf \
--config telegraf.conf \
--input-filter cpu:mem \
--output-filter influxdb
telegraf \
--config telegraf.conf \
--pprof-addr localhost:6060