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

Grafana shows warning if metric name does not follow naming convention #6627

Open
nflaig opened this issue Apr 3, 2024 · 0 comments
Open
Labels
scope-metrics All issues with regards to the exposed metrics. scope-ux Issues for CLI UX or general consumer UX.

Comments

@nflaig
Copy link
Member

nflaig commented Apr 3, 2024

Grafana now shows a warning on panels that use PromQL queries that use functions like rate() which only work on counters but the metric name does not suggest that it is a counter.

image

We have plenty of metrics like this, e.g. attestation summary on validator monitor dashboard

prevEpochAttestationSummary: register.gauge<{summary: string}>({
name: "validator_monitor_prev_epoch_attestation_summary",

To get rid of the warning and more strictly follow Prometheus best practices we would have to update the metric name

-validator_monitor_prev_epoch_attestation_summary
+validator_monitor_prev_epoch_attestation_summary_total

I am not sure if it's worth fixing as it would break existing dashboards but the warnings might also be confusing to users and it would generally be good to follow the recommended naming convention.

@nflaig nflaig added scope-metrics All issues with regards to the exposed metrics. scope-ux Issues for CLI UX or general consumer UX. labels Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope-metrics All issues with regards to the exposed metrics. scope-ux Issues for CLI UX or general consumer UX.
Projects
None yet
Development

No branches or pull requests

1 participant