feat(config): add resource and propagator creation from declarative config by MikeGoldsmith · Pull Request #4979 · open-telemetry/opentelemetry-python

MikeGoldsmith · 2026-03-13T13:11:45Z

Description

Implements step 3 of the declarative configuration work (see below), resource and propagator creation from a parsed config file.

Adds:

create_resource(config) — builds an SDK Resource from the declarative config model without reading OTEL_RESOURCE_ATTRIBUTES. Starts from SDK telemetry defaults (telemetry.sdk.*), merges attributes (with AttributeType coercion) and attributes_list (URL-decoded, lower priority), and adds service.name=unknown_service as the lowest-priority default (detectors and explicit config attributes can override it).
create_propagator(config) — builds a CompositePropagator from the config's composite list and/or composite_list string. Deduplicates by propagator type. Returns an empty CompositePropagator (noop) when no propagator is configured.
configure_propagator(config) — calls set_global_textmap to override Python's default env-var-based propagator setup.
ConfigurationError moved to _exceptions.py to break a circular import introduced when file/__init__.py re-exports the new functions.
_run_detectors() stub and _filter_attributes() — shared foundations for resource detector support. Detectors are opt-in: nothing runs unless explicitly listed under detection_development.detectors in the config. The include/exclude attribute filter mirrors other SDK behaviour. Individual detector PRs build on top of this.

All functions are exported from opentelemetry.sdk._configuration.file.

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

43 new unit tests covering:

All AttributeType coercions (string, bool, int, double, and array variants)
attributes_list parsing: priority vs explicit attributes, URL decoding, = in values, invalid pairs
schema_url passthrough
OTEL_RESOURCE_ATTRIBUTES env var is NOT read
All four built-in propagators (tracecontext, baggage, b3, b3multi)
composite + composite_list merging and deduplication
none and empty entries in composite_list skipped
Missing entry point raises ConfigurationError
configure_propagator calls set_global_textmap

Does This PR Require a Contrib Repo Change?

No.

Checklist:

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

Assisted-by: Claude Sonnet 4.6

Implements create_resource() and create_propagator()/configure_propagator() for the declarative file configuration. Resource creation does not read OTEL_RESOURCE_ATTRIBUTES or run any detectors (matches Java/JS SDK behavior). Propagator configuration always calls set_global_textmap to override Python's default tracecontext+baggage, setting a noop CompositePropagator when no propagator is configured. Assisted-by: Claude Sonnet 4.6

Assisted-by: Claude Sonnet 4.6

- _resource.py: refactor _coerce_attribute_value to dispatch table to avoid too-many-return-statements; fix short variable names k/v -> attr_key/attr_val; fix return type of _sdk_default_attributes to dict[str, str] to satisfy pyright - _propagator.py: rename short variable names e -> exc, p -> propagator - test_resource.py: move imports to top level; split TestCreateResource (25 methods) into three focused classes to satisfy too-many-public-methods - test_propagator.py: add pylint disable for protected-access Assisted-by: Claude Sonnet 4.6

pmcollins

Looks great. Minor comments below.

- replace _sdk_default_attributes() with _DEFAULT_RESOURCE from resources module - move _coerce_bool into dispatch tables for both scalar and array bool types, fixing a bug where bool_array with string values like "false" would coerce incorrectly via plain bool() (non-empty string -> True) - add test for bool_array with string values to cover the bug Assisted-by: Claude Sonnet 4.6

… into mike/config-resource-propagator

…erge - collapse _SCALAR_COERCIONS and _ARRAY_COERCIONS into a single _COERCIONS dict using an _array() factory, reducing _coerce_attribute_value to two lines - process attributes_list before attributes so explicit attributes naturally overwrite list entries without needing an explicit guard Assisted-by: Claude Sonnet 4.6

pmcollins

Thanks, LGTM once suggestions are addressed (I added a typing suggestion).

linux-foundation-easycla · 2026-03-17T16:29:50Z

The committers listed above are authorized under a signed CLA.

✅ login: MikeGoldsmith / name: Mike Goldsmith (103ff08, 16b89b1, 516aecc, 7f51034, 8ba91d8, 9cfdcce, a171842)

MikeGoldsmith · 2026-03-17T16:49:50Z

I think the Misc/tracecontext failure is a flakey test. Please can someone, re-run it for me?

Assisted-by: Claude Sonnet 4.6

…e-propagator

Adds _run_detectors() stub and _filter_attributes() to create_resource(), providing the shared scaffolding for detector PRs to build on. Detectors are opt-in: nothing runs unless explicitly listed under detection_development.detectors in the config. The include/exclude attribute filter mirrors other SDK behaviour. Assisted-by: Claude Sonnet 4.6

Merges service.name=unknown_service into base before running detectors, so detectors (e.g. service) can override it. Previously it was added to config_attrs and merged last, which would have silently overridden any detector-provided service.name. Assisted-by: Claude Sonnet 4.6

Assisted-by: Claude Sonnet 4.6

…ropagator Assisted-by: Claude Sonnet 4.6

Import directly from _exceptions.py since this is new code with no existing dependents on the _loader module path. Assisted-by: Claude Sonnet 4.6

…onfig (open-telemetry#4979) * config: add resource and propagator creation from declarative config Implements create_resource() and create_propagator()/configure_propagator() for the declarative file configuration. Resource creation does not read OTEL_RESOURCE_ATTRIBUTES or run any detectors (matches Java/JS SDK behavior). Propagator configuration always calls set_global_textmap to override Python's default tracecontext+baggage, setting a noop CompositePropagator when no propagator is configured. Assisted-by: Claude Sonnet 4.6 * update changelog with PR number Assisted-by: Claude Sonnet 4.6 * fix pylint, pyright and ruff errors in resource/propagator config - _resource.py: refactor _coerce_attribute_value to dispatch table to avoid too-many-return-statements; fix short variable names k/v -> attr_key/attr_val; fix return type of _sdk_default_attributes to dict[str, str] to satisfy pyright - _propagator.py: rename short variable names e -> exc, p -> propagator - test_resource.py: move imports to top level; split TestCreateResource (25 methods) into three focused classes to satisfy too-many-public-methods - test_propagator.py: add pylint disable for protected-access Assisted-by: Claude Sonnet 4.6 * address review feedback: use _DEFAULT_RESOURCE, fix bool_array coercion - replace _sdk_default_attributes() with _DEFAULT_RESOURCE from resources module - move _coerce_bool into dispatch tables for both scalar and array bool types, fixing a bug where bool_array with string values like "false" would coerce incorrectly via plain bool() (non-empty string -> True) - add test for bool_array with string values to cover the bug Assisted-by: Claude Sonnet 4.6 * fix linter * address review feedback: single coercion table, simplify attributes merge - collapse _SCALAR_COERCIONS and _ARRAY_COERCIONS into a single _COERCIONS dict using an _array() factory, reducing _coerce_attribute_value to two lines - process attributes_list before attributes so explicit attributes naturally overwrite list entries without needing an explicit guard Assisted-by: Claude Sonnet 4.6 * use Callable type annotation on _array helper Assisted-by: Claude Sonnet 4.6 * add detection infrastructure foundations for resource detectors Adds _run_detectors() stub and _filter_attributes() to create_resource(), providing the shared scaffolding for detector PRs to build on. Detectors are opt-in: nothing runs unless explicitly listed under detection_development.detectors in the config. The include/exclude attribute filter mirrors other SDK behaviour. Assisted-by: Claude Sonnet 4.6 * move service.name default into base resource Merges service.name=unknown_service into base before running detectors, so detectors (e.g. service) can override it. Previously it was added to config_attrs and merged last, which would have silently overridden any detector-provided service.name. Assisted-by: Claude Sonnet 4.6 * remove unused logging import from _propagator.py Assisted-by: Claude Sonnet 4.6 * add test verifying OTEL_PROPAGATORS env var is ignored by configure_propagator Assisted-by: Claude Sonnet 4.6 * remove backwards compat re-export of ConfigurationError from _loader.py Import directly from _exceptions.py since this is new code with no existing dependents on the _loader module path. Assisted-by: Claude Sonnet 4.6

MikeGoldsmith requested a review from a team as a code owner March 13, 2026 13:11

github-project-automation Bot added this to Python PR digest Mar 13, 2026

MikeGoldsmith moved this to Ready for review in Python PR digest Mar 13, 2026

MikeGoldsmith added 2 commits March 13, 2026 13:12

update changelog with PR number

8232012

Assisted-by: Claude Sonnet 4.6

pmcollins reviewed Mar 13, 2026

View reviewed changes

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py Outdated

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py Outdated

MikeGoldsmith added 3 commits March 16, 2026 12:56

fix linter

8232d48

Merge branch 'main' of github.com:open-telemetry/opentelemetry-python…

6ed3425

… into mike/config-resource-propagator

herin049 reviewed Mar 16, 2026

View reviewed changes

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py Outdated

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py

MikeGoldsmith mentioned this pull request Mar 16, 2026

feat(config): Add TracerProvider support for declarative config #4985

Merged

10 tasks

MikeGoldsmith mentioned this pull request Mar 16, 2026

feat(config): Add MeterProvider support for declarative config #4987

Merged

10 tasks

pmcollins approved these changes Mar 16, 2026

View reviewed changes

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py Outdated

MikeGoldsmith mentioned this pull request Mar 17, 2026

feat(config): Add LoggerProvider support for declarative config #4990

Merged

10 tasks

MikeGoldsmith force-pushed the mike/config-resource-propagator branch 2 times, most recently from 85575ff to 430ae83 Compare March 17, 2026 16:35

herin049 reviewed Mar 17, 2026

View reviewed changes

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_logger_provider.py Outdated

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_logger_provider.py Outdated

xrmx mentioned this pull request Mar 20, 2026

Add declarative configuration prototype #3631

Open

22 tasks

This was referenced Mar 20, 2026

feat(config): add process resource detector support for declarative config #5001

Merged

feat(config): add host resource detector support for declarative config #5002

Merged

feat(config): add service resource detector support for declarative config #5003

Merged

MikeGoldsmith added 4 commits March 20, 2026 14:18

use Callable type annotation on _array helper

8ba91d8

Assisted-by: Claude Sonnet 4.6

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

516aecc

…e-propagator

MikeGoldsmith force-pushed the mike/config-resource-propagator branch from 367aa82 to 103ff08 Compare March 20, 2026 14:20

MikeGoldsmith mentioned this pull request Mar 20, 2026

feat(config): wire container resource detector via entry point loading #5004

Merged

10 tasks

remove unused logging import from _propagator.py

7f51034

Assisted-by: Claude Sonnet 4.6

tammy-baylis-swi reviewed Mar 20, 2026

View reviewed changes

Comment thread opentelemetry-sdk/tests/_configuration/test_propagator.py

herin049 approved these changes Mar 21, 2026

View reviewed changes

xrmx reviewed Mar 24, 2026

View reviewed changes

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/_loader.py Outdated

MikeGoldsmith added 2 commits March 24, 2026 22:38

add test verifying OTEL_PROPAGATORS env var is ignored by configure_p…

16b89b1

…ropagator Assisted-by: Claude Sonnet 4.6

remove backwards compat re-export of ConfigurationError from _loader.py

a171842

Import directly from _exceptions.py since this is new code with no existing dependents on the _loader module path. Assisted-by: Claude Sonnet 4.6

xrmx approved these changes Mar 25, 2026

View reviewed changes

xrmx merged commit 6929c69 into open-telemetry:main Mar 25, 2026
508 checks passed

github-project-automation Bot moved this from Ready for review to Done in Python PR digest Mar 25, 2026

MikeGoldsmith added the config Issues and PRs related to implementing Declarative Config label Apr 8, 2026

MikeGoldsmith deleted the mike/config-resource-propagator branch April 9, 2026 14:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(config): add resource and propagator creation from declarative config#4979

feat(config): add resource and propagator creation from declarative config#4979
xrmx merged 14 commits intoopen-telemetry:mainfrom
MikeGoldsmith:mike/config-resource-propagator

MikeGoldsmith commented Mar 13, 2026 •

edited

Loading

Uh oh!

pmcollins left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmcollins left a comment

Uh oh!

Uh oh!

linux-foundation-easycla Bot commented Mar 17, 2026 •

edited

Loading

Uh oh!

MikeGoldsmith commented Mar 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

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

Uh oh!

Description

Type of change

How Has This Been Tested?

Does This PR Require a Contrib Repo Change?

Checklist:

Uh oh!

pmcollins left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmcollins left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

linux-foundation-easycla Bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MikeGoldsmith commented Mar 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

MikeGoldsmith commented Mar 13, 2026 •

edited

Loading

pmcollins left a comment •

edited

Loading

linux-foundation-easycla Bot commented Mar 17, 2026 •

edited

Loading