opentelemetry-exporter-prometheus: add support to configure Resource attributes as metric labels#5122
Open
herin049 wants to merge 4 commits into
Open
Conversation
herin049
added
Approve Public API check
10 tasks
herin049
force-pushed
the
feat/prometheus-resource-attrs
branch
2 times, most recently
from
2befd3e to
f2eeff0
Compare
herin049
force-pushed
the
feat/prometheus-resource-attrs
branch
from
784aa8a to
ad17d8b
Compare
|
This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment. |
herin049
force-pushed
the
feat/prometheus-resource-attrs
branch
from
aa62ad2 to
8ecb28d
Compare
herin049
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a configuration hook to the Prometheus exporter that allows selected OpenTelemetry Resource attributes to be copied onto exported Prometheus metrics as labels, aligning the Python Prometheus exporter with the Prometheus compatibility guidance in the OpenTelemetry specification.
Changes:
- Introduces a
resource_attr_filtercallback onPrometheusMetricReaderto select which Resource attributes should become metric labels (sanitized to valid Prometheus label names). - Updates label construction so copied Resource labels are included on exported samples, while preserving precedence (metric point attributes override copied Resource attributes).
- Adds unit tests and documentation describing the new configuration, plus a changelog entry.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| exporter/opentelemetry-exporter-prometheus/src/opentelemetry/exporter/prometheus/init.py | Adds resource_attr_filter wiring and includes filtered Resource attributes in label generation. |
| exporter/opentelemetry-exporter-prometheus/tests/test_prometheus_exporter.py | Adds tests covering default behavior, filtering, sanitization, and precedence with point/scope labels. |
| docs/exporter/prometheus/prometheus.rst | Documents how to enable Resource attributes as metric labels via resource_attr_filter. |
| .changelog/5122.added | Records the new Prometheus exporter feature in the changelog. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Description
Adds support for adding Resource attributes as metric labels for the Prometheus exporter in accordance to the Prometheus spec.
Fixes #5110
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Does This PR Require a Contrib Repo Change?
Checklist: