From 7b23287e20908dcc43a04bccd971e94eb13aa691 Mon Sep 17 00:00:00 2001
From: Daniel Nelson <daniel.nelson@influxdb.com>
Date: Mon, 2 Apr 2018 14:40:51 -0700
Subject: [PATCH] Update sample telegraf.conf
---
etc/telegraf.conf | 129 +++++++++++++++++++++++++++++++++++-----------
1 file changed, 100 insertions(+), 29 deletions(-)
diff --git a/etc/telegraf.conf b/etc/telegraf.conf
index 8b78ed33..da826a1c 100644
--- a/etc/telegraf.conf
+++ b/etc/telegraf.conf
@@ -82,31 +82,42 @@
# OUTPUT PLUGINS #
###############################################################################
-# Configuration for influxdb server to send metrics to
+# Configuration for sending metrics to InfluxDB
[[outputs.influxdb]]
## The full HTTP or UDP URL for your InfluxDB instance.
##
- ## Multiple urls can be specified as part of the same cluster,
- ## this means that only ONE of the urls will be written to each interval.
- # urls = ["udp://127.0.0.1:8089"] # UDP endpoint example
- urls = ["http://127.0.0.1:8086"] # required
- ## The target database for metrics (telegraf will create it if not exists).
- database = "telegraf" # required
+ ## Multiple URLs can be specified for a single cluster, only ONE of the
+ ## urls will be written to each interval.
+ # urls = ["unix:///var/run/influxdb.sock"]
+ # urls = ["udp://127.0.0.1:8089"]
+ # urls = ["http://127.0.0.1:8086"]
+
+ ## The target database for metrics; will be created as needed.
+ # database = "telegraf"
+
+ ## If true, no CREATE DATABASE queries will be sent. Set to true when using
+ ## Telegraf with a user without permissions to create databases or when the
+ ## database already exists.
+ # skip_database_creation = false
## Name of existing retention policy to write to. Empty string writes to
## the default retention policy.
- retention_policy = ""
+ # retention_policy = ""
+
## Write consistency (clusters only), can be: "any", "one", "quorum", "all"
- write_consistency = "any"
+ # write_consistency = "any"
- ## Write timeout (for the InfluxDB client), formatted as a string.
- ## If not provided, will default to 5s. 0s means no timeout (not recommended).
- timeout = "5s"
+ ## Timeout for HTTP messages.
+ # timeout = "5s"
+
+ ## HTTP Basic Auth
# username = "telegraf"
# password = "metricsmetricsmetricsmetrics"
- ## Set the user agent for HTTP POSTs (can be useful for log differentiation)
+
+ ## HTTP User-Agent
# user_agent = "telegraf"
- ## Set UDP payload size, defaults to InfluxDB UDP Client default (512 bytes)
+
+ ## UDP payload size is the maximum packet size to send.
# udp_payload = 512
## Optional SSL Config
@@ -116,14 +127,22 @@
## Use SSL but skip chain & host verification
# insecure_skip_verify = false
- ## HTTP Proxy Config
+ ## HTTP Proxy override, if unset values the standard proxy environment
+ ## variables are consulted to determine which proxy, if any, should be used.
# http_proxy = "http://corporate.proxy:3128"
- ## Optional HTTP headers
+ ## Additional HTTP headers
# http_headers = {"X-Special-Header" = "Special-Value"}
- ## Compress each HTTP request payload using GZIP.
- # content_encoding = "gzip"
+ ## HTTP Content-Encoding for write request body, can be set to "gzip" to
+ ## compress body or "identity" to apply no encoding.
+ # content_encoding = "identity"
+
+ ## When true, Telegraf will output unsigned integers as unsigned values,
+ ## i.e.: "42u". You will need a version of InfluxDB supporting unsigned
+ ## integer values. Enabling this option will result in field type errors if
+ ## existing data has been written.
+ # influx_uint_support = false
# # Configuration for Amon Server to send metrics to.
@@ -1087,19 +1106,28 @@
# # Gather health check statuses from services registered in Consul
# [[inputs.consul]]
-# ## Most of these values defaults to the one configured on a Consul's agent level.
-# ## Optional Consul server address (default: "localhost")
+# ## Consul server address
# # address = "localhost"
-# ## Optional URI scheme for the Consul server (default: "http")
+#
+# ## URI scheme for the Consul server, one of "http", "https"
# # scheme = "http"
-# ## Optional ACL token used in every request (default: "")
+#
+# ## ACL token used in every request
# # token = ""
-# ## Optional username used for request HTTP Basic Authentication (default: "")
+#
+# ## HTTP Basic Authentication username and password.
# # username = ""
-# ## Optional password used for HTTP Basic Authentication (default: "")
# # password = ""
-# ## Optional data centre to query the health checks from (default: "")
+#
+# ## Data centre to query the health checks from
# # datacentre = ""
+#
+# ## SSL Config
+# # ssl_ca = "/etc/telegraf/ca.pem"
+# # ssl_cert = "/etc/telegraf/cert.pem"
+# # ssl_key = "/etc/telegraf/key.pem"
+# ## If false, skip chain & host verification
+# # insecure_skip_verify = true
# # Read metrics from one or many couchbase clusters
@@ -1222,6 +1250,11 @@
# container_name_include = []
# container_name_exclude = []
#
+# ## Container states to include and exclude. Globs accepted.
+# ## When empty only containers in the "running" state will be captured.
+# # container_state_include = []
+# # container_state_exclude = []
+#
# ## Timeout for docker list, info, and stats commands
# timeout = "5s"
#
@@ -1291,7 +1324,7 @@
#
# ## node_stats is a list of sub-stats that you want to have gathered. Valid options
# ## are "indices", "os", "process", "jvm", "thread_pool", "fs", "transport", "http",
-# ## "breakers". Per default, all stats are gathered.
+# ## "breaker". Per default, all stats are gathered.
# # node_stats = ["jvm", "http"]
#
# ## Optional SSL Config
@@ -1790,6 +1823,13 @@
#
# ## Time limit for http requests
# timeout = "5s"
+#
+# ## Optional SSL Config
+# # ssl_ca = "/etc/telegraf/ca.pem"
+# # ssl_cert = "/etc/telegraf/cert.pem"
+# # ssl_key = "/etc/telegraf/key.pem"
+# ## Use SSL but skip chain & host verification
+# # insecure_skip_verify = false
# # Get kernel statistics from /proc/vmstat
@@ -1941,6 +1981,20 @@
# #
# ## If no servers are specified, then localhost is used as the host.
# servers = ["tcp(127.0.0.1:3306)/"]
+#
+# ## Selects the metric output format.
+# ##
+# ## This option exists to maintain backwards compatibility, if you have
+# ## existing metrics do not set or change this value until you are ready to
+# ## migrate to the new format.
+# ##
+# ## If you do not have existing metrics from this plugin set to the latest
+# ## version.
+# ##
+# ## Telegraf >=1.6: metric_version = 2
+# ## <1.6: metric_version = 1 (or unset)
+# metric_version = 2
+#
# ## the limits for metrics form perf_events_statements
# perf_events_statements_digest_text_limit = 120
# perf_events_statements_limit = 250
@@ -2013,6 +2067,12 @@
# ## regardless of status.
# ##
# # interfaces = ["eth0"]
+# ##
+# ## On linux systems telegraf also collects protocol stats.
+# ## Setting ignore_protocol_stats to true will skip reporting of protocol metrics.
+# ##
+# # ignore_protocol_stats = false
+# ##
# # TCP or UDP 'ping' given url and collect response time in seconds
@@ -2624,7 +2684,7 @@
# ## - MemoryClerk
# ## - VolumeSpace
# ## - PerformanceMetrics
-# # exclude_query = [ 'PerformanceCounters','WaitStatsCatagorized' ]
+# # exclude_query = [ 'DatabaseIO' ]
# # Sysstat metrics collector
@@ -2797,6 +2857,17 @@
# ## If no servers are specified, then localhost is used as the host.
# ## If no port is specified, 2181 is used
# servers = [":2181"]
+#
+# ## Timeout for metric collections from all servers. Minimum timeout is "1s".
+# # timeout = "5s"
+#
+# ## Optional SSL Config
+# # enable_ssl = true
+# # ssl_ca = "/etc/telegraf/ca.pem"
+# # ssl_cert = "/etc/telegraf/cert.pem"
+# # ssl_key = "/etc/telegraf/key.pem"
+# ## If false, skip chain & host verification
+# # insecure_skip_verify = true
@@ -2865,8 +2936,8 @@
#
# ## Optional username and password to accept for HTTP basic authentication.
# ## You probably want to make sure you have TLS configured above for this.
-# basic_username = "foobar"
-# basic_password = "barfoo"
+# # basic_username = "foobar"
+# # basic_password = "barfoo"
# # Read metrics from Kafka topic(s)
--
GitLab