feat(configuration): bump config schema to v1.1.0, apply Prometheus property rename by MikeGoldsmith · Pull Request #6781 · open-telemetry/opentelemetry-js

MikeGoldsmith · 2026-06-03T11:42:13Z

Which problem is this PR solving?

The config schema was pinned to v1.0.0 (Feb 2026). v1.1.0 was released on 2026-06-05, which includes the Prometheus exporter property rename, IdGenerator definition, and other improvements.

Short description of the changes

Bumps the config schema pin from v1.0.0 to v1.1.0. The most user-visible change is the Prometheus exporter property rename (open-telemetry/opentelemetry-configuration#612 upstream):

without_scope_info → scope_info_enabled (inverted semantics: false → true)
without_target_info/development → target_info_enabled/development (inverted semantics: false → true)
with_resource_constant_labels → resource_constant_labels

Changes:

Update CONFIG_VERSION in the codegen script to v1.1.0
Regenerate types and validator
Update EnvironmentConfigFactory hardcoded Prometheus defaults to use the new property names with inverted semantics
Update test fixtures (kitchen-sink.yaml) and assertions to match

Breaking change?

For OTel JS consumers using the configuration package directly, the renamed properties on prometheus/development are a breaking change. Marked ! per convention.

Type of change

Breaking change

How Has This Been Tested?

82 configuration package tests pass
193 sdk-node tests pass
Full lint passes
Full repo tsc --build compiles cleanly

Bump opentelemetry-configuration schema from v1.0.0 to a SHA on main that includes upcoming v1.1.0 changes. Tracking issue for v1.1.0: open-telemetry/opentelemetry-configuration#643. Pulls in the Prometheus exporter property rename (open-telemetry#612 upstream): - `without_scope_info` -> `scope_info_enabled` (inverted semantics) - `without_target_info/development` -> `target_info_enabled/development` (inverted semantics) - `with_resource_constant_labels` -> `resource_constant_labels` Updates EnvironmentConfigFactory hardcoded defaults and all test fixtures/assertions to match the new schema. Regenerated types and validator. The schema pin should be reverted to a tagged release (v1.1.0) once upstream cuts the release. Assisted-by: Claude Opus 4.6

codecov · 2026-06-03T11:44:24Z

Codecov Report

❌ Patch coverage is 93.33333% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 95.51%. Comparing base (0b91bf1) to head (938c1b8).

Files with missing lines	Patch %	Lines
...al/packages/configuration/src/FileConfigFactory.ts	93.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6781      +/-   ##
==========================================
+ Coverage   94.93%   95.51%   +0.57%     
==========================================
  Files         383      382       -1     
  Lines       13009    12941      -68     
  Branches     2975     2967       -8     
==========================================
+ Hits        12350    12360      +10     
+ Misses        659      581      -78

Files with missing lines	Coverage Δ
...ages/configuration/src/EnvironmentConfigFactory.ts	`97.24% <ø> (ø)`
...al/packages/configuration/src/FileConfigFactory.ts	`96.24% <93.33%> (-0.49%)`	⬇️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

MikeGoldsmith · 2026-06-03T14:46:07Z

CI failures are:

Updated the const string for config schema version (should we include these types of changes in codecov?)
Failed link check, link is fine - likely rate limited

trentm · 2026-06-03T17:26:51Z

Side Q on versioning the config

(Perhaps this doesn't need to be solved for this PR. This "configuration" package and startNodeSdk() usage in sdk-node is still experiemental so we can break things while we figure out a process.)

Should a minor release of the configuration schema result in a breaking change of the JS configuration package?
Not for this PR, but I'd think eventually we'd want the JS SDK to support multiple v1.x versions of the configuration schema so that a user with a number of v1.0.0 configs is not immediately broken by an upgrade to the latest SDK packages.

Eventually we might want to support multiple major versions of the config schema, but I don't know that for sure.

@MikeGoldsmith @maryliag Do you know of prior discussions around this?
Are there rules/specs for declarative config implementations on supporting schema versions?
Has anything for the JS implementation been discussed?
I'm happy to open a separate issue.

v1.1.0 of opentelemetry-configuration was released on 2026-06-05, which includes the IdGenerator definition and the Prometheus property rename. Switch the codegen pin from the temporary main SHA back to a tagged release. Regenerated types and validator. Assisted-by: Claude Opus 4.6

maryliag · 2026-06-05T17:04:36Z

Do you know of prior discussions around this?

I'm not aware, and we haven't discussed how we will handle this in the JS

MikeGoldsmith · 2026-06-05T17:18:49Z

I'm also unaware of any discussion around how implementations could / should support multiple versions of the config spec. The spec shouldn't introduce any breaking changes in minor versions, so major config version to major JS package version makes sense.

…omments Trent's review feedback on open-telemetry#6781: the eslint config v10 update (open-telemetry#6382) accidentally added the generated config files to the ignore list, so npm run lint:fix in the codegen no longer ran on them. This produced formatting noise in generated types.ts. - Remove the experimental/packages/configuration/src/generated/** ignore from eslint.config.mjs so lint:fix runs on these files - Drop the now-redundant /* eslint-disable */ header in validator.js and validator.d.ts (lint:fix handles formatting; the AUTO-GENERATED comment signals intent) - Regenerate types and validator with the corrected lint Assisted-by: Claude Opus 4.6

Resolve CHANGELOG conflict by keeping the PR's Unreleased breaking change entry alongside the new 0.219.0 release section from main.

…hema-prometheus-rename

trentm

And since we're not yet passing through options to new PrometheusMetricExporter() for env-based config, nor handling meter_provider/readers/*/pull at all in the config, there are no changes needed to sdk-node yet.

trentm

@MikeGoldsmith Oh, wait. Shouldn't this come with changing over the file_format guard to require "1.1" and all test and example config files to use file_format: "1.1" as at https://github.com/open-telemetry/opentelemetry-configuration/blob/main/examples/otel-getting-started.yaml#L11?

Bumping the schema to v1.1.0 should accept config files declaring `file_format: "1.1"`. Widen the guard to accept any 1.x minor (1.0 and 1.1), since minor versions are backward compatible. Move all test/example fixtures to "1.1" and add explicit coverage for 1.0 acceptance and unsupported-major rejection.

MikeGoldsmith · 2026-06-17T09:16:57Z

@MikeGoldsmith Oh, wait. Shouldn't this come with changing over the file_format guard to require "1.1" and all test and example config files to use file_format: "1.1" as at https://github.com/open-telemetry/opentelemetry-configuration/blob/main/examples/otel-getting-started.yaml#L11?

Yep, you are right. I've updated the version checks to allow both 1.0 and 1.1. Thanks 👍🏻

Follow the configuration versioning spec: reject a config file whose MAJOR version differs, accept any MINOR version within the supported major, and warn (rather than reject) when the MINOR version is newer than this SDK targets. Mirrors the opentelemetry-python behaviour.

trentm · 2026-06-17T15:59:32Z


 ### :boom: Breaking Changes

+* chore(configuration)!: bump config schema to v1.1.0; rename `without_scope_info` → `scope_info_enabled` and `without_target_info/development` → `target_info_enabled/development` on the Prometheus pull exporter (semantics inverted), rename `with_resource_constant_labels` → `resource_constant_labels`. Validate `file_format` per the configuration versioning spec: accept any minor version of major `1` (e.g. `1.0`, `1.1`), warn when the minor version is newer than supported, and reject other major versions. [#6781](https://github.com/open-telemetry/opentelemetry-js/pull/6781) @MikeGoldsmith


Q: is this breaking now? It might not be.

Technically it is a breaking change for anyone who was using prometheus/development config out of the parsed model. However, given that model and the whole config package is experimental and moving from an rc to a stable release, maybe could remove the breaking change flag?

Thanks.

Per the configuration repo's versioning doc, anything */development isn't considered a semver breaking change.

Co-authored-by: Trent Mick <trentm@gmail.com>

MikeGoldsmith requested a review from a team as a code owner June 3, 2026 11:42

This was referenced Jun 3, 2026

feat(sdk-node): wire up id_generator from declarative config #6782

Merged

Release 1.1.0 open-telemetry/opentelemetry-configuration#643

Closed

trentm reviewed Jun 3, 2026

View reviewed changes

Comment thread experimental/packages/configuration/src/generated/types.ts

trentm reviewed Jun 3, 2026

View reviewed changes

Comment thread experimental/packages/configuration/scripts/generate-config.js Outdated

MikeGoldsmith marked this pull request as draft June 5, 2026 11:03

MikeGoldsmith changed the title ~~chore(configuration)!: bump config schema to main SHA, apply Prometheus property rename~~ chore(configuration)!: bump config schema to v1.1.0, apply Prometheus property rename Jun 5, 2026

MikeGoldsmith marked this pull request as ready for review June 5, 2026 16:37

maryliag reviewed Jun 8, 2026

View reviewed changes

Comment thread eslint.config.mjs

maryliag approved these changes Jun 9, 2026

View reviewed changes

MikeGoldsmith added 2 commits June 12, 2026 15:57

Merge upstream/main into mike/bump-config-schema-prometheus-rename

97d7b50

Resolve CHANGELOG conflict by keeping the PR's Unreleased breaking change entry alongside the new 0.219.0 release section from main.

Merge remote-tracking branch 'upstream/main' into mike/bump-config-sc…

aea359d

…hema-prometheus-rename

MikeGoldsmith mentioned this pull request Jun 16, 2026

Define stability criteria and plan for the configuration package and startNodeSDK() #6808

Open

ci: ignore nested scripts/ dirs in codecov coverage

78a7195

JacksonWeber approved these changes Jun 16, 2026

View reviewed changes

trentm approved these changes Jun 17, 2026

View reviewed changes

trentm requested changes Jun 17, 2026

View reviewed changes

trentm approved these changes Jun 17, 2026

View reviewed changes

Update experimental/packages/configuration/src/FileConfigFactory.ts

32f5499

Co-authored-by: Trent Mick <trentm@gmail.com>

MikeGoldsmith changed the title ~~chore(configuration)!: bump config schema to v1.1.0, apply Prometheus property rename~~ chore(configuration): bump config schema to v1.1.0, apply Prometheus property rename Jun 18, 2026

drop ! from changelog entry; move from breaking to features

b92a6df

trentm approved these changes Jun 18, 2026

View reviewed changes

trentm added this pull request to the merge queue Jun 18, 2026

github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch Jun 18, 2026

Merge branch 'main' into mike/bump-config-schema-prometheus-rename

938c1b8

trentm changed the title ~~chore(configuration): bump config schema to v1.1.0, apply Prometheus property rename~~ feat(configuration): bump config schema to v1.1.0, apply Prometheus property rename Jun 18, 2026

trentm enabled auto-merge June 18, 2026 21:51

trentm added this pull request to the merge queue Jun 18, 2026

Merged via the queue into open-telemetry:main with commit e6e5e19 Jun 18, 2026
31 checks passed

MikeGoldsmith added this to Declarative Configuration: JavaScript Jun 19, 2026

github-project-automation Bot moved this to Done in Declarative Configuration: JavaScript Jun 19, 2026

This was referenced Jun 19, 2026

docs(configuration): add declarative config example for startNodeSDK() #6834

Open

docs(configuration): link README to the cross-SDK language support status doc #6846

Merged

otelbot-js Bot mentioned this pull request Jul 2, 2026

chore: prepare next release #6869

Merged


		### :boom: Breaking Changes

		* chore(configuration)!: bump config schema to v1.1.0; rename `without_scope_info` → `scope_info_enabled` and `without_target_info/development` → `target_info_enabled/development` on the Prometheus pull exporter (semantics inverted), rename `with_resource_constant_labels` → `resource_constant_labels`. Validate `file_format` per the configuration versioning spec: accept any minor version of major `1` (e.g. `1.0`, `1.1`), warn when the minor version is newer than supported, and reject other major versions. [#6781](https://github.com/open-telemetry/opentelemetry-js/pull/6781) @MikeGoldsmith

Uh oh!

Conversation

MikeGoldsmith commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Which problem is this PR solving?

Short description of the changes

Breaking change?

Type of change

How Has This Been Tested?

Uh oh!

codecov Bot commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

MikeGoldsmith commented Jun 3, 2026

Uh oh!

Uh oh!

Uh oh!

trentm commented Jun 3, 2026

Side Q on versioning the config

Uh oh!

maryliag commented Jun 5, 2026

Uh oh!

MikeGoldsmith commented Jun 5, 2026

Uh oh!

Uh oh!

trentm left a comment

Choose a reason for hiding this comment

Uh oh!

trentm left a comment

Choose a reason for hiding this comment

Uh oh!

MikeGoldsmith commented Jun 17, 2026

Uh oh!

Uh oh!

Uh oh!

trentm Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

MikeGoldsmith Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

trentm Jun 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MikeGoldsmith commented Jun 3, 2026 •

edited

Loading

codecov Bot commented Jun 3, 2026 •

edited

Loading