prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels #5947

pellared · 2024-11-07T11:57:06Z

Towards open-telemetry/opentelemetry-specification#4223 (first two points from open-telemetry/opentelemetry-specification#4223 (comment))

Add instrumentation scope schema URL as otel_scope_schema_url label to exported metrics
Add instrumentation scope attributes as otel_scope_[attribute] labels to exported metrics

Side notes:

The exporter does not seem to work correctly if the end user adds e.g. an otel_scope_name attribute. I think the exporter should ignore all attributes with names that have prefix otel_scope_. This scenario is also not covered by the spec. I think it may be covered by a separate PR and issue.
Removal of otel_scope_info metric would be handled as a separate PR. prometheus: remove otel_scope_info #6770

pellared · 2024-11-07T11:58:14Z

@dashpole PTAL

codecov · 2024-11-07T11:58:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.0%. Comparing base (1dca080) to head (64fdbd9).
Report is 1 commits behind head on main.

Additional details and impacted files

@@     Coverage Diff      @@
##   main   #5947   +/-   ##
============================
============================

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

exporters/prometheus/exporter.go

mx-psi

Is this blocked by spec work? How can I help move this forward?

pellared · 2025-04-29T12:00:33Z

Is this blocked by spec work? How can I help move this forward?

Yes. See #5846 (comment)

pellared · 2025-04-29T16:39:47Z

Adding otel_scope_schema_url could be extracted to a seperate PR (and issue).

pellared · 2025-05-09T08:12:34Z

Question: Should we set the otel_scope_schema_url and otel_scope_version (legacy) labels if the values are empty?

Guessing that yes so that we can easily distinguish e.g. from metrics which have a otel_scope_version set.

ArthurSens · 2025-05-12T16:04:49Z

Question: Should we set the otel_scope_schema_url and otel_scope_version (legacy) labels if the values are empty?

Guessing that yes so that we can easily distinguish e.g. from metrics which have a otel_scope_version set.

Taking Prometheus (the server) out of the scope, I guess it makes sense. Someone looking at a /metrics endpoint will quickly understand if they are empty or unset.

Prometheus won't store anything for them, though, and the filter on the query my_metric{non_existing_label=""} is a no-op.

pellared · 2025-05-22T17:31:08Z

SIG meeting:
We agreed that this can be merged before updating the spec given we have a preliminary consent with OTel-Prometheus SIG and both exporter and spec are "development".

jade-guiton-dd · 2025-05-23T11:23:03Z

FYI: @mx-psi and I manually tested this PR in the Collector, and (as long as we disable without_scope_info, which is currently on by default in the Collector) it seems to resolve the conflicts we were having in open-telemetry/opentelemetry-collector#12939.

exporters/prometheus/exporter.go

Co-authored-by: Tyler Yahn <[email protected]>

Fixes #4223 Prototypes: - open-telemetry/opentelemetry-go#5947 - open-telemetry/opentelemetry-go#6770 - open-telemetry/opentelemetry-java#7356 - open-telemetry/opentelemetry-collector-contrib#40060 - open-telemetry/opentelemetry-collector-contrib#40004 ## Changes Currently (before this PR) [Prometheus and OpenMetrics Compatibility](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/compatibility/prometheus_and_openmetrics.md) assumes that only scope name and scope version are identifying. However, with #4161 this is no longer true. Therefore, this PR updates the Prometheus and OpenMetrics Compatibility specification to add the scope name, version, schema URL, scope attributes to all metrics. This also removes the `otel_scope_info` as it looks that it won't be useful. See: #4223 (comment). This change important for Collector open-telemetry/opentelemetry-go#5846 (comment). It is also is necessary towards stabilization of OTel-Prom/OpenMetrics compatibility) and the Prometheus exporter. _Initially, I thought about [splitting it into a few PRs](#4223 (comment)). However, it looks like doing it in one PR would be a more complete approach (also there are not that many changes)._ --------- Co-authored-by: Jade Guiton <[email protected]> Co-authored-by: Carlos Alberto Cortez <[email protected]>

### Added - The `go.opentelemetry.io/otel/semconv/v1.33.0` package. The package contains semantic conventions from the `v1.33.0` version of the OpenTelemetry Semantic Conventions. See the [migration documentation](./semconv/v1.33.0/MIGRATION.md) for information on how to upgrade from `go.opentelemetry.io/otel/semconv/v1.32.0.`(#6799) - The `go.opentelemetry.io/otel/semconv/v1.34.0` package. The package contains semantic conventions from the `v1.34.0` version of the OpenTelemetry Semantic Conventions. (#6812) - Add metric's schema URL as `otel_scope_schema_url` label in `go.opentelemetry.io/otel/exporters/prometheus`. (#5947) - Add metric's scope attributes as `otel_scope_[attribute]` labels in `go.opentelemetry.io/otel/exporters/prometheus`. (#5947) - Add `EventName` to `EnabledParameters` in `go.opentelemetry.io/otel/log`. (#6825) - Add `EventName` to `EnabledParameters` in `go.opentelemetry.io/otel/sdk/log`. (#6825) - Changed handling of `go.opentelemetry.io/otel/exporters/prometheus` metric renaming to add unit suffixes when it doesn't match one of the pre-defined values in the unit suffix map. (#6839) ### Changed - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/bridge/opentracing`. (#6827) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/exporters/zipkin`. (#6829) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/metric`. (#6832) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/sdk/resource`. (#6834) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/sdk/trace`. (#6835) - The semantic conventions have been upgraded from `v1.26.0` to `v1.34.0` in `go.opentelemetry.io/otel/trace`. (#6836) - `Record.Resource` now returns `*resource.Resource` instead of `resource.Resource` in `go.opentelemetry.io/otel/sdk/log`. (#6864) - Retry now shows error cause for context timeout in `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc`, `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc`, `go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc`, `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`, `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp`, `go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp`. (#6898) ### Fixed - Stop stripping trailing slashes from configured endpoint URL in `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc`. (#6710) - Stop stripping trailing slashes from configured endpoint URL in `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`. (#6710) - Stop stripping trailing slashes from configured endpoint URL in `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc`. (#6710) - Stop stripping trailing slashes from configured endpoint URL in `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp`. (#6710) - Validate exponential histogram scale range for Prometheus compatibility in `go.opentelemetry.io/otel/exporters/prometheus`. (#6822) - Context cancellation during metric pipeline produce does not corrupt data in `go.opentelemetry.io/otel/sdk/metric`. (#6914) ### Removed - `go.opentelemetry.io/otel/exporters/prometheus` no longer exports `otel_scope_info` metric. (#6770)

…1488) Map `otel_scope_schema_url` label to OpenTelemetry ScopeMetrics schema URL field. Emitting of the `otel_scope_schema_url` label was added in open-telemetry/opentelemetry-go#5947

…en-telemetry#41488) Map `otel_scope_schema_url` label to OpenTelemetry ScopeMetrics schema URL field. Emitting of the `otel_scope_schema_url` label was added in open-telemetry/opentelemetry-go#5947

prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels

417330c

pellared mentioned this pull request Nov 7, 2024

Prometheus exporter export instrumentation scope attributes #5846

Closed

pellared commented Nov 7, 2024

View reviewed changes

exporters/prometheus/exporter.go Outdated Show resolved Hide resolved

pellared changed the title ~~[POC] prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels~~ prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels Nov 7, 2024

pellared mentioned this pull request Dec 17, 2024

[Prometheus and OpenMetrics] Handle scheme URL and scope attributes as identifying open-telemetry/opentelemetry-specification#4223

Closed

mx-psi reviewed Apr 29, 2025

View reviewed changes

jade-guiton-dd mentioned this pull request Apr 29, 2025

Instrumentation scope attributes cause errors in Prometheus exporter open-telemetry/opentelemetry-collector#12939

Closed

pellared mentioned this pull request May 9, 2025

WIP: Replace otel_scope_info metric with labels in all metrics #6760

Closed

Merge branch 'main' into prom-ident

52c5823

This comment was marked as resolved.

Sign in to view

Update testdata

9ed3432

pellared added 2 commits May 9, 2025 10:16

Remove otel_scope_schema_url from otel_scope_info

279e397

Update changelog

69fd363

pellared changed the title ~~prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels~~ [Prototype] prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels May 9, 2025

pellared added blocked:specification Waiting on clarification of the OpenTelemetry specification before progress can be made pkg:exporter:prometheus Related to the Prometheus exporter package labels May 9, 2025

pellared marked this pull request as ready for review May 9, 2025 08:32

pellared requested review from MrAlias, XSAM and dmathieu as code owners May 9, 2025 08:32

pellared requested a review from mx-psi May 9, 2025 08:32

Merge branch 'main' into prom-ident

4bd9f08

pellared requested a review from dashpole May 9, 2025 08:46

Merge branch 'main' into prom-ident

cb62a23

Merge branch 'main' into prom-ident

96c0712

MrAlias added this to Go: Metric Prometheus Exporter (GA) May 22, 2025

MrAlias moved this to In Progress in Go: Metric Prometheus Exporter (GA) May 22, 2025

pellared changed the title ~~[DO NOT MERGE] prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels~~ prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels May 22, 2025

pellared removed the blocked:specification Waiting on clarification of the OpenTelemetry specification before progress can be made label May 22, 2025

pellared added 2 commits May 22, 2025 19:32

Merge branch 'main' into prom-ident

d52415c

Merge branch 'main' into prom-ident

f85e252

MrAlias approved these changes May 23, 2025

View reviewed changes

exporters/prometheus/exporter.go Outdated Show resolved Hide resolved

XSAM approved these changes May 24, 2025

View reviewed changes

pellared and others added 5 commits May 24, 2025 16:48

Update exporters/prometheus/exporter.go

2b56227

Co-authored-by: Tyler Yahn <[email protected]>

Merge branch 'main' into prom-ident

114158b

Fix build

0d8d34f

Fix changelog

dba0336

Fix scopeNameLabel, scopeVersionLabel, scopeSchemaLabel values

64fdbd9

pellared merged commit 69f189f into open-telemetry:main May 24, 2025
29 checks passed

github-project-automation bot moved this from In Progress to Done in Go: Metric Prometheus Exporter (GA) May 24, 2025

pellared deleted the prom-ident branch May 24, 2025 17:35

pellared mentioned this pull request May 25, 2025

receiver/prometheus: Populate scope attributes from labels instead of otel_scope_info open-telemetry/opentelemetry-collector-contrib#40060

Closed

MrAlias added this to the v1.37.0 milestone Jun 18, 2025

pellared mentioned this pull request Jun 24, 2025

Release 1.37.0/0.59.0/0.13.0 #6925

Merged

dmitryax mentioned this pull request Jul 22, 2025

[receiver/prometheus] Add support for otel_scope_schema_url label open-telemetry/opentelemetry-collector-contrib#41488

Merged

dmitryax mentioned this pull request Jul 22, 2025

[receiver/prometheus] Add support for otel_scope_<attribute-name> labels open-telemetry/opentelemetry-collector-contrib#41502

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels #5947

prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels #5947

Uh oh!

pellared commented Nov 7, 2024 •

edited

Loading

Uh oh!

pellared commented Nov 7, 2024

Uh oh!

codecov bot commented Nov 7, 2024 •

edited

Loading

Uh oh!

Uh oh!

mx-psi left a comment

Uh oh!

pellared commented Apr 29, 2025

Uh oh!

pellared commented Apr 29, 2025

Uh oh!

This comment was marked as resolved.

pellared commented May 9, 2025 •

edited

Loading

Uh oh!

ArthurSens commented May 12, 2025

Uh oh!

pellared commented May 22, 2025

Uh oh!

jade-guiton-dd commented May 23, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels #5947

prometheus: Add otel_scope_schema_url and otel_scope_[attribute] labels #5947

Uh oh!

Conversation

pellared commented Nov 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pellared commented Nov 7, 2024

Uh oh!

codecov bot commented Nov 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

mx-psi left a comment

Choose a reason for hiding this comment

Uh oh!

pellared commented Apr 29, 2025

Uh oh!

pellared commented Apr 29, 2025

Uh oh!

This comment was marked as resolved.

pellared commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ArthurSens commented May 12, 2025

Uh oh!

pellared commented May 22, 2025

Uh oh!

jade-guiton-dd commented May 23, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

pellared commented Nov 7, 2024 •

edited

Loading

codecov bot commented Nov 7, 2024 •

edited

Loading

pellared commented May 9, 2025 •

edited

Loading