Implement automatic exposition format detection #14445
Merged
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
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
5 tasks
ghost
added
|
The |
|
Label |
Codecov Report
Flags with carried forward coverage won't be shown. Click here to find out more. |
It's complaining about a license year due to file renames. I think it's safe to ignore that validation error on this instance; it's a bit of an edge case for the license header validation. |
ofek
reviewed
Apr 24, 2023
| @property | ||
| def parse_metric_families(self): | ||
| media_type = self._content_type.split(';')[0] | ||
| return self._parsers[media_type] |
There was a problem hiding this comment.
Based on https://github.com/prometheus/prometheus/blob/v2.43.0/model/textparse/interface.go#L83-L90 couldn't we get rid of the parser mapping attribute and this could be simplified?
Suggested change
| return self._parsers[media_type] | |
| return ( | |
| parse_openmetrics | |
| if self.use_latest_spec or media_type == 'application/openmetrics-text' | |
| else parse_prometheus | |
| ) |
alopezz
force-pushed
the
alopez/openmetrics/dynamic-parser-selection
branch
from
70d3df2
to
6121ec6
Compare
|
The |
In preparation for adding tests for dynamic parsing based on content type
Instead of "strict"
alopezz
force-pushed
the
alopez/openmetrics/dynamic-parser-selection
branch
from
6121ec6
to
1abfce5
Compare
|
The |
github-actions bot
pushed a commit
that referenced
this pull request
Apr 25, 2023
* Put all tests for OpenMetrics V2 in the same file In preparation for adding tests for dynamic parsing based on content type * Rename test file * Choose openmetrics parser dynamically * Add content-type to prometheus test * Refactor fixtures into more granular ones * Rename fixtures to use prometheus / openmetrics Instead of "strict" * Test that `use_latest_spec` behaves as expected regardless of `Content-Type` * Rename parsing function names * Small refactor in parser selection * Move parser selection to explicit conditional 7d8dc6d
This was referenced Apr 25, 2023
alopezz
added a commit
that referenced
this pull request
Apr 25, 2023
As those are no longer needed after #14445.
alopezz
added a commit
that referenced
this pull request
Apr 26, 2023
* Be specific about the exposition formats supported * Remove references to configuration of actual format As those are no longer needed after #14445.
5 tasks
5 tasks
This was referenced Jun 16, 2023
5 tasks
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.
What does this PR do?
Changes the decision of what parser to use for OpenMetrics (Prometheus or OpenMetrics) to be dynamic, based on the
Content-Typeheader.Motivation
AI-2416.
The decision to use the OpenMetrics parser (a.k.a. strict in the code) or the Prometheus format parser was based on a config option called
use_latest_spec, which is not very obvious. As it so happens, both formats specify what theContent-Typeheader should look like when using each of those formats, which makes it reasonable for us to rely on it to make that decision dynamically instead of by using a explicit option. This will also keep our integrations working without changes in the event existing applications make the switch from the currently more widespread prometheus format to the OpenMetrics standard (which is supposed to represent the future). It should safe to rely on that header, as Prometheus itself does the same.Additional Notes
use_latest_specstill exists as a escape hatch to force theOpenMetricsformat regardless of content header. A follow-up PR will hide it.use_latest_specoption #14446 into this in order to apply the same versioning change to all affected integrations.Review checklist (to be filled by reviewers)
changelog/andintegration/labels attachedqa/skip-qalabel.