From 5c26f004500a5454097092793a1d11a91bea2a71 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Fri, 13 Mar 2026 13:04:09 +0000 Subject: [PATCH 1/9] 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 --- CHANGELOG.md | 2 + .../sdk/_configuration/_exceptions.py | 25 ++ .../sdk/_configuration/_propagator.py | 126 ++++++++ .../sdk/_configuration/_resource.py | 141 +++++++++ .../sdk/_configuration/file/__init__.py | 8 + .../sdk/_configuration/file/_loader.py | 12 +- .../tests/_configuration/test_propagator.py | 254 ++++++++++++++++ .../tests/_configuration/test_resource.py | 282 ++++++++++++++++++ 8 files changed, 841 insertions(+), 9 deletions(-) create mode 100644 opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_exceptions.py create mode 100644 opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py create mode 100644 opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py create mode 100644 opentelemetry-sdk/tests/_configuration/test_propagator.py create mode 100644 opentelemetry-sdk/tests/_configuration/test_resource.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 540f7b9d347..c4ddccc4ae2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased +- `opentelemetry-sdk`: Add `create_resource` and `create_propagator`/`configure_propagator` to declarative file configuration, enabling Resource and propagator instantiation from config files without reading env vars + ([#XXXX](https://github.com/open-telemetry/opentelemetry-python/pull/XXXX)) - `opentelemetry-sdk`: Add file configuration support with YAML/JSON loading, environment variable substitution, and schema validation against the vendored OTel config JSON schema ([#4898](https://github.com/open-telemetry/opentelemetry-python/pull/4898)) - Fix intermittent CI failures in `getting-started` and `tracecontext` jobs caused by GitHub git CDN SHA propagation lag by installing contrib packages from the already-checked-out local copy instead of a second git clone diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_exceptions.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_exceptions.py new file mode 100644 index 00000000000..9b90dbd50a5 --- /dev/null +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_exceptions.py @@ -0,0 +1,25 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +class ConfigurationError(Exception): + """Raised when configuration loading, parsing, validation, or instantiation fails. + + This includes errors from: + - File not found or inaccessible + - Invalid YAML/JSON syntax + - Schema validation failures + - Environment variable substitution errors + - Missing required SDK extensions (e.g., propagator packages not installed) + """ diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py new file mode 100644 index 00000000000..696371ab52f --- /dev/null +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py @@ -0,0 +1,126 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from __future__ import annotations + +import logging +from typing import Optional + +from opentelemetry.baggage.propagation import W3CBaggagePropagator +from opentelemetry.propagate import set_global_textmap +from opentelemetry.propagators.composite import CompositePropagator +from opentelemetry.propagators.textmap import TextMapPropagator +from opentelemetry.sdk._configuration._exceptions import ConfigurationError +from opentelemetry.sdk._configuration.models import ( + Propagator as PropagatorConfig, + TextMapPropagator as TextMapPropagatorConfig, +) +from opentelemetry.trace.propagation.tracecontext import ( + TraceContextTextMapPropagator, +) +from opentelemetry.util._importlib_metadata import entry_points + +_logger = logging.getLogger(__name__) + + +def _load_entry_point_propagator(name: str) -> TextMapPropagator: + """Load a propagator by name from the opentelemetry_propagator entry point group.""" + try: + eps = list( + entry_points(group="opentelemetry_propagator", name=name) + ) + if not eps: + raise ConfigurationError( + f"Propagator '{name}' not found. " + "It may not be installed or may be misspelled." + ) + return eps[0].load()() + except ConfigurationError: + raise + except Exception as e: + raise ConfigurationError( + f"Failed to load propagator '{name}': {e}" + ) from e + + +def _propagators_from_textmap_config( + config: TextMapPropagatorConfig, +) -> list[TextMapPropagator]: + """Resolve a single TextMapPropagator config entry to a list of propagators.""" + result: list[TextMapPropagator] = [] + if config.tracecontext is not None: + result.append(TraceContextTextMapPropagator()) + if config.baggage is not None: + result.append(W3CBaggagePropagator()) + if config.b3 is not None: + result.append(_load_entry_point_propagator("b3")) + if config.b3multi is not None: + result.append(_load_entry_point_propagator("b3multi")) + return result + + +def create_propagator( + config: Optional[PropagatorConfig], +) -> CompositePropagator: + """Create a CompositePropagator from declarative config. + + If config is None or has no propagators defined, returns an empty + CompositePropagator (no-op), ensuring "what you see is what you get" + semantics — the env-var-based default propagators are not used. + + Args: + config: Propagator config from the parsed config file, or None. + + Returns: + A CompositePropagator wrapping all configured propagators. + """ + if config is None: + return CompositePropagator([]) + + propagators: list[TextMapPropagator] = [] + seen_types: set[type] = set() + + def _add_deduped(p: TextMapPropagator) -> None: + if type(p) not in seen_types: + seen_types.add(type(p)) + propagators.append(p) + + # Process structured composite list + if config.composite: + for entry in config.composite: + for p in _propagators_from_textmap_config(entry): + _add_deduped(p) + + # Process composite_list (comma-separated propagator names via entry_points) + if config.composite_list: + for name in config.composite_list.split(","): + name = name.strip() + if not name or name.lower() == "none": + continue + p = _load_entry_point_propagator(name) + _add_deduped(p) + + return CompositePropagator(propagators) + + +def configure_propagator(config: Optional[PropagatorConfig]) -> None: + """Configure the global text map propagator from declarative config. + + Always calls set_global_textmap to override any defaults (including the + env-var-based tracecontext+baggage default set by the SDK). + + Args: + config: Propagator config from the parsed config file, or None. + """ + set_global_textmap(create_propagator(config)) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py new file mode 100644 index 00000000000..4681fdaded7 --- /dev/null +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py @@ -0,0 +1,141 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from __future__ import annotations + +import logging +from typing import Optional +from urllib import parse + +from opentelemetry.sdk._configuration.models import ( + AttributeNameValue, + AttributeType, + Resource as ResourceConfig, +) +from opentelemetry.sdk.resources import ( + SERVICE_NAME, + TELEMETRY_SDK_LANGUAGE, + TELEMETRY_SDK_NAME, + TELEMETRY_SDK_VERSION, + Resource, + _OPENTELEMETRY_SDK_VERSION, +) + +_logger = logging.getLogger(__name__) + + +def _coerce_attribute_value(attr: AttributeNameValue) -> object: + """Coerce an attribute value to the correct Python type based on AttributeType.""" + value = attr.value + attr_type = attr.type + + if attr_type is None: + return value + + if attr_type == AttributeType.string: + return str(value) + if attr_type == AttributeType.bool: + if isinstance(value, str): + return value.lower() not in ("false", "0", "") + return bool(value) + if attr_type == AttributeType.int: + return int(value) # type: ignore[arg-type] + if attr_type == AttributeType.double: + return float(value) # type: ignore[arg-type] + if attr_type == AttributeType.string_array: + return [str(v) for v in value] # type: ignore[union-attr] + if attr_type == AttributeType.bool_array: + return [bool(v) for v in value] # type: ignore[union-attr] + if attr_type == AttributeType.int_array: + return [int(v) for v in value] # type: ignore[union-attr,arg-type] + if attr_type == AttributeType.double_array: + return [float(v) for v in value] # type: ignore[union-attr,arg-type] + + return value + + +def _parse_attributes_list(attributes_list: str) -> dict[str, str]: + """Parse a comma-separated key=value string into a dict. + + Format is the same as OTEL_RESOURCE_ATTRIBUTES: key=value,key=value + Values are always strings (no type coercion). + """ + result: dict[str, str] = {} + for item in attributes_list.split(","): + item = item.strip() + if not item: + continue + if "=" not in item: + _logger.warning( + "Invalid resource attribute pair in attributes_list: %s", + item, + ) + continue + key, value = item.split("=", maxsplit=1) + result[key.strip()] = parse.unquote(value.strip()) + return result + + +def _sdk_default_attributes() -> dict[str, object]: + """Return the SDK telemetry attributes (equivalent to Java's Resource.getDefault()).""" + return { + TELEMETRY_SDK_LANGUAGE: "python", + TELEMETRY_SDK_NAME: "opentelemetry", + TELEMETRY_SDK_VERSION: _OPENTELEMETRY_SDK_VERSION, + } + + +def create_resource(config: Optional[ResourceConfig]) -> Resource: + """Create an SDK Resource from declarative config. + + Does NOT read OTEL_RESOURCE_ATTRIBUTES or run any resource detectors. + Starts from SDK telemetry defaults (telemetry.sdk.*) and merges config + attributes on top, matching Java SDK behavior. + + Args: + config: Resource config from the parsed config file, or None. + + Returns: + A Resource with SDK defaults merged with any config-specified attributes. + """ + base = Resource(_sdk_default_attributes()) + + if config is None: + service_resource = Resource({SERVICE_NAME: "unknown_service"}) + return base.merge(service_resource) + + # Build attributes from config.attributes list + config_attrs: dict[str, object] = {} + if config.attributes: + for attr in config.attributes: + config_attrs[attr.name] = _coerce_attribute_value(attr) + + # Parse attributes_list (key=value,key=value string format) + if config.attributes_list: + list_attrs = _parse_attributes_list(config.attributes_list) + # attributes_list entries do not override explicit attributes + for k, v in list_attrs.items(): + if k not in config_attrs: + config_attrs[k] = v + + schema_url = config.schema_url + + config_resource = Resource(config_attrs, schema_url) # type: ignore[arg-type] + result = base.merge(config_resource) + + # Add default service.name if not specified (matches Java SDK behavior) + if not result.attributes.get(SERVICE_NAME): + result = result.merge(Resource({SERVICE_NAME: "unknown_service"})) + + return result diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/__init__.py index a9955397495..17a6847abb8 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/__init__.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/__init__.py @@ -24,6 +24,11 @@ '1.0' """ +from opentelemetry.sdk._configuration._propagator import ( + configure_propagator, + create_propagator, +) +from opentelemetry.sdk._configuration._resource import create_resource from opentelemetry.sdk._configuration.file._env_substitution import ( EnvSubstitutionError, substitute_env_vars, @@ -38,4 +43,7 @@ "substitute_env_vars", "ConfigurationError", "EnvSubstitutionError", + "create_resource", + "create_propagator", + "configure_propagator", ] diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/_loader.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/_loader.py index 60191666690..2649398170f 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/_loader.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/_loader.py @@ -20,6 +20,7 @@ from pathlib import Path from typing import Any +from opentelemetry.sdk._configuration._exceptions import ConfigurationError from opentelemetry.sdk._configuration.file._env_substitution import ( substitute_env_vars, ) @@ -59,15 +60,8 @@ def _get_schema() -> dict: _logger = logging.getLogger(__name__) -class ConfigurationError(Exception): - """Raised when configuration file loading, parsing, or validation fails. - - This includes errors from: - - File not found or inaccessible - - Invalid YAML/JSON syntax - - Schema validation failures - - Environment variable substitution errors - """ +# Re-export for backwards compatibility +__all__ = ["ConfigurationError", "load_config_file"] def load_config_file(file_path: str) -> OpenTelemetryConfiguration: diff --git a/opentelemetry-sdk/tests/_configuration/test_propagator.py b/opentelemetry-sdk/tests/_configuration/test_propagator.py new file mode 100644 index 00000000000..268f7910b64 --- /dev/null +++ b/opentelemetry-sdk/tests/_configuration/test_propagator.py @@ -0,0 +1,254 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import unittest +from unittest.mock import MagicMock, patch + +from opentelemetry.baggage.propagation import W3CBaggagePropagator +from opentelemetry.propagators.composite import CompositePropagator +from opentelemetry.sdk._configuration._propagator import ( + configure_propagator, + create_propagator, +) +from opentelemetry.sdk._configuration.file._loader import ConfigurationError +from opentelemetry.sdk._configuration.models import ( + Propagator as PropagatorConfig, + TextMapPropagator as TextMapPropagatorConfig, +) +from opentelemetry.trace.propagation.tracecontext import ( + TraceContextTextMapPropagator, +) + + +class TestCreatePropagator(unittest.TestCase): + def test_none_config_returns_empty_composite(self): + result = create_propagator(None) + self.assertIsInstance(result, CompositePropagator) + self.assertEqual(result._propagators, []) # type: ignore[attr-defined] + + def test_empty_config_returns_empty_composite(self): + result = create_propagator(PropagatorConfig()) + self.assertIsInstance(result, CompositePropagator) + self.assertEqual(result._propagators, []) # type: ignore[attr-defined] + + def test_tracecontext_only(self): + config = PropagatorConfig( + composite=[TextMapPropagatorConfig(tracecontext={})] + ) + result = create_propagator(config) + self.assertEqual(len(result._propagators), 1) # type: ignore[attr-defined] + self.assertIsInstance( + result._propagators[0], TraceContextTextMapPropagator # type: ignore[attr-defined] + ) + + def test_baggage_only(self): + config = PropagatorConfig( + composite=[TextMapPropagatorConfig(baggage={})] + ) + result = create_propagator(config) + self.assertEqual(len(result._propagators), 1) # type: ignore[attr-defined] + self.assertIsInstance(result._propagators[0], W3CBaggagePropagator) # type: ignore[attr-defined] + + def test_tracecontext_and_baggage(self): + config = PropagatorConfig( + composite=[ + TextMapPropagatorConfig(tracecontext={}), + TextMapPropagatorConfig(baggage={}), + ] + ) + result = create_propagator(config) + self.assertEqual(len(result._propagators), 2) # type: ignore[attr-defined] + self.assertIsInstance( + result._propagators[0], TraceContextTextMapPropagator # type: ignore[attr-defined] + ) + self.assertIsInstance(result._propagators[1], W3CBaggagePropagator) # type: ignore[attr-defined] + + def test_b3_via_entry_point(self): + mock_propagator = MagicMock() + mock_ep = MagicMock() + mock_ep.load.return_value = lambda: mock_propagator + + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + return_value=[mock_ep], + ): + config = PropagatorConfig( + composite=[TextMapPropagatorConfig(b3={})] + ) + result = create_propagator(config) + + self.assertEqual(len(result._propagators), 1) # type: ignore[attr-defined] + self.assertIs(result._propagators[0], mock_propagator) # type: ignore[attr-defined] + + def test_b3multi_via_entry_point(self): + mock_propagator = MagicMock() + mock_ep = MagicMock() + mock_ep.load.return_value = lambda: mock_propagator + + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + return_value=[mock_ep], + ): + config = PropagatorConfig( + composite=[TextMapPropagatorConfig(b3multi={})] + ) + result = create_propagator(config) + + self.assertEqual(len(result._propagators), 1) # type: ignore[attr-defined] + + def test_b3_not_installed_raises_configuration_error(self): + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + return_value=[], + ): + config = PropagatorConfig( + composite=[TextMapPropagatorConfig(b3={})] + ) + with self.assertRaises(ConfigurationError) as ctx: + create_propagator(config) + self.assertIn("b3", str(ctx.exception)) + + def test_composite_list_tracecontext(self): + config = PropagatorConfig(composite_list="tracecontext") + mock_tc = TraceContextTextMapPropagator() + mock_ep = MagicMock() + mock_ep.load.return_value = lambda: mock_tc + + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + return_value=[mock_ep], + ): + result = create_propagator(config) + + self.assertEqual(len(result._propagators), 1) # type: ignore[attr-defined] + + def test_composite_list_multiple(self): + mock_tc = TraceContextTextMapPropagator() + mock_baggage = W3CBaggagePropagator() + mock_ep_tc = MagicMock() + mock_ep_tc.load.return_value = lambda: mock_tc + mock_ep_baggage = MagicMock() + mock_ep_baggage.load.return_value = lambda: mock_baggage + + def fake_entry_points(group, name): + if name == "tracecontext": + return [mock_ep_tc] + if name == "baggage": + return [mock_ep_baggage] + return [] + + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + side_effect=fake_entry_points, + ): + config = PropagatorConfig( + composite_list="tracecontext,baggage" + ) + result = create_propagator(config) + + self.assertEqual(len(result._propagators), 2) # type: ignore[attr-defined] + + def test_composite_list_none_entry_skipped(self): + config = PropagatorConfig(composite_list="none") + result = create_propagator(config) + self.assertEqual(result._propagators, []) # type: ignore[attr-defined] + + def test_composite_list_empty_entries_skipped(self): + config = PropagatorConfig(composite_list=",, ,") + result = create_propagator(config) + self.assertEqual(result._propagators, []) # type: ignore[attr-defined] + + def test_composite_list_whitespace_around_names(self): + mock_tc = TraceContextTextMapPropagator() + mock_ep = MagicMock() + mock_ep.load.return_value = lambda: mock_tc + + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + return_value=[mock_ep], + ): + config = PropagatorConfig(composite_list=" tracecontext ") + result = create_propagator(config) + + self.assertEqual(len(result._propagators), 1) # type: ignore[attr-defined] + + def test_entry_point_load_exception_raises_configuration_error(self): + mock_ep = MagicMock() + mock_ep.load.side_effect = RuntimeError("package broken") + + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + return_value=[mock_ep], + ): + config = PropagatorConfig(composite_list="broken-prop") + with self.assertRaises(ConfigurationError) as ctx: + create_propagator(config) + self.assertIn("broken-prop", str(ctx.exception)) + + def test_deduplication_across_composite_and_composite_list(self): + """Same propagator type from both composite and composite_list is deduplicated.""" + mock_tc = TraceContextTextMapPropagator() + mock_ep = MagicMock() + mock_ep.load.return_value = lambda: mock_tc + + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + return_value=[mock_ep], + ): + config = PropagatorConfig( + composite=[TextMapPropagatorConfig(tracecontext={})], + composite_list="tracecontext", + ) + result = create_propagator(config) + + # Only one TraceContextTextMapPropagator despite being in both + tc_count = sum( + 1 + for p in result._propagators # type: ignore[attr-defined] + if isinstance(p, TraceContextTextMapPropagator) + ) + self.assertEqual(tc_count, 1) + + def test_unknown_composite_list_propagator_raises(self): + with patch( + "opentelemetry.sdk._configuration._propagator.entry_points", + return_value=[], + ): + config = PropagatorConfig(composite_list="nonexistent") + with self.assertRaises(ConfigurationError): + create_propagator(config) + + +class TestConfigurePropagator(unittest.TestCase): + def test_configure_propagator_calls_set_global_textmap(self): + with patch( + "opentelemetry.sdk._configuration._propagator.set_global_textmap" + ) as mock_set: + configure_propagator(None) + mock_set.assert_called_once() + arg = mock_set.call_args[0][0] + self.assertIsInstance(arg, CompositePropagator) + + def test_configure_propagator_with_config(self): + config = PropagatorConfig( + composite=[TextMapPropagatorConfig(tracecontext={})] + ) + with patch( + "opentelemetry.sdk._configuration._propagator.set_global_textmap" + ) as mock_set: + configure_propagator(config) + mock_set.assert_called_once() + propagator = mock_set.call_args[0][0] + self.assertIsInstance(propagator, CompositePropagator) + self.assertEqual(len(propagator._propagators), 1) # type: ignore[attr-defined] diff --git a/opentelemetry-sdk/tests/_configuration/test_resource.py b/opentelemetry-sdk/tests/_configuration/test_resource.py new file mode 100644 index 00000000000..1a13a859bb2 --- /dev/null +++ b/opentelemetry-sdk/tests/_configuration/test_resource.py @@ -0,0 +1,282 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import unittest + +from opentelemetry.sdk._configuration._resource import create_resource +from opentelemetry.sdk._configuration.models import ( + AttributeNameValue, + AttributeType, + Resource as ResourceConfig, +) +from opentelemetry.sdk.resources import ( + SERVICE_NAME, + TELEMETRY_SDK_LANGUAGE, + TELEMETRY_SDK_NAME, + TELEMETRY_SDK_VERSION, + Resource, +) + + +class TestCreateResource(unittest.TestCase): + def test_none_config_returns_sdk_defaults(self): + resource = create_resource(None) + self.assertIsInstance(resource, Resource) + self.assertEqual(resource.attributes[TELEMETRY_SDK_LANGUAGE], "python") + self.assertEqual( + resource.attributes[TELEMETRY_SDK_NAME], "opentelemetry" + ) + self.assertIn(TELEMETRY_SDK_VERSION, resource.attributes) + self.assertEqual( + resource.attributes[SERVICE_NAME], "unknown_service" + ) + + def test_none_config_does_not_read_env_vars(self): + import os + from unittest.mock import patch + + with patch.dict( + os.environ, + {"OTEL_RESOURCE_ATTRIBUTES": "foo=bar", "OTEL_SERVICE_NAME": "my-service"}, + ): + resource = create_resource(None) + self.assertNotIn("foo", resource.attributes) + self.assertEqual(resource.attributes[SERVICE_NAME], "unknown_service") + + def test_empty_resource_config(self): + resource = create_resource(ResourceConfig()) + self.assertEqual(resource.attributes[TELEMETRY_SDK_LANGUAGE], "python") + self.assertEqual(resource.attributes[SERVICE_NAME], "unknown_service") + + def test_attributes_plain(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue(name="service.name", value="my-service"), + AttributeNameValue(name="env", value="production"), + ] + ) + resource = create_resource(config) + self.assertEqual(resource.attributes["service.name"], "my-service") + self.assertEqual(resource.attributes["env"], "production") + # SDK defaults still present + self.assertEqual(resource.attributes[TELEMETRY_SDK_LANGUAGE], "python") + + def test_attribute_type_string(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", value=42, type=AttributeType.string + ) + ] + ) + resource = create_resource(config) + self.assertEqual(resource.attributes["k"], "42") + self.assertIsInstance(resource.attributes["k"], str) + + def test_attribute_type_int(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", value=3.0, type=AttributeType.int + ) + ] + ) + resource = create_resource(config) + self.assertEqual(resource.attributes["k"], 3) + self.assertIsInstance(resource.attributes["k"], int) + + def test_attribute_type_double(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", value="1.5", type=AttributeType.double + ) + ] + ) + resource = create_resource(config) + self.assertAlmostEqual(resource.attributes["k"], 1.5) # type: ignore[arg-type] + self.assertIsInstance(resource.attributes["k"], float) + + def test_attribute_type_bool(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", value="true", type=AttributeType.bool + ) + ] + ) + resource = create_resource(config) + self.assertTrue(resource.attributes["k"]) + + def test_attribute_type_bool_false_string(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", value="false", type=AttributeType.bool + ) + ] + ) + resource = create_resource(config) + self.assertFalse(resource.attributes["k"]) + + def test_attribute_type_string_array(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", + value=["a", "b"], + type=AttributeType.string_array, + ) + ] + ) + resource = create_resource(config) + self.assertEqual(list(resource.attributes["k"]), ["a", "b"]) # type: ignore[arg-type] + + def test_attribute_type_int_array(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", + value=[1.0, 2.0], + type=AttributeType.int_array, + ) + ] + ) + resource = create_resource(config) + self.assertEqual(list(resource.attributes["k"]), [1, 2]) # type: ignore[arg-type] + + def test_attribute_type_double_array(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", + value=[1, 2], + type=AttributeType.double_array, + ) + ] + ) + resource = create_resource(config) + self.assertEqual(list(resource.attributes["k"]), [1.0, 2.0]) # type: ignore[arg-type] + + def test_attribute_type_bool_array(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", + value=[True, False], + type=AttributeType.bool_array, + ) + ] + ) + resource = create_resource(config) + self.assertEqual(list(resource.attributes["k"]), [True, False]) # type: ignore[arg-type] + + def test_schema_url(self): + config = ResourceConfig( + schema_url="https://opentelemetry.io/schemas/1.24.0" + ) + resource = create_resource(config) + self.assertEqual( + resource.schema_url, "https://opentelemetry.io/schemas/1.24.0" + ) + + def test_schema_url_none(self): + resource = create_resource(ResourceConfig()) + self.assertEqual(resource.schema_url, "") + + def test_attributes_list_parsed(self): + config = ResourceConfig( + attributes_list="service.name=my-svc,region=us-east-1" + ) + resource = create_resource(config) + self.assertEqual(resource.attributes["service.name"], "my-svc") + self.assertEqual(resource.attributes["region"], "us-east-1") + + def test_attributes_list_does_not_override_attributes(self): + """Explicit attributes take precedence over attributes_list.""" + config = ResourceConfig( + attributes=[ + AttributeNameValue(name="service.name", value="explicit") + ], + attributes_list="service.name=from-list,extra=val", + ) + resource = create_resource(config) + self.assertEqual(resource.attributes["service.name"], "explicit") + self.assertEqual(resource.attributes["extra"], "val") + + def test_attributes_list_only_includes_sdk_defaults(self): + """attributes_list alone should still include telemetry.sdk.* defaults.""" + config = ResourceConfig(attributes_list="env=prod") + resource = create_resource(config) + self.assertEqual(resource.attributes["env"], "prod") + self.assertEqual(resource.attributes[TELEMETRY_SDK_LANGUAGE], "python") + + def test_attributes_list_value_containing_equals(self): + """Values containing '=' should be preserved intact.""" + config = ResourceConfig(attributes_list="token=abc=def=ghi") + resource = create_resource(config) + self.assertEqual(resource.attributes["token"], "abc=def=ghi") + + def test_attributes_list_empty_pairs_skipped(self): + config = ResourceConfig(attributes_list=",foo=bar,,") + resource = create_resource(config) + self.assertEqual(resource.attributes["foo"], "bar") + + def test_attributes_list_url_decoded(self): + config = ResourceConfig( + attributes_list="service.namespace=my%20namespace,region=us-east-1" + ) + resource = create_resource(config) + self.assertEqual(resource.attributes["service.namespace"], "my namespace") + + def test_attributes_list_invalid_pair_skipped(self): + with self.assertLogs( + "opentelemetry.sdk._configuration._resource", level="WARNING" + ) as cm: + config = ResourceConfig(attributes_list="no-equals,foo=bar") + resource = create_resource(config) + self.assertEqual(resource.attributes["foo"], "bar") + self.assertNotIn("no-equals", resource.attributes) + self.assertTrue(any("no-equals" in msg for msg in cm.output)) + + def test_service_name_default_added_when_missing(self): + config = ResourceConfig( + attributes=[AttributeNameValue(name="env", value="staging")] + ) + resource = create_resource(config) + self.assertEqual(resource.attributes[SERVICE_NAME], "unknown_service") + + def test_service_name_not_overridden_when_set(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue(name="service.name", value="my-app") + ] + ) + resource = create_resource(config) + self.assertEqual(resource.attributes[SERVICE_NAME], "my-app") + + def test_env_vars_not_read(self): + """OTEL_RESOURCE_ATTRIBUTES must not affect declarative config resource.""" + import os + from unittest.mock import patch + + with patch.dict( + os.environ, + {"OTEL_RESOURCE_ATTRIBUTES": "injected=true"}, + ): + config = ResourceConfig( + attributes=[AttributeNameValue(name="k", value="v")] + ) + resource = create_resource(config) + self.assertNotIn("injected", resource.attributes) From 82320121caf2696b4999e219d1cc8acddeaec9d1 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Fri, 13 Mar 2026 13:12:36 +0000 Subject: [PATCH 2/9] update changelog with PR number Assisted-by: Claude Sonnet 4.6 --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c4ddccc4ae2..02e51173eb2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased - `opentelemetry-sdk`: Add `create_resource` and `create_propagator`/`configure_propagator` to declarative file configuration, enabling Resource and propagator instantiation from config files without reading env vars - ([#XXXX](https://github.com/open-telemetry/opentelemetry-python/pull/XXXX)) + ([#4979](https://github.com/open-telemetry/opentelemetry-python/pull/4979)) - `opentelemetry-sdk`: Add file configuration support with YAML/JSON loading, environment variable substitution, and schema validation against the vendored OTel config JSON schema ([#4898](https://github.com/open-telemetry/opentelemetry-python/pull/4898)) - Fix intermittent CI failures in `getting-started` and `tracecontext` jobs caused by GitHub git CDN SHA propagation lag by installing contrib packages from the already-checked-out local copy instead of a second git clone From 8329ae4bda09fe56ddf06610f1bf6326e1e9c93b Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Fri, 13 Mar 2026 13:29:52 +0000 Subject: [PATCH 3/9] 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 --- .../sdk/_configuration/_propagator.py | 27 ++--- .../sdk/_configuration/_resource.py | 59 +++++---- .../tests/_configuration/test_propagator.py | 15 ++- .../tests/_configuration/test_resource.py | 113 +++++++++--------- 4 files changed, 114 insertions(+), 100 deletions(-) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py index 696371ab52f..1c49d05651a 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_propagator.py @@ -24,6 +24,8 @@ from opentelemetry.sdk._configuration._exceptions import ConfigurationError from opentelemetry.sdk._configuration.models import ( Propagator as PropagatorConfig, +) +from opentelemetry.sdk._configuration.models import ( TextMapPropagator as TextMapPropagatorConfig, ) from opentelemetry.trace.propagation.tracecontext import ( @@ -37,9 +39,7 @@ def _load_entry_point_propagator(name: str) -> TextMapPropagator: """Load a propagator by name from the opentelemetry_propagator entry point group.""" try: - eps = list( - entry_points(group="opentelemetry_propagator", name=name) - ) + eps = list(entry_points(group="opentelemetry_propagator", name=name)) if not eps: raise ConfigurationError( f"Propagator '{name}' not found. " @@ -48,10 +48,10 @@ def _load_entry_point_propagator(name: str) -> TextMapPropagator: return eps[0].load()() except ConfigurationError: raise - except Exception as e: + except Exception as exc: raise ConfigurationError( - f"Failed to load propagator '{name}': {e}" - ) from e + f"Failed to load propagator '{name}': {exc}" + ) from exc def _propagators_from_textmap_config( @@ -91,16 +91,16 @@ def create_propagator( propagators: list[TextMapPropagator] = [] seen_types: set[type] = set() - def _add_deduped(p: TextMapPropagator) -> None: - if type(p) not in seen_types: - seen_types.add(type(p)) - propagators.append(p) + def _add_deduped(propagator: TextMapPropagator) -> None: + if type(propagator) not in seen_types: + seen_types.add(type(propagator)) + propagators.append(propagator) # Process structured composite list if config.composite: for entry in config.composite: - for p in _propagators_from_textmap_config(entry): - _add_deduped(p) + for propagator in _propagators_from_textmap_config(entry): + _add_deduped(propagator) # Process composite_list (comma-separated propagator names via entry_points) if config.composite_list: @@ -108,8 +108,7 @@ def _add_deduped(p: TextMapPropagator) -> None: name = name.strip() if not name or name.lower() == "none": continue - p = _load_entry_point_propagator(name) - _add_deduped(p) + _add_deduped(_load_entry_point_propagator(name)) return CompositePropagator(propagators) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py index 4681fdaded7..7a04d87446d 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py @@ -21,19 +21,40 @@ from opentelemetry.sdk._configuration.models import ( AttributeNameValue, AttributeType, - Resource as ResourceConfig, ) +from opentelemetry.sdk._configuration.models import Resource as ResourceConfig from opentelemetry.sdk.resources import ( + _OPENTELEMETRY_SDK_VERSION, SERVICE_NAME, TELEMETRY_SDK_LANGUAGE, TELEMETRY_SDK_NAME, TELEMETRY_SDK_VERSION, Resource, - _OPENTELEMETRY_SDK_VERSION, ) _logger = logging.getLogger(__name__) +# Dispatch table for scalar type coercions +_SCALAR_COERCIONS = { + AttributeType.string: str, + AttributeType.int: int, + AttributeType.double: float, +} + +# Dispatch table for array type coercions +_ARRAY_COERCIONS = { + AttributeType.string_array: str, + AttributeType.bool_array: bool, + AttributeType.int_array: int, + AttributeType.double_array: float, +} + + +def _coerce_bool(value: object) -> bool: + if isinstance(value, str): + return value.lower() not in ("false", "0", "") + return bool(value) + def _coerce_attribute_value(attr: AttributeNameValue) -> object: """Coerce an attribute value to the correct Python type based on AttributeType.""" @@ -42,26 +63,14 @@ def _coerce_attribute_value(attr: AttributeNameValue) -> object: if attr_type is None: return value - - if attr_type == AttributeType.string: - return str(value) if attr_type == AttributeType.bool: - if isinstance(value, str): - return value.lower() not in ("false", "0", "") - return bool(value) - if attr_type == AttributeType.int: - return int(value) # type: ignore[arg-type] - if attr_type == AttributeType.double: - return float(value) # type: ignore[arg-type] - if attr_type == AttributeType.string_array: - return [str(v) for v in value] # type: ignore[union-attr] - if attr_type == AttributeType.bool_array: - return [bool(v) for v in value] # type: ignore[union-attr] - if attr_type == AttributeType.int_array: - return [int(v) for v in value] # type: ignore[union-attr,arg-type] - if attr_type == AttributeType.double_array: - return [float(v) for v in value] # type: ignore[union-attr,arg-type] - + return _coerce_bool(value) + scalar_coercer = _SCALAR_COERCIONS.get(attr_type) + if scalar_coercer is not None: + return scalar_coercer(value) # type: ignore[arg-type] + array_coercer = _ARRAY_COERCIONS.get(attr_type) + if array_coercer is not None: + return [array_coercer(item) for item in value] # type: ignore[union-attr,arg-type] return value @@ -87,7 +96,7 @@ def _parse_attributes_list(attributes_list: str) -> dict[str, str]: return result -def _sdk_default_attributes() -> dict[str, object]: +def _sdk_default_attributes() -> dict[str, str]: """Return the SDK telemetry attributes (equivalent to Java's Resource.getDefault()).""" return { TELEMETRY_SDK_LANGUAGE: "python", @@ -125,9 +134,9 @@ def create_resource(config: Optional[ResourceConfig]) -> Resource: if config.attributes_list: list_attrs = _parse_attributes_list(config.attributes_list) # attributes_list entries do not override explicit attributes - for k, v in list_attrs.items(): - if k not in config_attrs: - config_attrs[k] = v + for attr_key, attr_val in list_attrs.items(): + if attr_key not in config_attrs: + config_attrs[attr_key] = attr_val schema_url = config.schema_url diff --git a/opentelemetry-sdk/tests/_configuration/test_propagator.py b/opentelemetry-sdk/tests/_configuration/test_propagator.py index 268f7910b64..e22acfca0f5 100644 --- a/opentelemetry-sdk/tests/_configuration/test_propagator.py +++ b/opentelemetry-sdk/tests/_configuration/test_propagator.py @@ -15,6 +15,9 @@ import unittest from unittest.mock import MagicMock, patch +# CompositePropagator stores its propagators in _propagators (private). +# We access it here to assert composition correctness. +# pylint: disable=protected-access from opentelemetry.baggage.propagation import W3CBaggagePropagator from opentelemetry.propagators.composite import CompositePropagator from opentelemetry.sdk._configuration._propagator import ( @@ -24,6 +27,8 @@ from opentelemetry.sdk._configuration.file._loader import ConfigurationError from opentelemetry.sdk._configuration.models import ( Propagator as PropagatorConfig, +) +from opentelemetry.sdk._configuration.models import ( TextMapPropagator as TextMapPropagatorConfig, ) from opentelemetry.trace.propagation.tracecontext import ( @@ -49,7 +54,8 @@ def test_tracecontext_only(self): result = create_propagator(config) self.assertEqual(len(result._propagators), 1) # type: ignore[attr-defined] self.assertIsInstance( - result._propagators[0], TraceContextTextMapPropagator # type: ignore[attr-defined] + result._propagators[0], + TraceContextTextMapPropagator, # type: ignore[attr-defined] ) def test_baggage_only(self): @@ -70,7 +76,8 @@ def test_tracecontext_and_baggage(self): result = create_propagator(config) self.assertEqual(len(result._propagators), 2) # type: ignore[attr-defined] self.assertIsInstance( - result._propagators[0], TraceContextTextMapPropagator # type: ignore[attr-defined] + result._propagators[0], + TraceContextTextMapPropagator, # type: ignore[attr-defined] ) self.assertIsInstance(result._propagators[1], W3CBaggagePropagator) # type: ignore[attr-defined] @@ -152,9 +159,7 @@ def fake_entry_points(group, name): "opentelemetry.sdk._configuration._propagator.entry_points", side_effect=fake_entry_points, ): - config = PropagatorConfig( - composite_list="tracecontext,baggage" - ) + config = PropagatorConfig(composite_list="tracecontext,baggage") result = create_propagator(config) self.assertEqual(len(result._propagators), 2) # type: ignore[attr-defined] diff --git a/opentelemetry-sdk/tests/_configuration/test_resource.py b/opentelemetry-sdk/tests/_configuration/test_resource.py index 1a13a859bb2..b74c0774f0f 100644 --- a/opentelemetry-sdk/tests/_configuration/test_resource.py +++ b/opentelemetry-sdk/tests/_configuration/test_resource.py @@ -12,14 +12,16 @@ # See the License for the specific language governing permissions and # limitations under the License. +import os import unittest +from unittest.mock import patch from opentelemetry.sdk._configuration._resource import create_resource from opentelemetry.sdk._configuration.models import ( AttributeNameValue, AttributeType, - Resource as ResourceConfig, ) +from opentelemetry.sdk._configuration.models import Resource as ResourceConfig from opentelemetry.sdk.resources import ( SERVICE_NAME, TELEMETRY_SDK_LANGUAGE, @@ -29,7 +31,7 @@ ) -class TestCreateResource(unittest.TestCase): +class TestCreateResourceDefaults(unittest.TestCase): def test_none_config_returns_sdk_defaults(self): resource = create_resource(None) self.assertIsInstance(resource, Resource) @@ -38,17 +40,15 @@ def test_none_config_returns_sdk_defaults(self): resource.attributes[TELEMETRY_SDK_NAME], "opentelemetry" ) self.assertIn(TELEMETRY_SDK_VERSION, resource.attributes) - self.assertEqual( - resource.attributes[SERVICE_NAME], "unknown_service" - ) + self.assertEqual(resource.attributes[SERVICE_NAME], "unknown_service") def test_none_config_does_not_read_env_vars(self): - import os - from unittest.mock import patch - with patch.dict( os.environ, - {"OTEL_RESOURCE_ATTRIBUTES": "foo=bar", "OTEL_SERVICE_NAME": "my-service"}, + { + "OTEL_RESOURCE_ATTRIBUTES": "foo=bar", + "OTEL_SERVICE_NAME": "my-service", + }, ): resource = create_resource(None) self.assertNotIn("foo", resource.attributes) @@ -59,6 +59,49 @@ def test_empty_resource_config(self): self.assertEqual(resource.attributes[TELEMETRY_SDK_LANGUAGE], "python") self.assertEqual(resource.attributes[SERVICE_NAME], "unknown_service") + def test_service_name_default_added_when_missing(self): + config = ResourceConfig( + attributes=[AttributeNameValue(name="env", value="staging")] + ) + resource = create_resource(config) + self.assertEqual(resource.attributes[SERVICE_NAME], "unknown_service") + + def test_service_name_not_overridden_when_set(self): + config = ResourceConfig( + attributes=[ + AttributeNameValue(name="service.name", value="my-app") + ] + ) + resource = create_resource(config) + self.assertEqual(resource.attributes[SERVICE_NAME], "my-app") + + def test_env_vars_not_read(self): + """OTEL_RESOURCE_ATTRIBUTES must not affect declarative config resource.""" + with patch.dict( + os.environ, + {"OTEL_RESOURCE_ATTRIBUTES": "injected=true"}, + ): + config = ResourceConfig( + attributes=[AttributeNameValue(name="k", value="v")] + ) + resource = create_resource(config) + self.assertNotIn("injected", resource.attributes) + + def test_schema_url(self): + config = ResourceConfig( + schema_url="https://opentelemetry.io/schemas/1.24.0" + ) + resource = create_resource(config) + self.assertEqual( + resource.schema_url, "https://opentelemetry.io/schemas/1.24.0" + ) + + def test_schema_url_none(self): + resource = create_resource(ResourceConfig()) + self.assertEqual(resource.schema_url, "") + + +class TestCreateResourceAttributes(unittest.TestCase): def test_attributes_plain(self): config = ResourceConfig( attributes=[ @@ -87,9 +130,7 @@ def test_attribute_type_string(self): def test_attribute_type_int(self): config = ResourceConfig( attributes=[ - AttributeNameValue( - name="k", value=3.0, type=AttributeType.int - ) + AttributeNameValue(name="k", value=3.0, type=AttributeType.int) ] ) resource = create_resource(config) @@ -182,19 +223,8 @@ def test_attribute_type_bool_array(self): resource = create_resource(config) self.assertEqual(list(resource.attributes["k"]), [True, False]) # type: ignore[arg-type] - def test_schema_url(self): - config = ResourceConfig( - schema_url="https://opentelemetry.io/schemas/1.24.0" - ) - resource = create_resource(config) - self.assertEqual( - resource.schema_url, "https://opentelemetry.io/schemas/1.24.0" - ) - - def test_schema_url_none(self): - resource = create_resource(ResourceConfig()) - self.assertEqual(resource.schema_url, "") +class TestCreateResourceAttributesList(unittest.TestCase): def test_attributes_list_parsed(self): config = ResourceConfig( attributes_list="service.name=my-svc,region=us-east-1" @@ -238,7 +268,9 @@ def test_attributes_list_url_decoded(self): attributes_list="service.namespace=my%20namespace,region=us-east-1" ) resource = create_resource(config) - self.assertEqual(resource.attributes["service.namespace"], "my namespace") + self.assertEqual( + resource.attributes["service.namespace"], "my namespace" + ) def test_attributes_list_invalid_pair_skipped(self): with self.assertLogs( @@ -249,34 +281,3 @@ def test_attributes_list_invalid_pair_skipped(self): self.assertEqual(resource.attributes["foo"], "bar") self.assertNotIn("no-equals", resource.attributes) self.assertTrue(any("no-equals" in msg for msg in cm.output)) - - def test_service_name_default_added_when_missing(self): - config = ResourceConfig( - attributes=[AttributeNameValue(name="env", value="staging")] - ) - resource = create_resource(config) - self.assertEqual(resource.attributes[SERVICE_NAME], "unknown_service") - - def test_service_name_not_overridden_when_set(self): - config = ResourceConfig( - attributes=[ - AttributeNameValue(name="service.name", value="my-app") - ] - ) - resource = create_resource(config) - self.assertEqual(resource.attributes[SERVICE_NAME], "my-app") - - def test_env_vars_not_read(self): - """OTEL_RESOURCE_ATTRIBUTES must not affect declarative config resource.""" - import os - from unittest.mock import patch - - with patch.dict( - os.environ, - {"OTEL_RESOURCE_ATTRIBUTES": "injected=true"}, - ): - config = ResourceConfig( - attributes=[AttributeNameValue(name="k", value="v")] - ) - resource = create_resource(config) - self.assertNotIn("injected", resource.attributes) From 506d8160a78134cd1d97c3086b5ea4df903f0632 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Mon, 16 Mar 2026 12:56:33 +0000 Subject: [PATCH 4/9] 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 --- .../sdk/_configuration/_resource.py | 34 ++++++------------- .../tests/_configuration/test_resource.py | 14 ++++++++ 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py index 7a04d87446d..22d96c7b65c 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py @@ -24,38 +24,37 @@ ) from opentelemetry.sdk._configuration.models import Resource as ResourceConfig from opentelemetry.sdk.resources import ( - _OPENTELEMETRY_SDK_VERSION, SERVICE_NAME, - TELEMETRY_SDK_LANGUAGE, - TELEMETRY_SDK_NAME, - TELEMETRY_SDK_VERSION, Resource, + _DEFAULT_RESOURCE, ) _logger = logging.getLogger(__name__) + +def _coerce_bool(value: object) -> bool: + if isinstance(value, str): + return value.lower() not in ("false", "0", "") + return bool(value) + + # Dispatch table for scalar type coercions _SCALAR_COERCIONS = { AttributeType.string: str, AttributeType.int: int, AttributeType.double: float, + AttributeType.bool: _coerce_bool, } # Dispatch table for array type coercions _ARRAY_COERCIONS = { AttributeType.string_array: str, - AttributeType.bool_array: bool, + AttributeType.bool_array: _coerce_bool, AttributeType.int_array: int, AttributeType.double_array: float, } -def _coerce_bool(value: object) -> bool: - if isinstance(value, str): - return value.lower() not in ("false", "0", "") - return bool(value) - - def _coerce_attribute_value(attr: AttributeNameValue) -> object: """Coerce an attribute value to the correct Python type based on AttributeType.""" value = attr.value @@ -63,8 +62,6 @@ def _coerce_attribute_value(attr: AttributeNameValue) -> object: if attr_type is None: return value - if attr_type == AttributeType.bool: - return _coerce_bool(value) scalar_coercer = _SCALAR_COERCIONS.get(attr_type) if scalar_coercer is not None: return scalar_coercer(value) # type: ignore[arg-type] @@ -96,15 +93,6 @@ def _parse_attributes_list(attributes_list: str) -> dict[str, str]: return result -def _sdk_default_attributes() -> dict[str, str]: - """Return the SDK telemetry attributes (equivalent to Java's Resource.getDefault()).""" - return { - TELEMETRY_SDK_LANGUAGE: "python", - TELEMETRY_SDK_NAME: "opentelemetry", - TELEMETRY_SDK_VERSION: _OPENTELEMETRY_SDK_VERSION, - } - - def create_resource(config: Optional[ResourceConfig]) -> Resource: """Create an SDK Resource from declarative config. @@ -118,7 +106,7 @@ def create_resource(config: Optional[ResourceConfig]) -> Resource: Returns: A Resource with SDK defaults merged with any config-specified attributes. """ - base = Resource(_sdk_default_attributes()) + base = _DEFAULT_RESOURCE if config is None: service_resource = Resource({SERVICE_NAME: "unknown_service"}) diff --git a/opentelemetry-sdk/tests/_configuration/test_resource.py b/opentelemetry-sdk/tests/_configuration/test_resource.py index b74c0774f0f..b50bc03fff4 100644 --- a/opentelemetry-sdk/tests/_configuration/test_resource.py +++ b/opentelemetry-sdk/tests/_configuration/test_resource.py @@ -223,6 +223,20 @@ def test_attribute_type_bool_array(self): resource = create_resource(config) self.assertEqual(list(resource.attributes["k"]), [True, False]) # type: ignore[arg-type] + def test_attribute_type_bool_array_string_values(self): + """bool_array must use _coerce_bool, not plain bool() — 'false' must be False.""" + config = ResourceConfig( + attributes=[ + AttributeNameValue( + name="k", + value=["true", "false"], + type=AttributeType.bool_array, + ) + ] + ) + resource = create_resource(config) + self.assertEqual(list(resource.attributes["k"]), [True, False]) # type: ignore[arg-type] + class TestCreateResourceAttributesList(unittest.TestCase): def test_attributes_list_parsed(self): From 8232d48d55d8d8e7e2c5a5ae8a34f7fb28218228 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Mon, 16 Mar 2026 13:00:19 +0000 Subject: [PATCH 5/9] fix linter --- .../src/opentelemetry/sdk/_configuration/_resource.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py index 22d96c7b65c..a9298bf91d4 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py @@ -24,9 +24,9 @@ ) from opentelemetry.sdk._configuration.models import Resource as ResourceConfig from opentelemetry.sdk.resources import ( + _DEFAULT_RESOURCE, SERVICE_NAME, Resource, - _DEFAULT_RESOURCE, ) _logger = logging.getLogger(__name__) From 99753f90259b1acabf92eb5290360977327f8a23 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Mon, 16 Mar 2026 15:15:02 +0000 Subject: [PATCH 6/9] 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 --- .../sdk/_configuration/_resource.py | 48 +++++++------------ 1 file changed, 17 insertions(+), 31 deletions(-) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py index a9298bf91d4..bb76cf77e89 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_resource.py @@ -38,37 +38,27 @@ def _coerce_bool(value: object) -> bool: return bool(value) -# Dispatch table for scalar type coercions -_SCALAR_COERCIONS = { +def _array(coerce: object) -> object: + return lambda value: [coerce(item) for item in value] # type: ignore[operator] + + +# Unified dispatch table for all attribute type coercions +_COERCIONS = { AttributeType.string: str, AttributeType.int: int, AttributeType.double: float, AttributeType.bool: _coerce_bool, -} - -# Dispatch table for array type coercions -_ARRAY_COERCIONS = { - AttributeType.string_array: str, - AttributeType.bool_array: _coerce_bool, - AttributeType.int_array: int, - AttributeType.double_array: float, + AttributeType.string_array: _array(str), + AttributeType.int_array: _array(int), + AttributeType.double_array: _array(float), + AttributeType.bool_array: _array(_coerce_bool), } def _coerce_attribute_value(attr: AttributeNameValue) -> object: """Coerce an attribute value to the correct Python type based on AttributeType.""" - value = attr.value - attr_type = attr.type - - if attr_type is None: - return value - scalar_coercer = _SCALAR_COERCIONS.get(attr_type) - if scalar_coercer is not None: - return scalar_coercer(value) # type: ignore[arg-type] - array_coercer = _ARRAY_COERCIONS.get(attr_type) - if array_coercer is not None: - return [array_coercer(item) for item in value] # type: ignore[union-attr,arg-type] - return value + coerce = _COERCIONS.get(attr.type) # type: ignore[arg-type] + return coerce(attr.value) if coerce is not None else attr.value # type: ignore[operator] def _parse_attributes_list(attributes_list: str) -> dict[str, str]: @@ -112,20 +102,16 @@ def create_resource(config: Optional[ResourceConfig]) -> Resource: service_resource = Resource({SERVICE_NAME: "unknown_service"}) return base.merge(service_resource) - # Build attributes from config.attributes list + # attributes_list is lower priority; process it first so that explicit + # attributes can simply overwrite any conflicting keys. config_attrs: dict[str, object] = {} + if config.attributes_list: + config_attrs.update(_parse_attributes_list(config.attributes_list)) + if config.attributes: for attr in config.attributes: config_attrs[attr.name] = _coerce_attribute_value(attr) - # Parse attributes_list (key=value,key=value string format) - if config.attributes_list: - list_attrs = _parse_attributes_list(config.attributes_list) - # attributes_list entries do not override explicit attributes - for attr_key, attr_val in list_attrs.items(): - if attr_key not in config_attrs: - config_attrs[attr_key] = attr_val - schema_url = config.schema_url config_resource = Resource(config_attrs, schema_url) # type: ignore[arg-type] From 6b9cad49d75810ca7f6866b7f39111cd530ec0ef Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Tue, 17 Mar 2026 14:41:57 +0000 Subject: [PATCH 7/9] add create_logger_provider/configure_logger_provider for declarative config Implements LoggerProvider instantiation from declarative config files, following the same env-var-suppression pattern as create_meter_provider. BatchLogRecordProcessor defaults use spec values (1000ms schedule_delay), overriding the Python SDK's incorrect 5000ms env-var default. Assisted-by: Claude Sonnet 4.6 --- .../sdk/_configuration/_logger_provider.py | 299 ++++++++++++++ .../sdk/_configuration/file/__init__.py | 6 + .../_configuration/test_logger_provider.py | 368 ++++++++++++++++++ 3 files changed, 673 insertions(+) create mode 100644 opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_logger_provider.py create mode 100644 opentelemetry-sdk/tests/_configuration/test_logger_provider.py diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_logger_provider.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_logger_provider.py new file mode 100644 index 00000000000..0ff9f8fa98a --- /dev/null +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_logger_provider.py @@ -0,0 +1,299 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from __future__ import annotations + +import logging +from typing import Dict, Optional + +from opentelemetry._logs import set_logger_provider +from opentelemetry.sdk._configuration._exceptions import ConfigurationError +from opentelemetry.sdk._configuration.models import ( + BatchLogRecordProcessor as BatchLogRecordProcessorConfig, +) +from opentelemetry.sdk._configuration.models import ( + LoggerProvider as LoggerProviderConfig, +) +from opentelemetry.sdk._configuration.models import ( + LogRecordExporter as LogRecordExporterConfig, +) +from opentelemetry.sdk._configuration.models import ( + LogRecordProcessor as LogRecordProcessorConfig, +) +from opentelemetry.sdk._configuration.models import ( + OtlpGrpcExporter as OtlpGrpcExporterConfig, +) +from opentelemetry.sdk._configuration.models import ( + OtlpHttpExporter as OtlpHttpExporterConfig, +) +from opentelemetry.sdk._configuration.models import ( + SimpleLogRecordProcessor as SimpleLogRecordProcessorConfig, +) +from opentelemetry.sdk._logs import LoggerProvider +from opentelemetry.sdk._logs._internal.export import ( + BatchLogRecordProcessor, + ConsoleLogRecordExporter, + LogRecordExporter, + SimpleLogRecordProcessor, +) +from opentelemetry.sdk.resources import Resource + +_logger = logging.getLogger(__name__) + +# BatchLogRecordProcessor defaults per OTel spec (milliseconds). +# Note: The Python SDK reads OTEL_BLRP_SCHEDULE_DELAY with an incorrect default +# of 5000ms. The spec mandates 1000ms. We pass 1000 explicitly here to match +# the spec and suppress env var reading. +_DEFAULT_SCHEDULE_DELAY_MILLIS = 1000 +_DEFAULT_EXPORT_TIMEOUT_MILLIS = 30000 +_DEFAULT_MAX_QUEUE_SIZE = 2048 +_DEFAULT_MAX_EXPORT_BATCH_SIZE = 512 + + +def _parse_headers( + headers: Optional[list], + headers_list: Optional[str], +) -> Optional[Dict[str, str]]: + """Merge headers struct and headers_list into a dict. + + Returns None if neither is set, letting the exporter read env vars. + headers struct takes priority over headers_list for the same key. + """ + if headers is None and headers_list is None: + return None + result: Dict[str, str] = {} + if headers_list: + for item in headers_list.split(","): + item = item.strip() + if "=" in item: + key, value = item.split("=", 1) + result[key.strip()] = value.strip() + elif item: + _logger.warning( + "Invalid header pair in headers_list (missing '='): %s", + item, + ) + if headers: + for pair in headers: + result[pair.name] = pair.value or "" + return result + + +def _map_compression( + value: Optional[str], compression_enum: type +) -> Optional[object]: + """Map a compression string to the given Compression enum value.""" + if value is None or value.lower() == "none": + return None + if value.lower() == "gzip": + return compression_enum.Gzip # type: ignore[attr-defined] + raise ConfigurationError( + f"Unsupported compression value '{value}'. Supported values: 'gzip', 'none'." + ) + + +def _create_console_log_exporter() -> ConsoleLogRecordExporter: + """Create a ConsoleLogRecordExporter.""" + return ConsoleLogRecordExporter() + + +def _create_otlp_http_log_exporter( + config: OtlpHttpExporterConfig, +) -> LogRecordExporter: + """Create an OTLP HTTP log exporter from config.""" + try: + # pylint: disable=import-outside-toplevel,no-name-in-module + from opentelemetry.exporter.otlp.proto.http import ( # type: ignore[import-untyped] # noqa: PLC0415 + Compression, + ) + from opentelemetry.exporter.otlp.proto.http._log_exporter import ( # type: ignore[import-untyped] # noqa: PLC0415 + OTLPLogExporter, + ) + except ImportError as exc: + raise ConfigurationError( + "otlp_http log exporter requires 'opentelemetry-exporter-otlp-proto-http'. " + "Install it with: pip install opentelemetry-exporter-otlp-proto-http" + ) from exc + + compression = _map_compression(config.compression, Compression) + headers = _parse_headers(config.headers, config.headers_list) + timeout = (config.timeout / 1000.0) if config.timeout is not None else None + + return OTLPLogExporter( # type: ignore[return-value] + endpoint=config.endpoint, + headers=headers, + timeout=timeout, + compression=compression, # type: ignore[arg-type] + ) + + +def _create_otlp_grpc_log_exporter( + config: OtlpGrpcExporterConfig, +) -> LogRecordExporter: + """Create an OTLP gRPC log exporter from config.""" + try: + # pylint: disable=import-outside-toplevel,no-name-in-module + import grpc # type: ignore[import-untyped] # noqa: PLC0415 + + from opentelemetry.exporter.otlp.proto.grpc._log_exporter import ( # type: ignore[import-untyped] # noqa: PLC0415 + OTLPLogExporter, + ) + except ImportError as exc: + raise ConfigurationError( + "otlp_grpc log exporter requires 'opentelemetry-exporter-otlp-proto-grpc'. " + "Install it with: pip install opentelemetry-exporter-otlp-proto-grpc" + ) from exc + + compression = _map_compression(config.compression, grpc.Compression) + headers = _parse_headers(config.headers, config.headers_list) + timeout = (config.timeout / 1000.0) if config.timeout is not None else None + + return OTLPLogExporter( # type: ignore[return-value] + endpoint=config.endpoint, + headers=headers, + timeout=timeout, + compression=compression, # type: ignore[arg-type] + ) + + +def _create_log_record_exporter( + config: LogRecordExporterConfig, +) -> LogRecordExporter: + """Create a log record exporter from config.""" + if config.console is not None: + return _create_console_log_exporter() + if config.otlp_http is not None: + return _create_otlp_http_log_exporter(config.otlp_http) + if config.otlp_grpc is not None: + return _create_otlp_grpc_log_exporter(config.otlp_grpc) + if config.otlp_file_development is not None: + raise ConfigurationError( + "otlp_file_development log exporter is experimental and not yet supported." + ) + raise ConfigurationError( + "No exporter type specified in log record exporter config. " + "Supported types: console, otlp_http, otlp_grpc." + ) + + +def _create_batch_log_record_processor( + config: BatchLogRecordProcessorConfig, +) -> BatchLogRecordProcessor: + """Create a BatchLogRecordProcessor from config. + + Passes explicit defaults to suppress OTEL_BLRP_* env var reading. + """ + exporter = _create_log_record_exporter(config.exporter) + schedule_delay = ( + config.schedule_delay + if config.schedule_delay is not None + else _DEFAULT_SCHEDULE_DELAY_MILLIS + ) + export_timeout = ( + config.export_timeout + if config.export_timeout is not None + else _DEFAULT_EXPORT_TIMEOUT_MILLIS + ) + max_queue_size = ( + config.max_queue_size + if config.max_queue_size is not None + else _DEFAULT_MAX_QUEUE_SIZE + ) + max_export_batch_size = ( + config.max_export_batch_size + if config.max_export_batch_size is not None + else _DEFAULT_MAX_EXPORT_BATCH_SIZE + ) + return BatchLogRecordProcessor( + exporter=exporter, + schedule_delay_millis=float(schedule_delay), + export_timeout_millis=float(export_timeout), + max_queue_size=max_queue_size, + max_export_batch_size=max_export_batch_size, + ) + + +def _create_simple_log_record_processor( + config: SimpleLogRecordProcessorConfig, +) -> SimpleLogRecordProcessor: + """Create a SimpleLogRecordProcessor from config.""" + exporter = _create_log_record_exporter(config.exporter) + return SimpleLogRecordProcessor(exporter) + + +def _create_log_record_processor( + config: LogRecordProcessorConfig, +) -> BatchLogRecordProcessor | SimpleLogRecordProcessor: + """Create a log record processor from config.""" + if config.batch is not None: + return _create_batch_log_record_processor(config.batch) + if config.simple is not None: + return _create_simple_log_record_processor(config.simple) + raise ConfigurationError( + "No processor type specified in log record processor config. " + "Supported types: batch, simple." + ) + + +def create_logger_provider( + config: Optional[LoggerProviderConfig], + resource: Optional[Resource] = None, +) -> LoggerProvider: + """Create an SDK LoggerProvider from declarative config. + + Does NOT read OTEL_BLRP_* or other env vars for values explicitly + controlled by the config. Absent config values use OTel spec defaults. + + Args: + config: LoggerProvider config from the parsed config file, or None. + resource: Resource to attach to the provider. + + Returns: + A configured LoggerProvider. + """ + provider = LoggerProvider(resource=resource) + + if config is None: + return provider + + if config.limits is not None: + _logger.warning( + "log_record_limits are specified in config but are not supported " + "by the Python SDK LoggerProvider constructor; limits will be ignored." + ) + + for processor_config in config.processors: + provider.add_log_record_processor( + _create_log_record_processor(processor_config) + ) + + return provider + + +def configure_logger_provider( + config: Optional[LoggerProviderConfig], + resource: Optional[Resource] = None, +) -> None: + """Configure the global LoggerProvider from declarative config. + + When config is None (logger_provider section absent from config file), + the global is not set — matching Java/JS SDK behavior. + + Args: + config: LoggerProvider config from the parsed config file, or None. + resource: Resource to attach to the provider. + """ + if config is None: + return + set_logger_provider(create_logger_provider(config, resource)) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/__init__.py index 17a6847abb8..63df1310b67 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/__init__.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/file/__init__.py @@ -24,6 +24,10 @@ '1.0' """ +from opentelemetry.sdk._configuration._logger_provider import ( + configure_logger_provider, + create_logger_provider, +) from opentelemetry.sdk._configuration._propagator import ( configure_propagator, create_propagator, @@ -46,4 +50,6 @@ "create_resource", "create_propagator", "configure_propagator", + "create_logger_provider", + "configure_logger_provider", ] diff --git a/opentelemetry-sdk/tests/_configuration/test_logger_provider.py b/opentelemetry-sdk/tests/_configuration/test_logger_provider.py new file mode 100644 index 00000000000..d65709254cc --- /dev/null +++ b/opentelemetry-sdk/tests/_configuration/test_logger_provider.py @@ -0,0 +1,368 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Tests access private members of SDK classes to assert correct configuration. +# pylint: disable=protected-access + +import sys +import unittest +from unittest.mock import MagicMock, patch + +from opentelemetry._logs import get_logger_provider +from opentelemetry.sdk._configuration._logger_provider import ( + _DEFAULT_EXPORT_TIMEOUT_MILLIS, + _DEFAULT_MAX_EXPORT_BATCH_SIZE, + _DEFAULT_MAX_QUEUE_SIZE, + _DEFAULT_SCHEDULE_DELAY_MILLIS, + _create_batch_log_record_processor, + _create_log_record_exporter, + _create_log_record_processor, + _create_simple_log_record_processor, + configure_logger_provider, + create_logger_provider, +) +from opentelemetry.sdk._configuration.file._loader import ConfigurationError +from opentelemetry.sdk._configuration.models import ( + BatchLogRecordProcessor as BatchLogRecordProcessorConfig, +) +from opentelemetry.sdk._configuration.models import ( + LoggerProvider as LoggerProviderConfig, +) +from opentelemetry.sdk._configuration.models import ( + LogRecordExporter as LogRecordExporterConfig, +) +from opentelemetry.sdk._configuration.models import ( + LogRecordLimits as LogRecordLimitsConfig, +) +from opentelemetry.sdk._configuration.models import ( + LogRecordProcessor as LogRecordProcessorConfig, +) +from opentelemetry.sdk._configuration.models import ( + NameStringValuePair, +) +from opentelemetry.sdk._configuration.models import ( + OtlpGrpcExporter as OtlpGrpcExporterConfig, +) +from opentelemetry.sdk._configuration.models import ( + OtlpHttpExporter as OtlpHttpExporterConfig, +) +from opentelemetry.sdk._configuration.models import ( + SimpleLogRecordProcessor as SimpleLogRecordProcessorConfig, +) +from opentelemetry.sdk._logs import LoggerProvider +from opentelemetry.sdk._logs._internal.export import ( + BatchLogRecordProcessor, + ConsoleLogRecordExporter, + SimpleLogRecordProcessor, +) +from opentelemetry.sdk.resources import Resource + + +class TestCreateLoggerProviderBasic(unittest.TestCase): + def test_none_config_returns_provider(self): + provider = create_logger_provider(None) + self.assertIsInstance(provider, LoggerProvider) + + def test_none_config_uses_supplied_resource(self): + resource = Resource({"service.name": "svc"}) + provider = create_logger_provider(None, resource) + self.assertIs(provider.resource, resource) + + def test_config_with_no_processors(self): + config = LoggerProviderConfig(processors=[]) + provider = create_logger_provider(config) + self.assertIsInstance(provider, LoggerProvider) + + def test_configure_none_is_noop(self): + original = get_logger_provider() + configure_logger_provider(None) + self.assertIs(get_logger_provider(), original) + + +class TestCreateLogRecordProcessors(unittest.TestCase): + @staticmethod + def _make_batch_config( + exporter_config=None, + schedule_delay=None, + export_timeout=None, + max_queue_size=None, + max_export_batch_size=None, + ): + if exporter_config is None: + exporter_config = LogRecordExporterConfig(console={}) + return BatchLogRecordProcessorConfig( + exporter=exporter_config, + schedule_delay=schedule_delay, + export_timeout=export_timeout, + max_queue_size=max_queue_size, + max_export_batch_size=max_export_batch_size, + ) + + def test_batch_processor_default_schedule_delay(self): + processor = _create_batch_log_record_processor(self._make_batch_config()) + self.assertEqual( + processor._batch_processor._schedule_delay_millis, + _DEFAULT_SCHEDULE_DELAY_MILLIS, + ) + + def test_batch_processor_default_export_timeout(self): + processor = _create_batch_log_record_processor(self._make_batch_config()) + self.assertEqual( + processor._batch_processor._export_timeout_millis, + _DEFAULT_EXPORT_TIMEOUT_MILLIS, + ) + + def test_batch_processor_default_max_queue_size(self): + processor = _create_batch_log_record_processor(self._make_batch_config()) + self.assertEqual( + processor._batch_processor._max_queue_size, + _DEFAULT_MAX_QUEUE_SIZE, + ) + + def test_batch_processor_default_max_export_batch_size(self): + processor = _create_batch_log_record_processor(self._make_batch_config()) + self.assertEqual( + processor._batch_processor._max_export_batch_size, + _DEFAULT_MAX_EXPORT_BATCH_SIZE, + ) + + def test_batch_processor_explicit_schedule_delay(self): + processor = _create_batch_log_record_processor( + self._make_batch_config(schedule_delay=2000) + ) + self.assertEqual( + processor._batch_processor._schedule_delay_millis, 2000.0 + ) + + def test_batch_processor_explicit_export_timeout(self): + processor = _create_batch_log_record_processor( + self._make_batch_config(export_timeout=5000) + ) + self.assertEqual( + processor._batch_processor._export_timeout_millis, 5000.0 + ) + + def test_batch_processor_explicit_max_queue_size(self): + processor = _create_batch_log_record_processor( + self._make_batch_config(max_queue_size=512) + ) + self.assertEqual(processor._batch_processor._max_queue_size, 512) + + def test_batch_processor_explicit_max_export_batch_size(self): + processor = _create_batch_log_record_processor( + self._make_batch_config(max_export_batch_size=128) + ) + self.assertEqual(processor._batch_processor._max_export_batch_size, 128) + + def test_batch_processor_uses_console_exporter(self): + processor = _create_batch_log_record_processor(self._make_batch_config()) + self.assertIsInstance( + processor._batch_processor._exporter, ConsoleLogRecordExporter + ) + + def test_simple_processor_uses_console_exporter(self): + config = SimpleLogRecordProcessorConfig( + exporter=LogRecordExporterConfig(console={}) + ) + processor = _create_simple_log_record_processor(config) + self.assertIsInstance(processor, SimpleLogRecordProcessor) + self.assertIsInstance(processor._exporter, ConsoleLogRecordExporter) + + def test_batch_processor_dispatched_from_processor_config(self): + config = LogRecordProcessorConfig( + batch=self._make_batch_config() + ) + processor = _create_log_record_processor(config) + self.assertIsInstance(processor, BatchLogRecordProcessor) + + def test_simple_processor_dispatched_from_processor_config(self): + config = LogRecordProcessorConfig( + simple=SimpleLogRecordProcessorConfig( + exporter=LogRecordExporterConfig(console={}) + ) + ) + processor = _create_log_record_processor(config) + self.assertIsInstance(processor, SimpleLogRecordProcessor) + + def test_no_processor_type_raises(self): + config = LogRecordProcessorConfig() + with self.assertRaises(ConfigurationError): + _create_log_record_processor(config) + + def test_batch_processor_suppresses_env_var(self): + """schedule_delay default must not read OTEL_BLRP_SCHEDULE_DELAY.""" + with patch.dict("os.environ", {"OTEL_BLRP_SCHEDULE_DELAY": "9999"}): + processor = _create_batch_log_record_processor( + self._make_batch_config() + ) + self.assertEqual( + processor._batch_processor._schedule_delay_millis, + _DEFAULT_SCHEDULE_DELAY_MILLIS, + ) + + +class TestCreateLogRecordExporters(unittest.TestCase): + def test_console_exporter(self): + config = LogRecordExporterConfig(console={}) + exporter = _create_log_record_exporter(config) + self.assertIsInstance(exporter, ConsoleLogRecordExporter) + + def test_otlp_file_development_raises(self): + config = LogRecordExporterConfig(otlp_file_development={}) + with self.assertRaises(ConfigurationError): + _create_log_record_exporter(config) + + def test_no_exporter_type_raises(self): + config = LogRecordExporterConfig() + with self.assertRaises(ConfigurationError): + _create_log_record_exporter(config) + + def test_otlp_http_missing_package_raises(self): + config = LogRecordExporterConfig( + otlp_http=OtlpHttpExporterConfig(endpoint="http://localhost:4318") + ) + with patch.dict( + sys.modules, + { + "opentelemetry.exporter.otlp.proto.http": None, + "opentelemetry.exporter.otlp.proto.http._log_exporter": None, + }, + ): + with self.assertRaises(ConfigurationError): + _create_log_record_exporter(config) + + def test_otlp_grpc_missing_package_raises(self): + config = LogRecordExporterConfig( + otlp_grpc=OtlpGrpcExporterConfig(endpoint="http://localhost:4317") + ) + with patch.dict( + sys.modules, + { + "grpc": None, + "opentelemetry.exporter.otlp.proto.grpc._log_exporter": None, + }, + ): + with self.assertRaises(ConfigurationError): + _create_log_record_exporter(config) + + def test_otlp_http_exporter_endpoint(self): + mock_exporter_cls = MagicMock() + mock_compression_cls = MagicMock() + mock_compression_cls.Gzip = "gzip" + + mock_module = MagicMock() + mock_module.Compression = mock_compression_cls + mock_log_module = MagicMock() + mock_log_module.OTLPLogExporter = mock_exporter_cls + + with patch.dict( + sys.modules, + { + "opentelemetry.exporter.otlp.proto.http": mock_module, + "opentelemetry.exporter.otlp.proto.http._log_exporter": mock_log_module, + }, + ): + config = LogRecordExporterConfig( + otlp_http=OtlpHttpExporterConfig( + endpoint="http://collector:4318", + timeout=5000, + ) + ) + _create_log_record_exporter(config) + + mock_exporter_cls.assert_called_once() + call_kwargs = mock_exporter_cls.call_args.kwargs + self.assertEqual(call_kwargs["endpoint"], "http://collector:4318") + self.assertAlmostEqual(call_kwargs["timeout"], 5.0) + + def test_otlp_http_exporter_headers(self): + mock_exporter_cls = MagicMock() + mock_compression_cls = MagicMock() + mock_module = MagicMock() + mock_module.Compression = mock_compression_cls + mock_log_module = MagicMock() + mock_log_module.OTLPLogExporter = mock_exporter_cls + + with patch.dict( + sys.modules, + { + "opentelemetry.exporter.otlp.proto.http": mock_module, + "opentelemetry.exporter.otlp.proto.http._log_exporter": mock_log_module, + }, + ): + config = LogRecordExporterConfig( + otlp_http=OtlpHttpExporterConfig( + headers=[NameStringValuePair(name="x-api-key", value="secret")] + ) + ) + _create_log_record_exporter(config) + + call_kwargs = mock_exporter_cls.call_args.kwargs + self.assertEqual(call_kwargs["headers"], {"x-api-key": "secret"}) + + def test_otlp_grpc_exporter_endpoint(self): + mock_exporter_cls = MagicMock() + mock_grpc = MagicMock() + mock_grpc.Compression = MagicMock() + mock_grpc_log_module = MagicMock() + mock_grpc_log_module.OTLPLogExporter = mock_exporter_cls + + with patch.dict( + sys.modules, + { + "grpc": mock_grpc, + "opentelemetry.exporter.otlp.proto.grpc._log_exporter": mock_grpc_log_module, + }, + ): + config = LogRecordExporterConfig( + otlp_grpc=OtlpGrpcExporterConfig( + endpoint="http://collector:4317", + timeout=10000, + ) + ) + _create_log_record_exporter(config) + + mock_exporter_cls.assert_called_once() + call_kwargs = mock_exporter_cls.call_args.kwargs + self.assertEqual(call_kwargs["endpoint"], "http://collector:4317") + self.assertAlmostEqual(call_kwargs["timeout"], 10.0) + + +class TestLogRecordLimits(unittest.TestCase): + def test_limits_logs_warning(self): + config = LoggerProviderConfig( + processors=[], + limits=LogRecordLimitsConfig(attribute_count_limit=64), + ) + with self.assertLogs( + "opentelemetry.sdk._configuration._logger_provider", level="WARNING" + ) as cm: + create_logger_provider(config) + self.assertTrue( + any("limits" in msg for msg in cm.output), + "Expected warning about unsupported limits", + ) + + @staticmethod + def test_no_limits_no_warning(): + config = LoggerProviderConfig(processors=[]) + with patch( + "opentelemetry.sdk._configuration._logger_provider._logger" + ) as mock_logger: + create_logger_provider(config) + mock_logger.warning.assert_not_called() + + +if __name__ == "__main__": + unittest.main() From 1b93f6473850f297379273f2402a82540b9b54b4 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Tue, 17 Mar 2026 14:43:19 +0000 Subject: [PATCH 8/9] add changelog entry for logger provider declarative config (#4990) Assisted-by: Claude Sonnet 4.6 --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f05d797964..3e4ec8a8c57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased +- `opentelemetry-sdk`: Add `create_logger_provider`/`configure_logger_provider` to declarative file configuration, enabling LoggerProvider instantiation from config files without reading env vars + ([#4990](https://github.com/open-telemetry/opentelemetry-python/pull/4990)) - `opentelemetry-sdk`: Add `create_resource` and `create_propagator`/`configure_propagator` to declarative file configuration, enabling Resource and propagator instantiation from config files without reading env vars ([#4979](https://github.com/open-telemetry/opentelemetry-python/pull/4979)) - `opentelemetry-sdk`: Add file configuration support with YAML/JSON loading, environment variable substitution, and schema validation against the vendored OTel config JSON schema From f817f974d02cf0f1537e03c160073af0a53e3a77 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Tue, 17 Mar 2026 16:20:56 +0000 Subject: [PATCH 9/9] fix linter errors --- .../_configuration/test_logger_provider.py | 35 +++++++++++++------ 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/opentelemetry-sdk/tests/_configuration/test_logger_provider.py b/opentelemetry-sdk/tests/_configuration/test_logger_provider.py index d65709254cc..ff820d105ad 100644 --- a/opentelemetry-sdk/tests/_configuration/test_logger_provider.py +++ b/opentelemetry-sdk/tests/_configuration/test_logger_provider.py @@ -110,28 +110,36 @@ def _make_batch_config( ) def test_batch_processor_default_schedule_delay(self): - processor = _create_batch_log_record_processor(self._make_batch_config()) + processor = _create_batch_log_record_processor( + self._make_batch_config() + ) self.assertEqual( processor._batch_processor._schedule_delay_millis, _DEFAULT_SCHEDULE_DELAY_MILLIS, ) def test_batch_processor_default_export_timeout(self): - processor = _create_batch_log_record_processor(self._make_batch_config()) + processor = _create_batch_log_record_processor( + self._make_batch_config() + ) self.assertEqual( processor._batch_processor._export_timeout_millis, _DEFAULT_EXPORT_TIMEOUT_MILLIS, ) def test_batch_processor_default_max_queue_size(self): - processor = _create_batch_log_record_processor(self._make_batch_config()) + processor = _create_batch_log_record_processor( + self._make_batch_config() + ) self.assertEqual( processor._batch_processor._max_queue_size, _DEFAULT_MAX_QUEUE_SIZE, ) def test_batch_processor_default_max_export_batch_size(self): - processor = _create_batch_log_record_processor(self._make_batch_config()) + processor = _create_batch_log_record_processor( + self._make_batch_config() + ) self.assertEqual( processor._batch_processor._max_export_batch_size, _DEFAULT_MAX_EXPORT_BATCH_SIZE, @@ -163,10 +171,14 @@ def test_batch_processor_explicit_max_export_batch_size(self): processor = _create_batch_log_record_processor( self._make_batch_config(max_export_batch_size=128) ) - self.assertEqual(processor._batch_processor._max_export_batch_size, 128) + self.assertEqual( + processor._batch_processor._max_export_batch_size, 128 + ) def test_batch_processor_uses_console_exporter(self): - processor = _create_batch_log_record_processor(self._make_batch_config()) + processor = _create_batch_log_record_processor( + self._make_batch_config() + ) self.assertIsInstance( processor._batch_processor._exporter, ConsoleLogRecordExporter ) @@ -180,9 +192,7 @@ def test_simple_processor_uses_console_exporter(self): self.assertIsInstance(processor._exporter, ConsoleLogRecordExporter) def test_batch_processor_dispatched_from_processor_config(self): - config = LogRecordProcessorConfig( - batch=self._make_batch_config() - ) + config = LogRecordProcessorConfig(batch=self._make_batch_config()) processor = _create_log_record_processor(config) self.assertIsInstance(processor, BatchLogRecordProcessor) @@ -303,7 +313,9 @@ def test_otlp_http_exporter_headers(self): ): config = LogRecordExporterConfig( otlp_http=OtlpHttpExporterConfig( - headers=[NameStringValuePair(name="x-api-key", value="secret")] + headers=[ + NameStringValuePair(name="x-api-key", value="secret") + ] ) ) _create_log_record_exporter(config) @@ -346,7 +358,8 @@ def test_limits_logs_warning(self): limits=LogRecordLimitsConfig(attribute_count_limit=64), ) with self.assertLogs( - "opentelemetry.sdk._configuration._logger_provider", level="WARNING" + "opentelemetry.sdk._configuration._logger_provider", + level="WARNING", ) as cm: create_logger_provider(config) self.assertTrue(