Visitar URL original
Metrics missing from documentation · Issue #13364 · hashicorp/consul · GitHub
Skip to content

Metrics missing from documentation #13364

Open

Description

@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

    var ACLEndpointSummaries = []prometheus.SummaryDefinition{

  • consul.consul.cache.entries_count defined at

    // 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

    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

    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

Activity

  1. added
    type/docsDocumentation needs to be created/updated/clarified
    theme/telemetryAnything related to telemetry or observability
    on Jun 4, 2022
  2. Amier3 commented on Jun 7, 2022

    @Amier3
    Contributor

    Hey @maxb

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

  3. added
    good first issueA well-defined bug or improvement with sufficient context which should be approachable for new contr
    on Jun 7, 2022
  4. deepto98 commented on Jun 18, 2022

    @deepto98

    Can I pick this up?

  5. nfi-hashicorp commented on Oct 21, 2022

    @nfi-hashicorp
    Collaborator

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

  6. deepto98 commented on Nov 3, 2022

    @deepto98

    Yeah, sure, Can I work on this?

  7. nfi-hashicorp commented on Nov 3, 2022

    @nfi-hashicorp
    Collaborator

    Yeah, sure, Can I work on this?

    Yes please and thank you!

  8. pglushko commented on Mar 24, 2024

    @pglushko

    @deepto98 are you still working on this?

  9. tysoncung commented on Dec 11, 2025

    @tysoncung

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

good first issueA well-defined bug or improvement with sufficient context which should be approachable for new contrtheme/telemetryAnything related to telemetry or observabilitytype/docsDocumentation needs to be created/updated/clarified

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions