Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Backport of docs: clarify the behavior of prepending hostname to metrics into release/1.15.x #17580

Merged
merged 3 commits into from
Jun 7, 2023
Merged

Backport of docs: clarify the behavior of prepending hostname to metrics into release/1.15.x #17580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
315d6a1
backport of commit 81fe71d41174e21429be90e0e1ee073a592e5672
huikang May 30, 2023
0edc8fa
backport of commit 8d6b7070dd9bc15d810743151cf8238a08f6c6fc
huikang Jun 5, 2023
ed280ef
Merge branch 'release/1.15.x' into backport/gh-17320-update-metrics-d…
huikang Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions website/content/docs/agent/config/config-files.mdx
View file
Open in desktop
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
View file
Open in desktop
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