diff --git a/etc/telegraf.conf b/etc/telegraf.conf index e071ea8c1..adbb136de 100644 --- a/etc/telegraf.conf +++ b/etc/telegraf.conf @@ -1368,24 +1368,41 @@ # # Configuration for MQTT server to send metrics to # [[outputs.mqtt]] -# servers = ["localhost:1883"] # required. +# ## MQTT Brokers +# ## The list of brokers should only include the hostname or IP address and the +# ## port to the broker. This should follow the format '{host}:{port}'. For +# ## example, "localhost:1883" or "127.0.0.1:8883". +# servers = ["localhost:1883"] # -# ## MQTT outputs send metrics to this topic format -# ## "///" -# ## ex: prefix/web01.example.com/mem +# ## MQTT Topic for Producer Messages +# ## MQTT outputs send metrics to this topic format: +# ## /// (e.g. prefix/web01.example.com/mem) # topic_prefix = "telegraf" # # ## QoS policy for messages +# ## The mqtt QoS policy for sending messages. +# ## See https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.dev.doc/q029090_.htm # ## 0 = at most once # ## 1 = at least once # ## 2 = exactly once # # qos = 2 # +# ## Keep Alive +# ## Defines the maximum length of time that the broker and client may not +# ## communicate. Defaults to 0 which turns the feature off. +# ## +# ## For version v2.0.12 and later mosquitto there is a bug +# ## (see https://github.com/eclipse/mosquitto/issues/2117), which requires +# ## this to be non-zero. As a reference eclipse/paho.mqtt.golang defaults to 30. +# # keep_alive = 0 +# # ## username and password to connect MQTT server. # # username = "telegraf" # # password = "metricsmetricsmetricsmetrics" # -# ## client ID, if not set a random ID is generated +# ## client ID +# ## The unique client id to connect MQTT server. If this parameter is not set +# ## then a random ID is generated. # # client_id = "" # # ## Timeout for write operations. default: 5s @@ -1395,10 +1412,11 @@ # # tls_ca = "/etc/telegraf/ca.pem" # # tls_cert = "/etc/telegraf/cert.pem" # # tls_key = "/etc/telegraf/key.pem" +# # ## Use TLS but skip chain & host verification # # insecure_skip_verify = false # -# ## When true, metrics will be sent in one MQTT message per flush. Otherwise, +# ## When true, metrics will be sent in one MQTT message per flush. Otherwise, # ## metrics are written one metric per MQTT message. # # batch = false # @@ -1406,13 +1424,6 @@ # ## actually reads it # # retain = false # -# ## Defines the maximum length of time that the broker and client may not communicate. -# ## Defaults to 0 which turns the feature off. For version v2.0.12 of eclipse/mosquitto there is a -# ## [bug](https://github.com/eclipse/mosquitto/issues/2117) which requires keep_alive to be set. -# ## As a reference eclipse/paho.mqtt.golang v1.3.0 defaults to 30. -# # keep_alive = 0 -# -# ## Data format to output. # ## Each data format has its own unique set of configuration options, read # ## more about them here: # ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md @@ -8892,9 +8903,6 @@ # ## Path to mib files # # path = ["/usr/share/snmp/mibs"] # ## -# ## Deprecated in 1.20.0; no longer running snmptranslate -# ## Timeout running snmptranslate command -# # timeout = "5s" # ## Snmp version, defaults to 2c # # version = "2c" # ## SNMPv3 authentication and encryption options. diff --git a/etc/telegraf_windows.conf b/etc/telegraf_windows.conf index 1f5b009d6..058d0a3db 100644 --- a/etc/telegraf_windows.conf +++ b/etc/telegraf_windows.conf @@ -1368,24 +1368,41 @@ # # Configuration for MQTT server to send metrics to # [[outputs.mqtt]] -# servers = ["localhost:1883"] # required. +# ## MQTT Brokers +# ## The list of brokers should only include the hostname or IP address and the +# ## port to the broker. This should follow the format '{host}:{port}'. For +# ## example, "localhost:1883" or "127.0.0.1:8883". +# servers = ["localhost:1883"] # -# ## MQTT outputs send metrics to this topic format -# ## "///" -# ## ex: prefix/web01.example.com/mem +# ## MQTT Topic for Producer Messages +# ## MQTT outputs send metrics to this topic format: +# ## /// (e.g. prefix/web01.example.com/mem) # topic_prefix = "telegraf" # # ## QoS policy for messages +# ## The mqtt QoS policy for sending messages. +# ## See https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.dev.doc/q029090_.htm # ## 0 = at most once # ## 1 = at least once # ## 2 = exactly once # # qos = 2 # +# ## Keep Alive +# ## Defines the maximum length of time that the broker and client may not +# ## communicate. Defaults to 0 which turns the feature off. +# ## +# ## For version v2.0.12 and later mosquitto there is a bug +# ## (see https://github.com/eclipse/mosquitto/issues/2117), which requires +# ## this to be non-zero. As a reference eclipse/paho.mqtt.golang defaults to 30. +# # keep_alive = 0 +# # ## username and password to connect MQTT server. # # username = "telegraf" # # password = "metricsmetricsmetricsmetrics" # -# ## client ID, if not set a random ID is generated +# ## client ID +# ## The unique client id to connect MQTT server. If this parameter is not set +# ## then a random ID is generated. # # client_id = "" # # ## Timeout for write operations. default: 5s @@ -1395,10 +1412,11 @@ # # tls_ca = "/etc/telegraf/ca.pem" # # tls_cert = "/etc/telegraf/cert.pem" # # tls_key = "/etc/telegraf/key.pem" +# # ## Use TLS but skip chain & host verification # # insecure_skip_verify = false # -# ## When true, metrics will be sent in one MQTT message per flush. Otherwise, +# ## When true, metrics will be sent in one MQTT message per flush. Otherwise, # ## metrics are written one metric per MQTT message. # # batch = false # @@ -1406,13 +1424,6 @@ # ## actually reads it # # retain = false # -# ## Defines the maximum length of time that the broker and client may not communicate. -# ## Defaults to 0 which turns the feature off. For version v2.0.12 of eclipse/mosquitto there is a -# ## [bug](https://github.com/eclipse/mosquitto/issues/2117) which requires keep_alive to be set. -# ## As a reference eclipse/paho.mqtt.golang v1.3.0 defaults to 30. -# # keep_alive = 0 -# -# ## Data format to output. # ## Each data format has its own unique set of configuration options, read # ## more about them here: # ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md @@ -8760,9 +8771,6 @@ # ## Path to mib files # # path = ["/usr/share/snmp/mibs"] # ## -# ## Deprecated in 1.20.0; no longer running snmptranslate -# ## Timeout running snmptranslate command -# # timeout = "5s" # ## Snmp version, defaults to 2c # # version = "2c" # ## SNMPv3 authentication and encryption options.