Metrics missing from documentation · hashicorp/consul#13364

(7 comments) (0 reactions) (1 assignee)Go (29,891 stars) (4,588 forks)batch import

good first issuetheme/telemetrytype/docs

Description

https://www.consul.io/docs/agent/telemetry#metrics-reference claims "This is a full list of metrics emitted by Consul." but some are missing:

The family of new consul.acl.* metrics defined at https://github.com/hashicorp/consul/blob/019aeaa57de97100d57f8ab9c771365b1cfcf7b8/agent/consul/acl_endpoint.go#L33
consul.consul.cache.entries_count defined at https://github.com/hashicorp/consul/blob/019aeaa57de97100d57f8ab9c771365b1cfcf7b8/agent/cache/cache.go#L38-L44 (the doubled initial consul. is presumably what the TODO comment is talking about - a number of other metrics are documented without the doubled consul. even though they are actually emitted with it - but that's a separate issue.)
consul.federation_state.* from https://github.com/hashicorp/consul/blob/019aeaa57de97100d57f8ab9c771365b1cfcf7b8/agent/consul/federation_state_endpoint.go#L16-L33
consul.intention.apply from https://github.com/hashicorp/consul/blob/019aeaa57de97100d57f8ab9c771365b1cfcf7b8/agent/consul/intention_endpoint.go#L88
consul.raft.peers from within the github.com/hashicorp/raft library
consul.runtime.gc_pause_ns, .free_count, .malloc_count, .total_gc_runs from within the github.com/armon/go-metrics library
consul.serf.member.update and consul.serf.queue.* from within the github.com/hashicorp/serf library

Tech stack: go
Domain: documentationobservability
Issue type: documentation
Difficulty: 3
Estimated time: 1-3 hours
Activity status: stale
Clarity: clear
Prerequisites: Go
Newbie friendliness: 70
Research direction: Open the telemetry documentation page at consul/website/content/docs/agent/telemetry.mdx (or the equivalent source). Add the missing metrics as listed in the issue, following the existing format. For each missing metric, trace the code files linked (e.g., agent/consul/acl endpoint.go) to confirm the metric name and ensure the description matches the emitted telemetry. Note the doubled 'consul.' prefix issue and decide whether to document it as emitted or correct it. The PR should only add missing metrics; do not change the existing content.