Use the same Help for metrics with and without labels #122
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When metrics are pre-registered with Help and without labels, when issuing metrics with labels, the help was filled with the key_name. But prometheus client enforces help to be consistent accross several elements, so, it can break at Runtime if a metric has been declared without its labels and later issued this metric with labels. In order to fix this, we store the help declared at startup for each key, so, when declaring a metric with some labels, we try to re-used pre-declared help for the metric. It should fix the issue that appeared with Consul 1.9.x and fix hashicorp/consul#9471
pierresouchay
force-pushed
the
metrics_with_label_use_pre_registered_help
branch
from
fab8c8a
to
923ff58
Compare
|
Hello @mkcp Maybe you could have a look at this PR to fix hashicorp/consul#9303 and hashicorp/consul#9198 Thank you! |
|
@pierresouchay Awesome!! Thank you for putting together a patch to address hashicorp/consul#9303. I've loaded this up on a local docker cluster and I can confirm that the warning messages at Consul startup and runtime are gone. Also, looking at metrics with dynamic labels - they are correctly batched with the correct metric name & help text. E.g. the
|
mkcp
approved these changes
Jan 5, 2021
|
LGTM, thanks Pierre! |
|
I created v0.3.6 |
|
Thank you @banks ! Made the update in hashicorp/consul#9510 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When metrics are pre-registered with Help and without labels,
when issuing metrics with labels, the help was filled with
the key_name.
But prometheus client enforces help to be consistent accross
several elements, so, it can break at Runtime if a metric
has been declared without its labels and later issued this metric
with labels.
In order to fix this, we store the help declared at startup for
each key, so, when declaring a metric with some labels, we try
to re-used pre-declared help for the metric.
It should fix the issue that appeared with Consul 1.9.x and
fix hashicorp/consul#9471