Automatically initialize time series without labels #209
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
dmagliola
changed the title
According to [Prometheus Best Practices](https://prometheus.io/docs/practices/instrumentation/#avoid-missing-metrics), client libraries are expected to automatically export a 0 value when declaring a metric that has no labels. We missed this so far in the Ruby client, this PR rectifies that. NOTE: This can be considered a breaking change. On the one hand, it's a bug fix, but on the other, it will make many time series materialize when scraping apps that use the client, that previously wouldn't have. Depending on how many label-less metrics the app is declaring, this may have a significant impact, so we should probably cut a new major version and warn about this in the Release Notes. Signed-off-by: Daniel Magliola <dmagliola@crystalgears.com>
dmagliola
force-pushed
the
init_metrics_without_labels
branch
from
dc5c059
to
feccff3
Compare
Sinjo
approved these changes
Mar 20, 2021
There was a problem hiding this comment.
I'm 👍🏻 on this, and I think we should go with a major bump as a courtesy. Hitting capacity on your Prometheus database is not a fun experience (often friends have reported just dropping all their metric history when this happens, which is kinda sad). If we can avoid ruining people's day like that for some thing as cheap as bumping the major version number, we should.
|
I've added this to a v3.0.0 milestone. If we have any other changes (either outstanding PRs or issues that won't take us much work - so probably not OpenMetrics) we think need the major version bump we should bundle them in there. |
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.
Issue #208
According to Prometheus Best Practices, client libraries are expected to automatically export a 0 value when declaring a metric that has no labels.
We missed this so far in the Ruby client, this PR rectifies that.
NOTE: This can be considered a breaking change. On the one hand, it's a bug fix, but on the other, it will make many time series materialize when scraping apps that use the client, that previously wouldn't have.
Depending on how many label-less metrics the app is declaring, this may have a significant impact, so we should probably cut a new major version and warn about this in the Release Notes.