From 4b3dede0fb824d36566f1c5c88967cc802d54722 Mon Sep 17 00:00:00 2001 From: James Phillips Date: Sat, 6 Feb 2016 22:07:11 -0800 Subject: [PATCH] Tweaks the telemetry docs. --- .../source/docs/agent/options.html.markdown | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index f59b3bb8d..dd4cd5851 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -575,48 +575,49 @@ definitions support being updated during a reload. * `start_join_wan` An array of strings specifying addresses of WAN nodes to [`-join-wan`](#_join_wan) upon startup. -* `telemetry` An object describing where to send telemetry to +* `telemetry` This is a nested object that configures where Consul + sends its runtime telemetry, and contains the following keys: * `statsd_address` This provides the address of a statsd instance. If provided, Consul will send various telemetry information to that instance for aggregation. This can be used to capture runtime information. This sends UDP packets only and can be used with statsd or statsite. - + * `statsite_address` This provides the address of a statsite instance. If provided, Consul will stream various telemetry information to that instance for aggregation. This can be used to capture runtime information. This streams via TCP and can only be used with statsite. - + * `statsite_prefix` The prefix used while writing all telemetry data to statsite. By default, this is set to "consul". - + * `dogstatsd_addr` This provides the address of a DogStatsD instance in the format `host:port`. DogStatsD is a protocol-compatible flavor of statsd, with the added ability to decorate metrics with tags and event information. If provided, Consul will send various telemetry information to that instance for aggregation. This can be used to capture runtime information. - + * `dogstatsd_tags` This provides a list of global tags that will be added to all telemetry packets sent to DogStatsD. It is a list of strings, where each string looks like "my_tag_name:my_tag_value". - + * `disable_hostname` - Whether or not to prepend runtime telemetry with the machines hostname, defaults to false. - + This controls whether or not to prepend runtime telemetry with the machine's hostname, defaults to false. + * `statsd_addr` Deprecated, see - `statsd_address` + the telemetry structure * `statsite_addr` Deprecated, see - `statsite_address` + the telemetry structure * `statsite_prefix` Deprecated, see - `statsite_prefix` + the telemetry structure * `dogstatsd_addr` Deprecated, see - `dogstatsd_addr` + he telemetry structure * `dogstatsd_tags` Deprecated, see - `dogstatsd_tags` + the telemetry structure * `syslog_facility` When [`enable_syslog`](#enable_syslog) is provided, this controls to which