Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Agent metrics are missing HELP documentation #2812

Closed
samjewell opened this issue Jan 24, 2023 · 2 comments
Closed

Agent metrics are missing HELP documentation #2812

samjewell opened this issue Jan 24, 2023 · 2 comments
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed.

Comments

@samjewell
Copy link

I'm trying to follow the docs here:
https://grafana.com/docs/grafana-cloud/billing-and-usage/control-prometheus-metrics-usage/changing-scrape-interval/#grafana-agent

And see the following example query:

count_over_time(scrape_samples_scraped[1m])

I'm trying to understand what the query is doing, so I open up the Metrics-browser and hover that metric name to try to find the HELP metadata for that metric. But there's none there - it's completely missing:

image

Normally HELP metadata for a metric would look like this:
image

Please can you include this metadata when you ship these metrics, so users can understand what they are? Thanks

@rfratto
Copy link
Member

rfratto commented Jan 24, 2023

Hey Sam! This is a known issue: grafana/alloy#547. Closing as a duplicate of grafana/alloy#547.

@rfratto rfratto closed this as not planned Won't fix, can't repro, duplicate, stale Jan 24, 2023
@github-project-automation github-project-automation bot moved this from Todo to Done in Grafana Agent (Public) Jan 24, 2023
@samjewell
Copy link
Author

Hey @rfratto

Thanks so much for your speedy response, and sorry for the noise here - it can be hard to figure out/track down the original source of the issue.

But I wanted to share: I found that the Prometheus repo itself exposes this metric, but doesn't ship any metadata for it, so I've opened an issue on that repo instead now:
prometheus/prometheus#11884

@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed.
Projects
No open projects
Development

No branches or pull requests

2 participants