From 104100d46bfdd7d37a5a258778b320bbc732abf1 Mon Sep 17 00:00:00 2001 From: hc-github-team-consul-core Date: Tue, 6 Jun 2023 23:25:01 -0400 Subject: [PATCH] Backport of docs: clarify the behavior of prepending hostname to metrics into release/1.15.x (#17580) * backport of commit 81fe71d41174e21429be90e0e1ee073a592e5672 * backport of commit 8d6b7070dd9bc15d810743151cf8238a08f6c6fc --------- Co-authored-by: cskh --- website/content/docs/agent/config/config-files.mdx | 3 +-- website/content/docs/agent/telemetry.mdx | 4 ++++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/website/content/docs/agent/config/config-files.mdx b/website/content/docs/agent/config/config-files.mdx index 30c4707c79..2d0630fca9 100644 --- a/website/content/docs/agent/config/config-files.mdx +++ b/website/content/docs/agent/config/config-files.mdx @@ -1818,8 +1818,7 @@ subsystem that provides Consul's service mesh capabilities. geo location or datacenter, dc:sfo). By default, this is left blank and not used. - `disable_hostname` ((#telemetry-disable_hostname)) - This controls whether or not to prepend runtime telemetry with the machine's - hostname, defaults to false. + Set to `true` to stop prepending the machine's hostname to gauge-type metrics. Default is `false`. - `dogstatsd_addr` ((#telemetry-dogstatsd_addr)) This provides the address of a DogStatsD instance in the format `host:port`. DogStatsD is a protocol-compatible diff --git a/website/content/docs/agent/telemetry.mdx b/website/content/docs/agent/telemetry.mdx index 75dd758ace..114702ee73 100644 --- a/website/content/docs/agent/telemetry.mdx +++ b/website/content/docs/agent/telemetry.mdx @@ -27,6 +27,10 @@ This telemetry information can be used for debugging or otherwise getting a better view of what Consul is doing. Review the [Monitoring and Metrics tutorial](/consul/tutorials/day-2-operations/monitor-datacenter-health?utm_source=docs) to learn how collect and interpret Consul data. +By default, all metric names of gauge type are prefixed with the hostname of the consul agent, e.g., +`consul..server.isLeader`. To disable prefixing the hostname, set +`telemetry.disable_hostname=true` in the [agent configuration](/consul/docs/agent/config/config-files#telemetry). + Additionally, if the [`telemetry` configuration options](/consul/docs/agent/config/config-files#telemetry) are provided, the telemetry information will be streamed to a [statsite](http://github.com/armon/statsite) or [statsd](http://github.com/etsy/statsd) server where