Skip to content

feat: add support for configuring scope info metric attributes for the Prometheus exporter and refactor conversion to Prometheus metrics#5123

Open
herin049 wants to merge 12 commits into
open-telemetry:mainfrom
herin049:feat/prometheus-scope-info
Open

feat: add support for configuring scope info metric attributes for the Prometheus exporter and refactor conversion to Prometheus metrics#5123
herin049 wants to merge 12 commits into
open-telemetry:mainfrom
herin049:feat/prometheus-scope-info

Conversation

@herin049
Copy link
Copy Markdown
Contributor

@herin049 herin049 commented Apr 18, 2026 •
edited
Loading

Description

Adds support for configuring scope attributes for the Prometheus exporter in accordance to the Prometheus spec and refactor conversion to Prometheus metrics.

Fixes #5112

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

uv run tox -e py314-test-opentelemetry-exporter-prometheus

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@herin049 herin049 requested a review from a team as a code owner April 18, 2026 04:33
@herin049 herin049 added the Approve Public API check This label shows that the public symbols added or changed in a PR are strictly necessary label Apr 18, 2026
@herin049 herin049 moved this to Ready for review in Python PR digest Apr 18, 2026
@johannaojeling johannaojeling mentioned this pull request Apr 20, 2026
Open
MikeGoldsmith
MikeGoldsmith reviewed Apr 21, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@MikeGoldsmith MikeGoldsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like it's on the right path. A few things to note:

  1. _SCOPE_ATTR_CONFLICT_NAMES is defined but never used — we should either use it to explicitly filter conflicting scope attributes or remove it.

  2. PR description looks copy-pasted from #5122 — says "Resource metrics as Metric attributes" but this is about scope info.

  3. Merge conflict concern — this, #5122, #5118, and #5117 all modify PrometheusMetricReader and _translate_to_prometheus. This is going to conflict with them, we need to coordinate what should be done in order or we'll be bumping into each other with rebases.

  4. nit: the nesting depth in _translate_to_prometheus is getting deep — might be worth extracting the per-metric logic into a helper in a follow-up.

@MikeGoldsmith MikeGoldsmith moved this from Ready for review to Approved PRs that need fixes in Python PR digest Apr 21, 2026
@herin049
Copy link
Copy Markdown
Contributor Author

herin049 commented Apr 22, 2026

This looks like it's on the right path. A few things to note:

  1. _SCOPE_ATTR_CONFLICT_NAMES is defined but never used — we should either use it to explicitly filter conflicting scope attributes or remove it.
  2. PR description looks copy-pasted from feat: add support for Resource attributes configuration for Prometheus exporter #5122 — says "Resource metrics as Metric attributes" but this is about scope info.
  3. Merge conflict concern — this, feat: add support for Resource attributes configuration for Prometheus exporter #5122, feat: add metric name translation strategy support for the Prometheus exporter #5118, and feat(exporter/prometheus): add default_aggregation parameter to PrometheusMetricReader #5117 all modify PrometheusMetricReader and _translate_to_prometheus. This is going to conflict with them, we need to coordinate what should be done in order or we'll be bumping into each other with rebases.
  4. nit: the nesting depth in _translate_to_prometheus is getting deep — might be worth extracting the per-metric logic into a helper in a follow-up.

Sorry, got a little sloppy with this PR. I originally used _SCOPE_ATTR_CONFLICT_NAMES, but refactored the code so that it isn't needed anymore. The update order shouldn't matter much, I can address the merge conflicts as they come in. Updated the PR description, will clean up the PR.

@herin049
Copy link
Copy Markdown
Contributor Author

herin049 commented Apr 22, 2026

@MikeGoldsmith I ended up doing a pretty major refactor of the exporter logic based on your suggestion, so we will likely want to merge this PR first.

@herin049 herin049 moved this from Approved PRs that need fixes to Ready for review in Python PR digest Apr 22, 2026
MikeGoldsmith
MikeGoldsmith approved these changes Apr 24, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@MikeGoldsmith MikeGoldsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks @herin049. Need to update PR title and description.

@github-project-automation github-project-automation Bot moved this from Ready for review to Approved PRs in Python PR digest Apr 24, 2026
@herin049 herin049 changed the title feat: add support for configuring scope info metric attributes for the Prometheus exporter feat: add support for configuring scope info metric attributes for the Prometheus exporter and refactor conversion to Prometheus metrics Apr 24, 2026
This was referenced Apr 24, 2026
Open
Open
@herin049 herin049 force-pushed the feat/prometheus-scope-info branch from ef6fede to 4a590f0 Compare April 25, 2026 03:39
@johannaojeling johannaojeling mentioned this pull request Apr 27, 2026
Closed
@ArthurSens ArthurSens mentioned this pull request Apr 27, 2026
Merged
6 tasks
@herin049 herin049 force-pushed the feat/prometheus-scope-info branch from 4a590f0 to be41170 Compare April 29, 2026 21:22
@ArthurSens
Copy link
Copy Markdown
Member

ArthurSens commented May 6, 2026 •
edited
Loading

Hey, just a heads-up from the Prometheus SIG: please hold off on the merge here. There's on going discussion happening on the PR that stabilizes this part of the spec open-telemetry/opentelemetry-specification#5056

@MikeGoldsmith
Copy link
Copy Markdown
Member

MikeGoldsmith commented May 7, 2026

Moving to draft until the SIG confirms this is the correct path.

@MikeGoldsmith MikeGoldsmith marked this pull request as draft May 7, 2026 14:16
@emdneto
Copy link
Copy Markdown
Member

emdneto commented May 12, 2026

Thanks for the PR!

Just a heads-up: we no longer update CHANGELOG.md directly. The changelog is now generated from changelog fragments using Towncrier.

Please add the appropriate changelog fragment for this change instead of editing CHANGELOG.md manually. You can find the instructions and expected format in CONTRIBUTING.md.

@ArthurSens
Copy link
Copy Markdown
Member

ArthurSens commented May 13, 2026

Seems like the discussion in the spec PR has settled and scope_info_enabled is the agreed upon configuration name :)

reyang pushed a commit to johannaojeling/opentelemetry-specification that referenced this pull request May 13, 2026
@ArthurSens
Prometheus exporter: Stabilize config option scope_info_enabled (op…
97ea2d8 
…en-telemetry#5056)

Fixes open-telemetry#4989

## Changes

Stabilizes the configuration option `without_scope_info`, documented in
the Prometheus exporter spec. It is implemented by a few SDKs already
open-telemetry#4989 (comment),
an open PR for
Python(open-telemetry/opentelemetry-python#5123),
and an issue for
DotNet(open-telemetry/opentelemetry-dotnet#7157).
Both prometheus exporters in the collector have the option as
well[[1](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/prometheusexporter#:~:text=without_scope_info%3A%20(default%20%3D%20false)%3A%20If%20true%2C%20metrics%20will%20be%20exported%20without%20scope%20name%2C%20version%2C%20schemaURL%2C%20and%20attributes%20encoded%20as%20labels.)][[2](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/prometheusremotewriteexporter#:~:text=disable_scope_info%20(default%20%3D%20false)%3A%20If%20true%2C%20the%20scope%20info%20labels%20(otel_scope_name%2C%20otel_scope_version%20and%20otel_scope_...%20attributes)%20will%20not%20be%20exported.)]
(Although remote write exporter uses `disable_scope_info` instead of
`without_scope_info`.

For non-trivial changes, follow the [change proposal
process](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md#proposing-a-change).

* [X] Related issues open-telemetry#4989 
* [ ] Related [OTEP(s)](https://github.com/open-telemetry/oteps) #
* [ ] Links to the prototypes (when adding or changing features)
* [X]
[`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md)
file updated for non-trivial changes
* For trivial changes, include `[chore]` in the PR title to skip the
changelog check
* [ ] [Spec compliance
matrix](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix/template.yaml)
updated if necessary
* [ ] [Declarative config data
model](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/data-model.md#overview)
is updated if SDK config surface is changed

---------

Signed-off-by: Arthur Silva Sens <arthursens2005@gmail.com>
@herin049 herin049 marked this pull request as ready for review May 13, 2026 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MikeGoldsmith MikeGoldsmith MikeGoldsmith approved these changes

Assignees

No one assigned

Labels

Approve Public API check This label shows that the public symbols added or changed in a PR are strictly necessary exporters

Projects

Python PR digest
Status: Approved PRs

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Stabilize Prometheus Exporter: Scope Info

4 participants

@herin049 @ArthurSens @MikeGoldsmith @emdneto