OS Manuals

/usr/bin/telegraf

Telegraf is an agent for collecting, processing, aggregating, and writing metric

From telegraf-1.36 1.36.4-r19 (enterprise-packages), captured 2026-11-08 by running telegraf --help (exit 0). permalink

NAME:
   Telegraf - The plugin-driven server agent for collecting & reporting metrics.

USAGE:
   Telegraf [global options] command [command options]

COMMANDS:
   version  print current version to stdout
   config   commands for generating and migrating configurations
   secrets  commands for listing, adding and removing secrets on all known secret-stores
   plugins  commands for printing available plugins
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --test-wait value                                      wait up to this many seconds for service inputs to complete in test mode (default: 0)
   --config-url-retry-attempts value                      Number of attempts to obtain a remote configuration via a URL during startup. Set to -1 for unlimited attempts. (default: 3)
   --usage value                                          print usage for a plugin, ie, 'telegraf --usage mysql'
   --pprof-addr value                                     pprof host/IP and port to listen on (e.g. 'localhost:6060')
   --watch-config value                                   monitoring config changes [notify, poll] of --config and --config-directory options. Notify supports linux, *bsd, and macOS. Poll is required for Windows and checks every 250ms.
   --watch-debounce-interval value                        Time duration to wait after a config change before reloading (default: 0s)
   --pidfile value                                        file to write our pid to
   --password value                                       password to unlock secret-stores
   --old-env-behavior                                     switch back to pre v1.27 environment replacement behavior (default: false)
   --strict-env-handling                                  enforces strict and secure handling of environment variables; will not work with non-string settings (default: false)
   --print-plugin-config-source                           print the source for a given plugin (default: false)
   --once                                                 run one gather and exit (default: false)
   --debug                                                turn on debug logging (default: false)
   --quiet                                                run in quiet mode (default: false)
   --unprotected                                          do not protect secrets in memory (default: false)
   --test                                                 enable test mode: gather metrics, print them out, and exit. Note: Test mode only runs inputs, processors, and aggregators, but not outputs (default: false)
   --select value [ --select value ]                      enable only plugins with labels matching the given key-value selection. If no selectors are provided, all plugins are enabled. Multiple key-value pairs in an option will be combined by AND, multiple options are combined by OR. Key and value are separated by an equal sign, multiple pairs are separated by semi-colon, values do accept wildcards.
   --watch-interval value                                 Time duration to check for updates to config files specified by --config and --config-directory options. Use with '--watch-config poll' (default: disabled)
   --config-url-watch-interval value                      Time duration to check for updates to URL based configuration files (default: disabled)
   --deprecation-list                                     print all deprecated plugins or plugin options (default: false)
   --input-list                                           print available input plugins (default: false)
   --output-list                                          print available output plugins (default: false)
   --version                                              DEPRECATED: display the version and exit (default: false)
   --sample-config                                        DEPRECATED: print out full sample configuration (default: false)
   --plugin-directory value                               DEPRECATED: path to directory containing external plugins
   --config value [ --config value ]                      configuration file to load
   --config-directory value [ --config-directory value ]  directory containing additional *.conf files
   --section-filter value                                 filter the sections to print, separator is ':'. Valid values are 'agent', 'global_tags', 'outputs', 'processors', 'aggregators' and 'inputs'
   --input-filter value                                   filter the inputs to enable, separator is ':'
   --output-filter value                                  filter the outputs to enable, separator is ':'
   --aggregator-filter value                              filter the aggregators to enable, separator is ':'
   --processor-filter value                               filter the processors to enable, separator is ':'
   --secretstore-filter value                             filter the secret-stores to enable, separator is ':'
   --help, -h                                             show help
Options (34)
OptionDescriptionSource
--test-wait valuewait up to this many seconds for service inputs to complete in test mode (default: 0)help
--config-url-retry-attempts valueNumber of attempts to obtain a remote configuration via a URL during startup.help
--usage valueprint usage for a plugin, ie, 'telegraf --usage mysql'help
--pprof-addr valuepprof host/IP and port to listen on (e.g. 'localhost:6060')help
--watch-config valuemonitoring config changes [notify, poll] of --config and --config-directory options.help
--watch-debounce-interval valueTime duration to wait after a config change before reloading (default: 0s)help
--pidfile valuefile to write our pid tohelp
--password valuepassword to unlock secret-storeshelp
--old-env-behaviorswitch back to pre v1.27 environment replacement behavior (default: false)help
--strict-env-handlingenforces strict and secure handling of environment variables;help
--print-plugin-config-sourceprint the source for a given plugin (default: false)help
--oncerun one gather and exit (default: false)help
--debugturn on debug logging (default: false)help
--quietrun in quiet mode (default: false)help
--unprotecteddo not protect secrets in memory (default: false)help
--testenable test mode: gather metrics, print them out, and exit.help
--select valueenable only plugins with labels matching the given key-value selection.help
--watch-interval valueTime duration to check for updates to config files specified by --config and --config-directory options.help
--config-url-watch-interval valueTime duration to check for updates to URL based configuration files (default: disabled)help
--deprecation-listprint all deprecated plugins or plugin options (default: false)help
--input-listprint available input plugins (default: false)help
--output-listprint available output plugins (default: false)help
--versionDEPRECATED: display the version and exit (default: false)help
--sample-configDEPRECATED: print out full sample configuration (default: false)help
--plugin-directory valueDEPRECATED: path to directory containing external pluginshelp
--config valueconfiguration file to loadhelp
--config-directory valuedirectory containing additional *.conf fileshelp
--section-filter valuefilter the sections to print, separator is ':'.help
--input-filter valuefilter the inputs to enable, separator is ':'help
--output-filter valuefilter the outputs to enable, separator is ':'help
--aggregator-filter valuefilter the aggregators to enable, separator is ':'help
--processor-filter valuefilter the processors to enable, separator is ':'help
--secretstore-filter valuefilter the secret-stores to enable, separator is ':'help
--help, -hshow helphelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.