Skip to content

Rename prometheus exporter config property names #5071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reyang merged 2 commits into from
May 11, 2026
Merged

Rename prometheus exporter config property names #5071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53972fa
Rename prometheus exporter config property names
jack-berg May 6, 2026
f1b90b3
Add changelog entry
jack-berg May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ release.
([#5024](https://github.com/open-telemetry/opentelemetry-specification/issues/5024))
- Stabilize port configuration.
([#4985](https://github.com/open-telemetry/opentelemetry-specification/issues/4985))
- Change Prometheus Metric Exporter config property recommended names
(`without_scope_info` -> `scope_info_enabled`, `without_target_info` -> `target_info_enabled`,
`with_resource_constant_labels` -> `resource_constant_labels`)
([#5071](https://github.com/open-telemetry/opentelemetry-specification/issues/5071))

### Logs

Expand Down
12 changes: 7 additions & 5 deletions specification/metrics/sdk_exporters/prometheus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ A Prometheus Exporter MAY offer configuration to add resource attributes as metr
By default, it MUST NOT add any resource attributes as metric attributes.
The configuration SHOULD allow the user to select which resource attributes to copy (e.g.
include / exclude or regular expression based). Copied Resource attributes MUST NOT be
excluded from the `target` info metric. The option MAY be named `with_resource_constant_labels`.
excluded from the `target` info metric. The option MAY be named `resource_constant_labels`.

### Translation Strategy

Expand All @@ -151,15 +151,17 @@ If the Prometheus exporter supports such configuration it MUST be named to somet

**Status**: [Development](../../document-status.md)

A Prometheus Exporter MAY support a configuration option to produce metrics without [scope labels](../../compatibility/prometheus_and_openmetrics.md#instrumentation-scope-1).
The option MAY be named `without_scope_info`, and MUST be `false` by default.
A Prometheus Exporter MAY support configuration to specify whether metrics include
[scope labels](../../compatibility/prometheus_and_openmetrics.md#instrumentation-scope-1).
The option MAY be named `scope_info_enabled`, and MUST be `true` by default.

### Target Info

**Status**: [Development](../../document-status.md)

A Prometheus Exporter MAY support a configuration option to produce metrics without a [target info](../../compatibility/prometheus_and_openmetrics.md#resource-attributes-1)
metric. The option MAY be named `without_target_info`, and MUST be `false` by default.
A Prometheus Exporter MAY support a configuration to specify whether to produce a
[target info](../../compatibility/prometheus_and_openmetrics.md#resource-attributes-1) metric.
The option MAY be named `target_info_enabled`, and MUST be `true` by default.

## Content Negotiation

Expand Down
Loading