{"id":26216,"date":"2021-12-29T06:41:32","date_gmt":"2021-12-29T06:41:32","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=26216"},"modified":"2022-03-04T12:52:43","modified_gmt":"2022-03-04T12:52:43","slug":"telegraf-command-line-options","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/telegraf-command-line-options\/","title":{"rendered":"telegraf command line options"},"content":{"rendered":"<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-1\" data-shcb-language-name=\"PHP\" data-shcb-language-slug=\"php\"><span><code class=\"hljs language-php\">C:\\Program Files\\InfluxData\\telegraf<span class=\"hljs-number\">-1.21<\/span><span class=\"hljs-number\">.1<\/span>_windows_amd64\\telegraf<span class=\"hljs-number\">-1.21<\/span><span class=\"hljs-number\">.1<\/span>&gt;telegraf --help\r\nTelegraf, The plugin-driven server agent <span class=\"hljs-keyword\">for<\/span> collecting <span class=\"hljs-keyword\">and<\/span> reporting metrics.\r\n\r\nUsage:\r\n\r\n  telegraf &#91;commands|flags]\r\n\r\nThe commands &amp; flags are:\r\n\r\n  config              <span class=\"hljs-keyword\">print<\/span> out full sample configuration to stdout\r\n  version             <span class=\"hljs-keyword\">print<\/span> the version to stdout\r\n\r\n  --aggregator-filter &lt;filter&gt;   filter the aggregators to enable, separator is :\r\n  --config &lt;file&gt;                configuration file to load\r\n  --config-directory &lt;directory&gt; directory containing additional *.conf files\r\n  --watch-config                 Telegraf will restart on local config changes. Monitor changes\r\n                                 using either fs notifications <span class=\"hljs-keyword\">or<\/span> polling.  Valid values: <span class=\"hljs-string\">'inotify'<\/span> <span class=\"hljs-keyword\">or<\/span> <span class=\"hljs-string\">'poll'<\/span>.\r\n                                 Monitoring is off by <span class=\"hljs-keyword\">default<\/span>.\r\n  --debug                        turn on debug logging\r\n  --input-filter &lt;filter&gt;        filter the inputs to enable, separator is :\r\n  --input-<span class=\"hljs-keyword\">list<\/span>                   <span class=\"hljs-keyword\">print<\/span> available input plugins.\r\n  --output-filter &lt;filter&gt;       filter the outputs to enable, separator is :\r\n  --output-<span class=\"hljs-keyword\">list<\/span>                  <span class=\"hljs-keyword\">print<\/span> available output plugins.\r\n  --pidfile &lt;file&gt;               file to write our pid to\r\n  --pprof-addr &lt;address&gt;         pprof address to listen on, don<span class=\"hljs-string\">'t activate pprof if empty\r\n  --processor-filter &lt;filter&gt;    filter the processors to enable, separator is :\r\n  --quiet                        run in quiet mode\r\n  --sample-config                print out full sample configuration\r\n  --section-filter               filter config sections to output, separator is :\r\n                                 Valid values are '<\/span>agent<span class=\"hljs-string\">', '<\/span>global_tags<span class=\"hljs-string\">', '<\/span>outputs<span class=\"hljs-string\">',\r\n                                 '<\/span>processors<span class=\"hljs-string\">', '<\/span>aggregators<span class=\"hljs-string\">' and '<\/span>inputs<span class=\"hljs-string\">'\r\n  --once                         enable once mode: gather metrics once, write them, and exit\r\n  --test                         enable test mode: gather metrics once and print them\r\n  --test-wait                    wait up to this many seconds for service\r\n                                 inputs to complete in test or once mode\r\n  --usage &lt;plugin&gt;               print usage for a plugin, ie, '<\/span>telegraf --usage mysql<span class=\"hljs-string\">'\r\n  --version                      display the version and exit\r\n\r\n  --console                      run as console application (windows only)\r\n  --service &lt;service&gt;            operate on the service (windows only)\r\n  --service-name                 service name (windows only)\r\n  --service-display-name         service display name (windows only)\r\n\r\nExamples:\r\n\r\n  # generate a telegraf config file:\r\n  telegraf config &gt; telegraf.conf\r\n\r\n  # generate config with only cpu input &amp; influxdb output plugins defined\r\n  telegraf --input-filter cpu --output-filter influxdb config\r\n\r\n  # run a single telegraf collection, outputting metrics to stdout\r\n  telegraf --config telegraf.conf --test\r\n\r\n  # run telegraf with all plugins defined in config file\r\n  telegraf --config telegraf.conf\r\n\r\n  # run telegraf, enabling the cpu &amp; memory input, and influxdb output plugins\r\n  telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb\r\n\r\n  # run telegraf with pprof\r\n  telegraf --config telegraf.conf --pprof-addr localhost:6060\r\n\r\n  # run telegraf without service controller\r\n  telegraf --console install --config \"C:\\Program Files\\Telegraf\\telegraf.conf\"\r\n\r\n  # install telegraf service\r\n  telegraf --service install --config \"C:\\Program Files\\Telegraf\\telegraf.conf\"\r\n\r\n  # install telegraf service with custom name\r\n  telegraf --service install --service-name=my-telegraf --service-display-name=\"My Telegraf\"<\/span><\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-1\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">PHP<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">php<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>","protected":false},"excerpt":{"rendered":"","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[2],"tags":[],"class_list":["post-26216","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/26216","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=26216"}],"version-history":[{"count":1,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/26216\/revisions"}],"predecessor-version":[{"id":26217,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/26216\/revisions\/26217"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=26216"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=26216"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=26216"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}