feat(config): add configure_sdk orchestrator for declarative config#5270
Merged
lzchen merged 18 commits intoJun 15, 2026
Conversation
Adds `_dict_to_dataclass` in `_conversion.py` which walks each field's type annotation and converts: - nested dicts → typed dataclass instances - lists of dicts → lists of typed dataclasses - string/value → Enum members (e.g. log_level: info) - unknown keys → routed to the @_additional_properties decorator The loader's `_dict_to_model` now produces a fully-typed OpenTelemetryConfiguration tree end-to-end. Factory functions can rely on typed attribute access (config.tracer_provider.processors[0].batch .exporter.otlp_http.endpoint) instead of failing on raw dicts. This closes the gap between load_config_file() and the factory functions — YAML/JSON config → SDK objects now works end-to-end. Closes open-telemetry#5127 Assisted-by: Claude Opus 4.6
- Use TypeVar for _dict_to_dataclass return — callers now get the correct type instead of Any - Use collections.abc.Mapping for input (more permissive than dict) - Add explicit is_dataclass check at entry — raises TypeError with a descriptive message instead of failing later in dataclasses.fields Assisted-by: Claude Opus 4.6
Astroid 3.x (used by pylint 3.x) follows typing.get_type_hints into Python 3.14's annotationlib, which contains t-string literals it can't parse and crashes with AttributeError on 'visit_templatestr'. Wrapping the call in a helper that returns dict[str, Any] stops the inference at the declared return type. Assisted-by: Claude Opus 4.7
Same effect as the prior helper — declaring the local as ``dict[str, Any]`` stops astroid's inference at the annotation rather than tracing into the typing internals. Assisted-by: Claude Opus 4.7
Single entry point that takes a parsed OpenTelemetryConfiguration, builds the resource, and applies the tracer/meter/logger providers and propagator globally. Honors the top-level disabled flag — when true, no globals are touched. The orchestrator is a thin composition of the existing per-signal configure_* factories; the deeper unification with the env-var path (see open-telemetry#5126) is left for follow-up. Refs open-telemetry#3631 Refs open-telemetry#5126 Assisted-by: Claude Opus 4.7
Assisted-by: Claude Opus 4.7
This was referenced Jun 3, 2026
… codespell Replace the bespoke _Level enum (which violated pylint's invalid-name on lowercase members) with the real ExemplarFilter enum from models.py — the generated models use lowercase values verbatim from the JSON schema, so using one of them avoids fighting the linter and exercises the same code path with real data shapes. Add 'astroid' to codespell's ignore-words-list; the prior commit's explanatory comment mentions the library by name and codespell flagged it as a misspelling of 'asteroid'. Assisted-by: Claude Opus 4.7
Move ``SdkTracerProvider`` import to module top (ruff PLC0415 / pylint C0415) and add explicit ``# pylint: disable=no-self-use`` on the three mock-only tests that intentionally do not touch ``self``. Assisted-by: Claude Opus 4.7
Assisted-by: Claude Opus 4.7
11 tasks
The conversion module has unit tests that exercise _dict_to_dataclass
in isolation, but nothing verified the full pipeline: load a real
YAML file, get back fully-typed nested dataclasses, and feed the
result into a downstream factory function.
Adds two checks built on a representative nested fixture (tracer
provider with a parent-based / trace-id-ratio sampler and a batch
processor with console exporter):
- nested fields (sampler, processors[*].batch) come back as the
expected typed dataclasses, not raw dicts
- the typed result is accepted by ``create_tracer_provider`` and
produces an SDK ``TracerProvider``
This is the integration coverage requested in PR review feedback;
the inline example in the PR description is now an actual regression
test.
Assisted-by: Claude Opus 4.7
DylanRussell
approved these changes
Jun 8, 2026
herin049
approved these changes
Jun 9, 2026
- log a warning rather than info when called with disabled=true; the caller asked for setup and got a no-op, so the noise is warranted - drop test_disabled_false_runs_setup; test_calls_each_signal_with_resource already covers the disabled=False path with stricter assertions Assisted-by: Claude Opus 4.7 (1M context)
callers with pathlib.Path no longer have to coerce to str at the boundary. Path(file_path) and everything downstream already handle PathLike, so this is a signature-only change. Assisted-by: Claude Opus 4.7 (1M context)
DylanRussell
reviewed
Jun 9, 2026
Resolve conflict in test_loader.py by keeping main's end-to-end factory assertions from open-telemetry#5269 alongside the PR branch's loader integration tests.
Use types.UnionType and typing.Union for optional unwrapping instead of importing Union directly, matching modern | syntax in type hints.
github-project-automation
Bot
moved this from Ready for merge
to Done
in Python PR digest
MikeGoldsmith
added a commit
to MikeGoldsmith/opentelemetry-python
that referenced
this pull request
Jun 19, 2026
…telemetry#5271) * recursively convert parsed dicts to typed dataclasses in loader Adds `_dict_to_dataclass` in `_conversion.py` which walks each field's type annotation and converts: - nested dicts → typed dataclass instances - lists of dicts → lists of typed dataclasses - string/value → Enum members (e.g. log_level: info) - unknown keys → routed to the @_additional_properties decorator The loader's `_dict_to_model` now produces a fully-typed OpenTelemetryConfiguration tree end-to-end. Factory functions can rely on typed attribute access (config.tracer_provider.processors[0].batch .exporter.otlp_http.endpoint) instead of failing on raw dicts. This closes the gap between load_config_file() and the factory functions — YAML/JSON config → SDK objects now works end-to-end. Closes open-telemetry#5127 Assisted-by: Claude Opus 4.6 * rename changelog fragment to PR open-telemetry#5269 * tighten typing on conversion module - Use TypeVar for _dict_to_dataclass return — callers now get the correct type instead of Any - Use collections.abc.Mapping for input (more permissive than dict) - Add explicit is_dataclass check at entry — raises TypeError with a descriptive message instead of failing later in dataclasses.fields Assisted-by: Claude Opus 4.6 * isolate typing.get_type_hints call to placate astroid 3.x on py3.14 Astroid 3.x (used by pylint 3.x) follows typing.get_type_hints into Python 3.14's annotationlib, which contains t-string literals it can't parse and crashes with AttributeError on 'visit_templatestr'. Wrapping the call in a helper that returns dict[str, Any] stops the inference at the declared return type. Assisted-by: Claude Opus 4.7 * inline the typing.get_type_hints wrap Same effect as the prior helper — declaring the local as ``dict[str, Any]`` stops astroid's inference at the annotation rather than tracing into the typing internals. Assisted-by: Claude Opus 4.7 * add configure_sdk orchestrator for declarative config Single entry point that takes a parsed OpenTelemetryConfiguration, builds the resource, and applies the tracer/meter/logger providers and propagator globally. Honors the top-level disabled flag — when true, no globals are touched. The orchestrator is a thin composition of the existing per-signal configure_* factories; the deeper unification with the env-var path (see open-telemetry#5126) is left for follow-up. Refs open-telemetry#3631 Refs open-telemetry#5126 Assisted-by: Claude Opus 4.7 * rename changelog fragment to PR open-telemetry#5270 Assisted-by: Claude Opus 4.7 * honor OTEL_CONFIG_FILE in the SDK configurator When the environment variable is set, route the SDK through the declarative config path — load the file via load_config_file() and apply it via configure_sdk() — in place of the env-var-based _initialize_components(). Other OTEL_* vars are ignored (per spec v1.0.0: when a config file is given, it is the sole source of truth). Kwargs passed to _OTelSDKConfigurator._configure are ignored with a warning when the file path is set, so distros that inject kwargs via super() see a clear signal rather than silent drops. The file-loader imports (pyyaml, jsonschema) stay lazy so installs without the file-configuration extras are not affected. Refs open-telemetry#3631 Assisted-by: Claude Opus 4.7 * rename changelog fragment to PR open-telemetry#5271 Assisted-by: Claude Opus 4.7 * use ExemplarFilter for enum coercion test fixture; allow 'astroid' in codespell Replace the bespoke _Level enum (which violated pylint's invalid-name on lowercase members) with the real ExemplarFilter enum from models.py — the generated models use lowercase values verbatim from the JSON schema, so using one of them avoids fighting the linter and exercises the same code path with real data shapes. Add 'astroid' to codespell's ignore-words-list; the prior commit's explanatory comment mentions the library by name and codespell flagged it as a misspelling of 'asteroid'. Assisted-by: Claude Opus 4.7 * fix lint on test_sdk.py: hoist import, disable no-self-use Move ``SdkTracerProvider`` import to module top (ruff PLC0415 / pylint C0415) and add explicit ``# pylint: disable=no-self-use`` on the three mock-only tests that intentionally do not touch ``self``. Assisted-by: Claude Opus 4.7 * silence pylint/ruff on intentional lazy imports The configure_sdk / load_config_file imports inside ``_configure`` are deliberately deferred so that the SDK does not pull in the optional file-configuration extras (pyyaml, jsonschema) unless ``OTEL_CONFIG_FILE`` is actually set. Annotate with the corresponding pylint and ruff suppressions; the existing comment already explains why. Assisted-by: Claude Opus 4.7 * remove extra blank line after imports (ruff I001) Assisted-by: Claude Opus 4.7 * collapse multi-line @patch decorators (ruff format) Assisted-by: Claude Opus 4.7 * add end-to-end loader tests covering YAML -> typed config -> factory The conversion module has unit tests that exercise _dict_to_dataclass in isolation, but nothing verified the full pipeline: load a real YAML file, get back fully-typed nested dataclasses, and feed the result into a downstream factory function. Adds two checks built on a representative nested fixture (tracer provider with a parent-based / trace-id-ratio sampler and a batch processor with console exporter): - nested fields (sampler, processors[*].batch) come back as the expected typed dataclasses, not raw dicts - the typed result is accepted by ``create_tracer_provider`` and produces an SDK ``TracerProvider`` This is the integration coverage requested in PR review feedback; the inline example in the PR description is now an actual regression test. Assisted-by: Claude Opus 4.7 * address review feedback on OTEL_CONFIG_FILE routing Use a walrus operator in _configure, simplify singleton reset to tearDown only, and hoist no-self-use pylint disable to file scope. * tighten OTEL_CONFIG_FILE docstring (review feedback from herin049) The previous wording overstated the env-var contract by implying all ``OTEL_*`` variables are ignored when ``OTEL_CONFIG_FILE`` is set. That's only true for spec-defined variables with schema equivalents: * resource detectors enabled in the config can still read env vars at runtime (e.g. ``OTEL_RESOURCE_ATTRIBUTES``, ``OTEL_SERVICE_NAME``) * ``${env:VAR}`` substitutions inside the file remain in effect Reword to be precise about both. Assisted-by: Claude Opus 4.7
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
4 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.
Description
Adds
configure_sdk(config)— a single entry point that takes a parsedOpenTelemetryConfigurationand applies it by:disabledflag (no-op when true)create_resourceconfigure_tracer_provider,configure_meter_provider,configure_logger_provider, andconfigure_propagatorin orderThis is the first slice of #5126 — wiring the existing per-signal factories into one orchestrator. Env-var-to-config adapter and unification with
_initialize_componentsare deferred to follow-up PRs.Refs #3631
Refs #5126
Type of change
How Has This Been Tested?
5 new tests in
tests/_configuration/test_sdk.py:configure_*calls receive the correct (config, resource) pairdisabled=trueskips every call includingcreate_resourcedisabled=falseruns normal setuptracer_provider=Noneetc.) still passNonethrough to eachconfigure_*configure_sdkwith a realTracerProviderConfigtriggerstrace.set_tracer_providerwith an SDKTracerProviderDoes This PR Require a Contrib Repo Change?
Checklist: