luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: clarify the behavior of prepending hostname to metrics (#17521) 

* docs: clarify the behavior of prepending hostname to metrics

* Update website/content/docs/agent/config/config-files.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

---------

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
This commit is contained in:
cskh 2023-06-05 19:47:26 -04:00 committed by GitHub
parent e909289454
commit abed1cbda5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
website/content/docs/agent/config/config-files.mdx
View File

@ -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. geo location or datacenter, dc:sfo). By default, this is left blank and not used.
- `disable_hostname` ((#telemetry-disable_hostname)) - `disable_hostname` ((#telemetry-disable_hostname))
This controls whether or not to prepend runtime telemetry with the machine's Set to `true` to stop prepending the machine's hostname to gauge-type metrics. Default is `false`.
hostname, defaults to false.
- `dogstatsd_addr` ((#telemetry-dogstatsd_addr)) This provides the address - `dogstatsd_addr` ((#telemetry-dogstatsd_addr)) This provides the address
of a DogStatsD instance in the format `host:port`. DogStatsD is a protocol-compatible of a DogStatsD instance in the format `host:port`. DogStatsD is a protocol-compatible

4
website/content/docs/agent/telemetry.mdx
View File

@ -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 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. 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.hostname.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) Additionally, if the [`telemetry` configuration options](/consul/docs/agent/config/config-files#telemetry)
are provided, the telemetry information will be streamed to a 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 [statsite](http://github.com/armon/statsite) or [statsd](http://github.com/etsy/statsd) server where