[FLINK-40641][metrics] Cover the Prometheus reporter exposition contract - #29178
Open
MartijnVisser wants to merge 4 commits into
Open
MartijnVisser wants to merge 4 commits into
MartijnVisser wants to merge 4 commits into
Conversation
…us reporter No existing test asserts what a family does not contain, so the missing `_sum` and the Meter's missing count were uncovered. `TestHistogram` has a minimum of 7 and a maximum of 6, so a coherent one is added. Generated-by: Claude Code (Claude Opus 5)
…heus reporter A summary occupies more names than its own, and which ones is a property of the client. When that set grows a metric stops being exported and we only log a warning. Generated-by: Claude Code (Claude Opus 5)
…f the Prometheus reporter Today only `/metrics` is scraped, so the root going unserved would go unnoticed, and no test sends an `Accept` header. A real Prometheus server asks for OpenMetrics. Generated-by: Claude Code (Claude Opus 5)
FLINK-40592 covers the Authorization header, and with it the method and job path. This covers the encoding, body, content type, shutdown and failure. A path prefix in `hostUrl` is preserved. Generated-by: Claude Code (Claude Opus 5)
Collaborator
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 is the purpose of the change
The current tests don't check the
Content-Type, don't send anAcceptheader, and don't cover what the push gateway receives.No production code is changed and no dependency is added.
Brief change log
PrometheusExpositionContractTestfor the names, types, labels and values a user scrapesPrometheusReservedNameTestfor the names a summary occupies, over every reserved suffixPrometheusHttpSurfaceTestfor the paths served and theContent-TypeperAcceptheaderPrometheusPushGatewayWireTestfor the push and delete requestsVerifying this change
This change added tests and can be verified as follows:
mvn verify -pl flink-metrics/flink-metrics-prometheus -Dprometheus.version=0.16.0replays these tests against the candidate client. Five fail: two where a_createdname collides with a summary and one of the pair is dropped, two where the client answers OpenMetrics, and one where an unmatched path stops serving metricsDoes this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation
Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Claude Opus 5)