consul icon indicating copy to clipboard operation
consul copied to clipboard

Metrics missing from documentation

Open maxb opened this issue 3 years ago • 6 comments
trafficstars

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

maxb avatar Jun 04 '22 07:06 maxb

Hey @maxb

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

Amier3 avatar Jun 07 '22 18:06 Amier3

Can I pick this up?

deepto98 avatar Jun 18 '22 06:06 deepto98

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

nfi-hashicorp avatar Oct 21 '22 17:10 nfi-hashicorp

Yeah, sure, Can I work on this?

deepto98 avatar Nov 03 '22 15:11 deepto98

Yeah, sure, Can I work on this?

Yes please and thank you!

nfi-hashicorp avatar Nov 03 '22 16:11 nfi-hashicorp

@deepto98 are you still working on this?

pglushko avatar Mar 24 '24 17:03 pglushko