Optionally print OM created lines #1408
Open
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
ArthurSens
changed the title
bwplotka
reviewed
Dec 22, 2023
ArthurSens
force-pushed
the
om-created-lines
branch
from
c26d312
to
b7d00b2
Compare
ArthurSens
changed the title
ArthurSens
force-pushed
the
om-created-lines
branch
3 times, most recently
from
e930252
to
240345e
Compare
bwplotka
approved these changes
Feb 5, 2024
ArthurSens
force-pushed
the
om-created-lines
branch
2 times, most recently
from
33ed3e6
to
e9c6f77
Compare
bwplotka
approved these changes
Mar 25, 2024
prometheus/promhttp/http.go
Outdated
Comment on lines
396
to
397
| // possible options during content negotiation. Note that Prometheus | ||
| // 2.5.0+ will negotiate OpenMetrics as first priority. OpenMetrics is | ||
| // the only way to transmit exemplars. However, the move to OpenMetrics | ||
| // is not completely transparent. Most notably, the values of "quantile" | ||
| // labels of Summaries and "le" labels of Histograms are formatted with | ||
| // a trailing ".0" if they would otherwise look like integer numbers | ||
| // (which changes the identity of the resulting series on the Prometheus | ||
| // server). |
There was a problem hiding this comment.
Suggested change
| // possible options during content negotiation. Note that Prometheus | |
| // 2.5.0+ will negotiate OpenMetrics as first priority. OpenMetrics is | |
| // the only way to transmit exemplars. However, the move to OpenMetrics | |
| // is not completely transparent. Most notably, the values of "quantile" | |
| // labels of Summaries and "le" labels of Histograms are formatted with | |
| // a trailing ".0" if they would otherwise look like integer numbers | |
| // (which changes the identity of the resulting series on the Prometheus | |
| // server). | |
| // possible options during content negotiation. | |
| // | |
| // Note that Prometheus 2.5.0+ might negotiate OpenMetrics Text format | |
| // as first priority unless user uses custom scrape protocol prioritization or | |
| // histograms feature is enabled (then Prometheus proto format is prioritized, | |
| // which client_golang supports). | |
| // | |
| // The main reason for enabling OpenMetrics Text was to enable exemplars, | |
| // but Prometheus proto has that as feature as well. | |
| // | |
| // However, the move to OpenMetrics is not completely transparent. Most notably, | |
| // the values of "quantile" labels of Summaries and "le" labels of Histograms are | |
| // formatted with a trailing ".0" if they would otherwise look like integer numbers | |
| // (which changes the identity of the resulting series on the Prometheus | |
| // server). | |
| // | |
| // See other options in OpenMetricsOptions to learn how to enable some special | |
| // features e.g. potentially dangerous created timestamp series. |
There was a problem hiding this comment.
// The main reason for enabling OpenMetrics Text was to enable exemplars,
// but Prometheus proto has that as feature as well.
this part seems a bit out of place, not adding much to the comment 🤔, is it ok to not add this part?
prometheus/promhttp/http.go
Outdated
| // is recommended to enable the feature flag in Prometheus, otherwise enabling | ||
| // _created lines will result in increased cardinality and no improvements | ||
| // in reset detection. | ||
| EnableOpenMetricsCreatedMetrics bool |
There was a problem hiding this comment.
Suggested change
| EnableOpenMetricsCreatedMetrics bool | |
| EnableCreatedSeries bool |
There was a problem hiding this comment.
Hmmmmm, future versions of OM might not expose them as a series. What do you think about EnableCreatedTimestamps?
ArthurSens
force-pushed
the
om-created-lines
branch
from
e9c6f77
to
81909c5
Compare
|
We need prometheus/common v0.49.0 for this feature, but this version of prometheus/common requires go 1.21. Therefore, the PR is blocked until we drop support for go 1.20 |
Signed-off-by: Arthur Silva Sens <arthur.sens@coralogix.com>
Signed-off-by: Arthur Silva Sens <arthur.sens@coralogix.com>
ArthurSens
force-pushed
the
om-created-lines
branch
from
81909c5
to
65df2d7
Compare
|
After quite some work to unblock this, this is finally ready :) Do you want to review again or should I just merge? |
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.
This PR adds an extra option to print _created lines when OpenMetrics is the chosen exposition format. It's implemented following the conditional option added in prometheus/common#504.