Repository navigation
Metrics missing from documentation #13364
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 atconsul/agent/consul/acl_endpoint.go
Line 33 in 019aeaa
var ACLEndpointSummaries = []prometheus.SummaryDefinition{ -
consul.consul.cache.entries_countdefined at(the doubled initialLines 38 to 44 in 019aeaa
// TODO(kit): remove the namespace from these once the metrics themselves change var Gauges = []prometheus.GaugeDefinition{ { Name: []string{"consul", "cache", "entries_count"}, Help: "Represents the number of entries in this cache.", }, } consul.is presumably what the TODO comment is talking about - a number of other metrics are documented without the doubledconsul.even though they are actually emitted with it - but that's a separate issue.) -
consul.federation_state.*fromconsul/agent/consul/federation_state_endpoint.go
Lines 16 to 33 in 019aeaa
var FederationStateSummaries = []prometheus.SummaryDefinition{ { Name: []string{"federation_state", "apply"}, Help: "", }, { Name: []string{"federation_state", "get"}, Help: "", }, { Name: []string{"federation_state", "list"}, Help: "", }, { Name: []string{"federation_state", "list_mesh_gateways"}, Help: "", }, } -
consul.intention.applyfromconsul/agent/consul/intention_endpoint.go
Line 88 in 019aeaa
defer metrics.MeasureSince([]string{"intention", "apply"}, time.Now()) -
consul.raft.peersfrom within thegithub.com/hashicorp/raftlibrary -
consul.runtime.gc_pause_ns,.free_count,.malloc_count,.total_gc_runsfrom within thegithub.com/armon/go-metricslibrary -
consul.serf.member.updateandconsul.serf.queue.*from within thegithub.com/hashicorp/serflibrary
Activity
Amier3 commentedon Jun 7, 2022
Hey @maxb
Thanks for bringing this to our attention, hopefully we'll get these in the docs shortly.
deepto98 commentedon Jun 18, 2022
Can I pick this up?
nfi-hashicorp commentedon Oct 21, 2022
Hi @deepto98, sorry for the late reply! Are you still interested?
deepto98 commentedon Nov 3, 2022
Yeah, sure, Can I work on this?
nfi-hashicorp commentedon Nov 3, 2022
Yes please and thank you!
pglushko commentedon Mar 24, 2024
@deepto98 are you still working on this?
tysoncung commentedon Dec 11, 2025
Documentation improvements are always valuable! I'd be happy to help with this. What specific areas do you think need better documentation?