Skip to content

Commit

Permalink
docs: clarify the behavior of prepending hostname to metrics (#17521)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
huikang and trujillo-adam authored Jun 5, 2023
1 parent 77f44fa commit dd71bb8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 1 addition & 2 deletions website/content/docs/agent/config/config-files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions website/content/docs/agent/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.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)
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
Expand Down

0 comments on commit dd71bb8

Please sign in to comment.