Metrics missing from documentation

[maxb]

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

  consul/agent/consul/acl_endpoint.go

  Line 33 in 019aeaa

  var ACLEndpointSummaries = []prometheus.SummaryDefinition{

• consul.consul.cache.entries_count defined at

  consul/agent/cache/cache.go

  Lines 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.",
  	},
  	}

  (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

  consul/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.apply from

  consul/agent/consul/intention_endpoint.go

  Line 88 in 019aeaa

  defer metrics.MeasureSince([]string{"intention", "apply"}, time.Now())

• 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

[Amier3]

Hey @maxb

Thanks for bringing this to our attention, hopefully we'll get these in the docs shortly.

[deepto98]

Can I pick this up?

[nfi-hashicorp]

Hi @deepto98, sorry for the late reply! Are you still interested?

[deepto98]

Yeah, sure, Can I work on this?

[nfi-hashicorp]

Yeah, sure, Can I work on this?

Yes please and thank you!

[pglushko]

@deepto98 are you still working on this?

[tysoncung]

Documentation improvements are always valuable! I'd be happy to help with this. What specific areas do you think need better documentation?