http: add support for filtering /metrics by component label
#3881
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
|
|
|
My first PR on |
|
@clayton-cornell I appreciate the feedback! I'll get those doc changes added. |
irateswami
force-pushed
the
metrics-component-filter
branch
from
647ba79 to
fc00b8a
Compare
clayton-cornell
added
the
type/docs
irateswami
force-pushed
the
metrics-component-filter
branch
from
2d2760f to
aff853e
Compare
This change wraps the Prometheus metrics handler with logic to parse `component` query parameters and filter the resulting metrics output to only include MetricFamilies that have at least one metric with a matching `component` label. Example: `GET /metrics?component=a&component=B` The filtering is optional and backward-compatible: - If no query param is supplied, all metrics are returned. - Multiple component values are supported (?component=a&component=b). - Unknown component values yield an empty response. Includes: - `filteredGatherer` implementation to filter prometheus.Gatherer results - Updated HTTP handler in http.go - Tests for expected behavior and edge cases Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
irateswami
force-pushed
the
metrics-component-filter
branch
from
77119d8 to
a4d8576
Compare
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.
PR Description
Adds support for filtering metrics by component label via query parameters
on the
/metricsendpoint.This allows filtering the Prometheus exposition output by supplying one or
more
componentvalues via the?component=query parameter.Example:
GET /metrics?component=agent&component=otelcol
Only metrics that contain a
componentlabel matching one of the suppliedvalues will be returned.
Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist