opentelemetry-sdk: activate instrumentors from declarative config#5372
Open
ocelotl wants to merge 12 commits into
Open
opentelemetry-sdk: activate instrumentors from declarative config#5372ocelotl wants to merge 12 commits into
ocelotl wants to merge 12 commits into
Conversation
This was referenced Jun 30, 2026
MikeGoldsmith
requested changes
Jul 1, 2026
MikeGoldsmith
left a comment
MikeGoldsmith
left a comment
Member
There was a problem hiding this comment.
Great start @ocelotl - thanks.
github-project-automation
Bot
moved this to Reviewed PRs that need fixes
in Python PR digest
MikeGoldsmith
added
the
config
…g support Add configure_instrumentation() to activate instrumentors listed under instrumentation/development.python in a declarative config file. Each key is resolved via the opentelemetry_instrumentor entry point group and instrument(**opts) is called with the supplied options. An enabled: false value suppresses a library without raising; unknown entry points and instrumentor failures are logged without stopping the others. Wire configure_instrumentation() into configure_sdk() so the python section is applied alongside providers on the declarative config path. Fixes open-telemetry#5361 Assisted-by: Claude Sonnet 4.6
…ass conversion Schema keys like "otlp_file/development" use "/" as a namespace separator for development/experimental features. Python dataclass field names cannot contain "/" so they use "_" (e.g. "otlp_file_development"). Without normalization, the key falls through to additional_properties and triggers an entry-point lookup for "otlp_file/development" (which doesn't exist), rather than using the dedicated _create_otlp_file_development_span_exporter factory function.
If an instrumentor class exposes a config_dataclass attribute, the raw YAML options are run through _dict_to_dataclass before instrument() is called. This reuses the same type-coercion pipeline used for SDK component configuration so instrumentors declare a typed dataclass schema and the SDK handles the rest. Instrumentors without config_dataclass continue to receive options unchanged, preserving backwards compatibility.
…s, expand slash-normalization comment
- Rename walrus variable `v` to `value` (pylint C0103) - Add pylint disable=no-self-use at class level in test file (pylint R6301) - Move `instrumentation` import after `_tracer_provider` in _sdk.py (ruff I001) - Convert `import logging/dataclasses/unittest` to from-imports - Apply ruff format to reformatted lines
- Add inspect.isclass + is_dataclass guard before using the configuration attribute, so non-dataclass values are silently ignored - Skip instrument() when the instrumentor is already active to avoid duplicate-instrumentation warnings when opentelemetry-instrument and declarative config are both in play - Add Instrumentation section to docs/sdk/configuration.rst with instrumentation/development.python YAML example - Add instrumentation/development example to the declarative-config example otel-config.yaml and README
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #5361
Summary
configure_instrumentation()that readsinstrumentation/development.pythonfrom a declarative config file and activates each listed instrumentor via theopentelemetry_instrumentorentry point groupinstrument(**opts)from the YAML;enabled: falsesuppresses a library without errorconfigurationattribute, opts are run through_dict_to_dataclass— the same type-coercion pipeline used for SDK component configuration — before being forwarded toinstrument(); instrumentors withoutconfigurationreceive opts unchanged (backwards compatible)/→_in YAML keys before dataclass field lookup so schema keys likeotlp_file/developmentmap correctly to Python field namesconfigure_instrumentation()intoconfigure_sdk()Test plan
opentelemetry-sdk/tests/_configuration/test_instrumentation.pycovers: no-op on missing config, unknown instrumentor warning, opts forwarding,enabled: false, multiple instrumentors, failure isolation,configurationcoercion,None-field omission, unknown field rejectionpytest opentelemetry-sdk/tests/_configuration/test_instrumentation.py