Promote DeclarativeConfigProperties, DeclarativeConfigException, ComponentProvider to stable by rooks-ns · Pull Request #8981 · open-telemetry/opentelemetry-java

rooks-ns · 2026-10-27T22:42:34Z

Resolves part of #6970

Description

Promotes API models to opentelemetry-api: Promotes DeclarativeConfigProperties and DeclarativeConfigException to io.opentelemetry.api.config.
Promotes SPI to opentelemetry-sdk-extension-autoconfigure-spi: Promotes ComponentProvider to io.opentelemetry.sdk.autoconfigure.spi.declarativeconfig.ComponentProvider.
Preserves standalone legacy deprecation path:
- Retains io.opentelemetry.api.incubator.config.DeclarativeConfigProperties and DeclarativeConfigException marked @Deprecated (scheduled for removal after 1.68.0) as standalone classes with zero inheritance to prevent JVM bytecode descriptor mismatches for pre-compiled binaries.
- Retains io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider marked @Deprecated (scheduled for removal after 1.68.0) as a standalone interface without inheritance.
Updates declarative configuration loader:
- Updates DeclarativeConfigContext.loadComponent to discover both modern and legacy ComponentProvider implementations.
- Enforces fail-fast duplicate provider checking when multiple providers match (type, name).
- Adapts modern configuration to legacy providers via package-private LegacyYamlDeclarativeConfigProperties in sdk-extensions:declarative-config.
Package metadata & cleanup:
- Adds package-info.java enforcing @ParametersAreNonnullByDefault to io.opentelemetry.api.config and io.opentelemetry.sdk.autoconfigure.spi.declarativeconfig.
- Migrates all in-repo component providers, META-INF/services/ registrations, and OSGi manifests across exporters, extensions, and declarative config.
- Unexempts opentelemetry-exporter-logging from NoSharedInternalCodeTest.

Notes

ConfigProvider and ExtendedOpenTelemetry in api:incubator are updated to return the graduated io.opentelemetry.api.config.DeclarativeConfigProperties.

otelbot · 2026-10-27T22:42:47Z

⚠️ API changes detected — additional maintainer review required

@jack-berg @jkwatson

This PR modifies the public API surface area of the following module(s):

opentelemetry-api
opentelemetry-sdk-extension-autoconfigure-spi

Please review the changes in docs/apidiffs/current_vs_latest/ carefully before approving.

opentelemetry-pr-dashboard · 2026-10-27T22:43:09Z

Pull request dashboard status

Merged · refreshed 2026-11-12 23:06 UTC

Status above doesn't look right?

Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

codecov · 2026-10-27T22:59:18Z

Codecov Report

❌ Patch coverage is 98.56115% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.46%. Comparing base (f646d4b) to head (94c3a55).

Files with missing lines	Patch %	Lines
...etry/api/config/DeclarativeConfigPropertyUtil.java	97.29%	1 Missing ⚠️
...re/declarativeconfig/DeclarativeConfigContext.java	96.87%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #8981      +/-   ##
============================================
+ Coverage     90.41%   90.46%   +0.05%     
- Complexity    11069    11152      +83     
============================================
  Files          1023     1028       +5     
  Lines         30254    30382     +128     
  Branches       3952     3966      +14     
============================================
+ Hits          27353    27486     +133     
+ Misses         1933     1922      -11     
- Partials        968      974       +6

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

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

- Atomically promote DeclarativeConfigProperties and DeclarativeConfigException to io.opentelemetry.api.config in opentelemetry-api. - Retain deprecated backward-compatibility shims for DeclarativeConfigProperties and DeclarativeConfigException in opentelemetry-api-incubator. - Promote ComponentProvider interface to io.opentelemetry.sdk.autoconfigure.spi.declarativeconfig in opentelemetry-sdk-extension-autoconfigure-spi. - Retain deprecated io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider extending the new interface with bidirectional default bridge methods for backward compatibility with external plugins. - Update DeclarativeConfigContext to discover both modern and legacy providers with (type, name) deduplication. - Migrate all repository providers, META-INF/services/ descriptors, and OSGi service loader manifests across exporters, extensions, and declarative config. - Unexempt opentelemetry-exporter-logging from NoSharedInternalCodeTest. - Update opentelemetry-api and autoconfigure-spi jApiCmp baseline diffs.

@deprecated

- Restore standalone io.opentelemetry.api.incubator.config.DeclarativeConfigProperties marked @deprecated (scheduled for removal after 1.68.0) to preserve bytecode compatibility without interface inheritance. - Restore standalone io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider marked @deprecated without extending the new stable SPI. - Introduce LegacyYamlDeclarativeConfigProperties in sdk-extensions:declarative-config adapting modern config for legacy component providers. - Delete IncubatorDeclarativeConfigPropertiesAdapter and obsolete dynamic configuration TODO comment on declarativeconfig.ComponentProvider. - Enforce fail-fast duplicate provider checking in DeclarativeConfigContext when multiple providers match (type, name).

jack-berg

Looking good, just two minor nits

Thanks!

FYI @open-telemetry/java-instrumentation-approvers - the package is changing for DeclarativeConfigProperties and DeclarativeConfigException, which will require migration on the instrumentation side. ComponentProvider is also being stabilized.

Since there are some opentelemetry-java-contrib components that implement ComponentProvider, we can't migrate all implementations at once, so this PR retains the old version of ComponentProvider, DeclarativeConfigProperties, DeclarativeConfigException as deprecated for a release cycle to allow migration.

…fig package - Move DeclarativeConfigPropertyUtilTest and InstrumentationConfigUtilTest from io.opentelemetry.api.incubator.config to io.opentelemetry.api.config in api:incubator test source set.

jack-berg · 2026-11-03T21:06:06Z

Also cc @jkwatson. This adds new public API surface area

…y-java into fix/avoid-shared-internal-component-provider

otelbot · 2026-11-12T23:06:18Z

Thank you for your contribution @rooks-ns! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

otelbot Bot added the api-change Changes to public API surface area label Oct 27, 2026

opentelemetry-pr-dashboard Bot mentioned this pull request Oct 27, 2026

Pull Request Dashboard #8439

Open

rooks-ns force-pushed the fix/avoid-shared-internal-component-provider branch 3 times, most recently from 8478c4d to 0f1785e Compare October 28, 2026 04:00

rooks-ns marked this pull request as ready for review October 28, 2026 04:35

rooks-ns requested a review from a team as a code owner October 28, 2026 04:35

jack-berg reviewed Oct 29, 2026

View reviewed changes

Comment thread ...rc/main/java/io/opentelemetry/sdk/autoconfigure/spi/declarativeconfig/ComponentProvider.java Resolved

rooks-ns force-pushed the fix/avoid-shared-internal-component-provider branch from 0f1785e to 83f655e Compare November 2, 2026 03:35

rooks-ns force-pushed the fix/avoid-shared-internal-component-provider branch from 83f655e to 6a9d67c Compare November 2, 2026 05:42

jack-berg reviewed Nov 2, 2026

View reviewed changes

jack-berg approved these changes Nov 3, 2026

View reviewed changes

Comment thread api/incubator/src/test/java/io/opentelemetry/api/config/DeclarativeConfigPropertyUtilTest.java Resolved

Comment thread ...tor/src/test/java/io/opentelemetry/api/incubator/config/DeclarativeConfigPropertiesTest.java Resolved

jack-berg changed the title ~~Avoid shared internal ComponentProvider (#6970)~~ Promote DeclarativeConfigProperties, DeclarativeConfigException, ComponentProvider to stable Nov 3, 2026

Relocate declarative config utility tests to io.opentelemetry.api.con…

5f2c796

…fig package - Move DeclarativeConfigPropertyUtilTest and InstrumentationConfigUtilTest from io.opentelemetry.api.incubator.config to io.opentelemetry.api.config in api:incubator test source set.

rooks-ns force-pushed the fix/avoid-shared-internal-component-provider branch from 417e5e8 to 5f2c796 Compare November 3, 2026 16:57

jack-berg mentioned this pull request Nov 3, 2026

Make declarative config parsing and mapping pluggable #8983

Merged

This comment has been minimized.

Sign in to view

Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…

94c3a55

…y-java into fix/avoid-shared-internal-component-provider

jack-berg enabled auto-merge (squash) November 12, 2026 22:36

jack-berg merged commit 95f25dd into open-telemetry:main Nov 12, 2026
34 checks passed

Navigation Menu

Repository navigation

Promote DeclarativeConfigProperties, DeclarativeConfigException, ComponentProvider to stable - #8981

Promote DeclarativeConfigProperties, DeclarativeConfigException, ComponentProvider to stable#8981
jack-berg merged 4 commits into
open-telemetry:mainfrom
rooks-ns:fix/avoid-shared-internal-component-provider

rooks-ns commented Oct 27, 2026 •

edited

Loading

Uh oh!

otelbot Bot commented Oct 27, 2026 •

edited

Loading

Uh oh!

opentelemetry-pr-dashboard Bot commented Oct 27, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Oct 27, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jack-berg left a comment

Uh oh!

Uh oh!

Uh oh!

jack-berg commented Nov 3, 2026

Uh oh!

This comment has been minimized.

Uh oh!

otelbot Bot commented Nov 12, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

rooks-ns commented Oct 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes

Uh oh!

otelbot Bot commented Oct 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ API changes detected — additional maintainer review required

Uh oh!

opentelemetry-pr-dashboard Bot commented Oct 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request dashboard status

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jack-berg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jack-berg commented Nov 3, 2026

Uh oh!

This comment has been minimized.

Uh oh!

otelbot Bot commented Nov 12, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rooks-ns commented Oct 27, 2026 •

edited

Loading

otelbot Bot commented Oct 27, 2026 •

edited

Loading

opentelemetry-pr-dashboard Bot commented Oct 27, 2026 •

edited

Loading

codecov Bot commented Oct 27, 2026 •

edited

Loading