Skip to content

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

Open
MikeGoldsmith wants to merge 16 commits intoopen-telemetry:mainfrom
MikeGoldsmith:mike/config-resource-detector-service
Open

feat(config): add service resource detector support for declarative config#5003
MikeGoldsmith wants to merge 16 commits intoopen-telemetry:mainfrom
MikeGoldsmith:mike/config-resource-detector-service

Conversation

@MikeGoldsmith
Copy link
Copy Markdown
Member

@MikeGoldsmith MikeGoldsmith commented Mar 20, 2026 •
edited
Loading

Description

Implements service resource detector support in create_resource() for the declarative configuration pipeline, as part of the ongoing work tracked in the following PRs:

What's included

  • Wires detection_development.detectors[].service via _run_detectors():
    • Sets service.instance.id to a random UUID on every process start
    • Reads OTEL_SERVICE_NAME env var for service.name if set (mirrors other SDK behaviour)
  • Explicit config attributes always take priority over detector-provided values
  • service.name=unknown_service default is set at the lowest priority so any detector or explicit attribute can override it
  • 9 new tests covering instance ID uniqueness, env var reading, explicit attribute override, opt-in behaviour, and attribute filtering

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • 9 unit tests in tests/_configuration/test_resource.py
  • Includes explicit tests that the detector does not run when detection_development or detectors is absent

Does This PR Require a Contrib Repo Change?

  • Yes.
  • 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

@MikeGoldsmith
config: add resource and propagator creation from declarative config
5c26f00 
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
@MikeGoldsmith
update changelog with PR number
8232012 
Assisted-by: Claude Sonnet 4.6
@MikeGoldsmith
fix pylint, pyright and ruff errors in resource/propagator config
8329ae4 
- _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
@MikeGoldsmith
address review feedback: use _DEFAULT_RESOURCE, fix bool_array coercion
506d816 
- 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
@MikeGoldsmith
fix linter
8232d48
@MikeGoldsmith
Merge branch 'main' of github.com:open-telemetry/opentelemetry-python…
6ed3425 
… into mike/config-resource-propagator
@MikeGoldsmith
address review feedback: single coercion table, simplify attributes m…
99753f9 
…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
@MikeGoldsmith
use Callable type annotation on _array helper
8ba91d8 
Assisted-by: Claude Sonnet 4.6
@MikeGoldsmith
Merge remote-tracking branch 'upstream/main' into mike/config-resourc…
516aecc 
…e-propagator
@MikeGoldsmith
add detection infrastructure foundations for resource detectors
9cfdcce 
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
@MikeGoldsmith
move service.name default into base resource
103ff08 
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
@MikeGoldsmith MikeGoldsmith force-pushed the mike/config-resource-detector-service branch from b62c43c to a2b7031 Compare March 20, 2026 14:26
MikeGoldsmith added a commit to MikeGoldsmith/opentelemetry-python that referenced this pull request Mar 20, 2026
@MikeGoldsmith
add changelog entry for service resource detector (open-telemetry#5003)
6fd726b 
Assisted-by: Claude Sonnet 4.6
@MikeGoldsmith
remove unused logging import from _propagator.py
7f51034 
Assisted-by: Claude Sonnet 4.6
@MikeGoldsmith
wire service resource detector in declarative config
6a6f6df 
Adds service detector support to _run_detectors(): sets a random UUID
for service.instance.id and reads OTEL_SERVICE_NAME for service.name
if set. Explicit config attributes still take priority (merged last).

Assisted-by: Claude Sonnet 4.6
@MikeGoldsmith
add changelog entry for service resource detector (open-telemetry#5003)
2306b93 
Assisted-by: Claude Sonnet 4.6
@MikeGoldsmith MikeGoldsmith force-pushed the mike/config-resource-detector-service branch from 6fd726b to 2306b93 Compare March 20, 2026 19:46
@MikeGoldsmith MikeGoldsmith marked this pull request as ready for review March 29, 2026 16:33
@MikeGoldsmith MikeGoldsmith requested a review from a team as a code owner March 29, 2026 16:33
@MikeGoldsmith MikeGoldsmith mentioned this pull request Mar 31, 2026
Open
1 task
@MikeGoldsmith
merge upstream/main
4de33e5 
Assisted-by: Claude Sonnet 4.6
@MikeGoldsmith MikeGoldsmith moved this to Approved PRs in Python PR digest Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tammy-baylis-swi tammy-baylis-swi tammy-baylis-swi approved these changes

Assignees

No one assigned

Labels

None yet

Projects

Python PR digest
Status: Approved PRs

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@MikeGoldsmith @tammy-baylis-swi