feat(om2): add native histograms to OpenMetrics2.0 #2634
Conversation
This file contains hidden or 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
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
krajorama
commented
Apr 30, 2025
|
|
||
| Numbers MUST be either floating points or integers. Note that ingestors of the format MAY only support float64. The non-real values NaN, +Inf and -Inf MUST be supported. NaN MUST NOT be considered a missing value, but it MAY be used to signal a division by zero. | ||
|
|
||
| Complex data types MUST contain all information necessary to recreate a Metric Type, with the exception of Created time and Exemplars. |
There was a problem hiding this comment.
This assume we'll have the created timestamp separate from the JSON like data. prometheus/OpenMetrics#285
Signed-off-by: György Krajcsovits <[email protected]>
|
Note self: add details how summaries and classic histograms one liners (so not NHCB spans/deltas) fit into it. |
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Add semantic conventions about where complex types may occure. Allow empty spans and deltas. Be more precise. Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
ArthurSens
reviewed
May 24, 2025
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
This comment was marked as outdated.
This comment was marked as outdated.
krajorama
commented
Jun 3, 2025
I did not want to clutter the examples with adding "# EOF" to all, so I made a new marker to explicitly add it on request. There was only one faulty example where we had an extra space, see the Exemplars section. Signed-off-by: György Krajcsovits <[email protected]>
Allow multiple exemplars for complex types, i.e. native histograms. But require that the timestamp is present. Signed-off-by: György Krajcsovits <[email protected]>
krajorama
force-pushed
the
krajo/om2.0-native-histograms
branch
from
c16426b to
7965787
Compare
beorn7
requested changes
Jun 12, 2025
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
even unpopulated ones. Signed-off-by: György Krajcsovits <[email protected]>
Empty may be exposed for optimizing spans. Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
krajorama
commented
Jun 13, 2025
Signed-off-by: György Krajcsovits <[email protected]>
Rename negative_deltas and positive_deltas to negative_buckets and positive_buckets. Distinguish integer and float histograms by the number format used in them. If the number has dot "." or exponent "e", then the number is a float. Otherwise integer. Signed-off-by: György Krajcsovits <[email protected]>
The timestamp requirement came from current limitations in Prometheus exemplar storage. However in the future this might be solved. Also there's the case when a classic histogram exposes exemplars. Signed-off-by: György Krajcsovits <[email protected]>
beorn7
reviewed
Jun 24, 2025
beorn7
requested changes
Jun 24, 2025
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Sync with the spec https://prometheus.io/docs/specs/native_histograms/#zero-bucket Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Allow missing _sum and _count and set rules for interpretation if needed. Signed-off-by: György Krajcsovits <[email protected]>
To reduce scope. Signed-off-by: György Krajcsovits <[email protected]>
|
Just one more note from my side. (But as said, I'm not authorized to approve OMv2 related things.) |
|
I'm planning to go through this, but looks generally good! |
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
|
My comments have all been addressed. (I just don't approve this for the reasons stated previously.) |
Signed-off-by: György Krajcsovits <[email protected]>
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.
Background
Based on https://github.com/prometheus/proposals/blob/main/proposals/2024-01-29_native_histograms_text_format.md
And OpenMetrics 2.0 WG discussions.
Changes
Require that exemplars for complex type values have the timestamp.(1)Be permissive about the existence of _sum and _count series for classic histograms - for backwards compatibility.(1) Not doing this on account of being an implementation limitation and also contradicts having backwards compatibility when exposing classic histograms as complex type.
Open questions / decisions
See OpenMetrics2.0 WG meeting notes tab