Skip to content

Rename prometheus exporter config property names#5071

Merged
reyang merged 2 commits into
open-telemetry:mainfrom
jack-berg:prom-exporter-property-names
May 11, 2026
Merged

Rename prometheus exporter config property names#5071
reyang merged 2 commits into
open-telemetry:mainfrom
jack-berg:prom-exporter-property-names

Conversation

@jack-berg

Copy link
Copy Markdown
Member

Here, I change:

  • without_scope_info -> scope_info_enabled (default true)
  • without_target_info -> target_info_enabled (default true)
  • with_resource_constant_labels -> resource_constant_labels (default none are added)

The with prefix of a few (but not all) prometheus exporter options seems to be a carry over from go functional options pattern. We don't see it in the spec'd property names of any other built in components. It doesn't doesn't contribute to the property's meaning in any way. Omitting it doesn't block a language from using it in their implementation, since that choice falls within maintainer discretion.

I think the use of "without" without_scope_info / without_target_info with a default value of false was probably inspired by the "All Boolean environment variables SHOULD be named and defined such that false is the expected safe default behavior." language that we decided is not applicable to other configuration interfaces: #4723

So since there's no env vars for without_scope_info / without_target_info, we don't need to be constrained by that.

Originated from: #5056 (comment)

Corresponding change in declarative config schema: github.com/open-telemetry/opentelemetry-configuration/pull/612

@reyang
reyang added this pull request to the merge queue May 11, 2026
Merged via the queue into open-telemetry:main with commit 426bc7e May 11, 2026
9 checks passed
@carlosalberto carlosalberto mentioned this pull request May 15, 2026
pull Bot pushed a commit to CodeWeaver13/opentelemetry-specification that referenced this pull request May 20, 2026
### Metrics

- Add in-development `Bind` API to synchronous instruments.

([open-telemetry#5050](open-telemetry#5050))
- Clarify that View-provided metric stream `name` is not subject to
instrument
  name syntax validation.

([open-telemetry#5094](open-telemetry#5094))

### Common

- Define the Core packages term.

([open-telemetry#5046](open-telemetry#5046))
- Rework contributing guide to reflect current process.

([open-telemetry#5072](open-telemetry#5072))

### Compatibility

- Stabilize sections of Prometheus and OpenMetrics Compatibility.
- Stabilize translation of labels prefixed with `otel_scope_` to OTLP
Instrumentation Scope.

([open-telemetry#5004](open-telemetry#5004))
  - Stabilize OpenTelemetry Gauge and Sum to Prometheus transformations.

([open-telemetry#5034](open-telemetry#5034))
- Stabilize OpenTelemetry Instrumentation Scope to Prometheus labels
transformation.

([open-telemetry#5052](open-telemetry#5052))
- Stabilize sections of Prometheus Metrics Exporter.
  - Stabilize temporality.

([open-telemetry#5024](open-telemetry#5024))
  - Stabilize version and format.

([open-telemetry#5083](open-telemetry#5083))
  - Stabilize port configuration.

([open-telemetry#5026](open-telemetry#5026))
  - Stabilize `scope_info_enabled` configuration.

([open-telemetry#5056](open-telemetry#5056))
- 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`)

([open-telemetry#5071](open-telemetry#5071))
- Clarify that OTel SDKs should not use unofficial Prometheus clients.

([open-telemetry#5082](open-telemetry#5082))

### OTEPs

- Add OTEP for Semantic Convention Schema v2 with support for multiple
convention
  registries and resolved schema format

([open-telemetry#4815](open-telemetry#4815))

---------

Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
hilmarf pushed a commit to apeirora/opentelemetry-specification that referenced this pull request Jun 1, 2026
### Metrics

- Add in-development `Bind` API to synchronous instruments.

([open-telemetry#5050](open-telemetry#5050))
- Clarify that View-provided metric stream `name` is not subject to
instrument
  name syntax validation.

([open-telemetry#5094](open-telemetry#5094))

### Common

- Define the Core packages term.

([open-telemetry#5046](open-telemetry#5046))
- Rework contributing guide to reflect current process.

([open-telemetry#5072](open-telemetry#5072))

### Compatibility

- Stabilize sections of Prometheus and OpenMetrics Compatibility.
- Stabilize translation of labels prefixed with `otel_scope_` to OTLP
Instrumentation Scope.

([open-telemetry#5004](open-telemetry#5004))
  - Stabilize OpenTelemetry Gauge and Sum to Prometheus transformations.

([open-telemetry#5034](open-telemetry#5034))
- Stabilize OpenTelemetry Instrumentation Scope to Prometheus labels
transformation.

([open-telemetry#5052](open-telemetry#5052))
- Stabilize sections of Prometheus Metrics Exporter.
  - Stabilize temporality.

([open-telemetry#5024](open-telemetry#5024))
  - Stabilize version and format.

([open-telemetry#5083](open-telemetry#5083))
  - Stabilize port configuration.

([open-telemetry#5026](open-telemetry#5026))
  - Stabilize `scope_info_enabled` configuration.

([open-telemetry#5056](open-telemetry#5056))
- 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`)

([open-telemetry#5071](open-telemetry#5071))
- Clarify that OTel SDKs should not use unofficial Prometheus clients.

([open-telemetry#5082](open-telemetry#5082))

### OTEPs

- Add OTEP for Semantic Convention Schema v2 with support for multiple
convention
  registries and resolved schema format

([open-telemetry#4815](open-telemetry#4815))

---------

Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants