Skip to content

opentelemetry-sdk: make it possible to customize processors configuation #4806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+58 −8
Open

opentelemetry-sdk: make it possible to customize processors configuation #4806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
874e60d
opentelemetry-sdk: make it possible to customize processors configura…
xrmx Nov 12, 2025
9b18ed1
Add changelog
xrmx Nov 12, 2025
d84b162
Please pylint
xrmx Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

- opentelemetry-sdk: make it possible to override the default processors in the SDK configurator
([#4806](https://github.com/open-telemetry/opentelemetry-python/pull/4806))
- docs: Added sqlcommenter example
([#4734](https://github.com/open-telemetry/opentelemetry-python/pull/4734))
- build: bump ruff to 0.14.1
Expand Down
21 changes: 17 additions & 4 deletions opentelemetry-sdk/src/opentelemetry/sdk/_configuration/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@
)
from opentelemetry.metrics import set_meter_provider
from opentelemetry.sdk._events import EventLoggerProvider
from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
from opentelemetry.sdk._logs import (
LoggerProvider,
LoggingHandler,
LogRecordProcessor,
)
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor, LogExporter
from opentelemetry.sdk.environment_variables import (
_OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED,
Expand All @@ -56,7 +60,7 @@
PeriodicExportingMetricReader,
)
from opentelemetry.sdk.resources import Attributes, Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace import SpanProcessor, TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor, SpanExporter
from opentelemetry.sdk.trace.id_generator import IdGenerator
from opentelemetry.sdk.trace.sampling import Sampler
Expand Down Expand Up @@ -208,6 +212,7 @@ def _init_tracing(
sampler: Sampler | None = None,
resource: Resource | None = None,
exporter_args_map: ExporterArgsMap | None = None,
processor: Type[SpanProcessor] | None = None,
):
provider = TracerProvider(
id_generator=id_generator,
Expand All @@ -217,10 +222,11 @@ def _init_tracing(
set_tracer_provider(provider)

exporter_args_map = exporter_args_map or {}
span_processor = processor or BatchSpanProcessor
for _, exporter_class in exporters.items():
exporter_args = exporter_args_map.get(exporter_class, {})
provider.add_span_processor(
BatchSpanProcessor(exporter_class(**exporter_args))
span_processor(exporter_class(**exporter_args))
Copy link
Contributor Author

@xrmx xrmx Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is failing pyright check because Type[SpanProcessor] does not impose a constructor that takes an exporter as first parameter. Need to type that I guess.

)


Expand Down Expand Up @@ -254,15 +260,17 @@ def _init_logging(
resource: Resource | None = None,
setup_logging_handler: bool = True,
exporter_args_map: ExporterArgsMap | None = None,
processor: Type[LogRecordProcessor] | None = None,
):
provider = LoggerProvider(resource=resource)
set_logger_provider(provider)

exporter_args_map = exporter_args_map or {}
log_record_processor = processor or BatchLogRecordProcessor
for _, exporter_class in exporters.items():
exporter_args = exporter_args_map.get(exporter_class, {})
provider.add_log_record_processor(
BatchLogRecordProcessor(exporter_class(**exporter_args))
log_record_processor(exporter_class(**exporter_args))
)

event_logger_provider = EventLoggerProvider(logger_provider=provider)
Expand Down Expand Up @@ -416,7 +424,10 @@ def _initialize_components(
id_generator: IdGenerator | None = None,
setup_logging_handler: bool | None = None,
exporter_args_map: ExporterArgsMap | None = None,
span_processor: Type[SpanProcessor] | None = None,
Copy link
Contributor Author

@xrmx xrmx Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the same for every exporter, is it enough or we want to make it per exporter?

Copy link

@herin049 herin049 Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might make the API too ugly, but we could do

span_processors: dict[str, Type[SpanProcessor] | None = None, 
default_span_processor: Type[SpanProcessor] | None = None

Copy link
Contributor Author

@xrmx xrmx Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the current code we call just one processor wrapping the exporter class, what I was asking if people with multiple exporters may want to use a different processor depending on the exporter, similar on how we handle the exporters args as exporter_args_map.

log_record_processor: Type[LogRecordProcessor] | None = None,
):
# pylint: disable=too-many-locals
if trace_exporter_names is None:
trace_exporter_names = []
if metric_exporter_names is None:
Expand Down Expand Up @@ -451,6 +462,7 @@ def _initialize_components(
sampler=sampler,
resource=resource,
exporter_args_map=exporter_args_map,
processor=span_processor,
)
_init_metrics(
metric_exporters, resource, exporter_args_map=exporter_args_map
Expand All @@ -469,6 +481,7 @@ def _initialize_components(
resource,
setup_logging_handler,
exporter_args_map=exporter_args_map,
processor=log_record_processor,
)


Expand Down
43 changes: 39 additions & 4 deletions opentelemetry-sdk/tests/test_configurator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@
)
from opentelemetry.sdk._logs import LoggingHandler
from opentelemetry.sdk._logs._internal.export import LogExporter
from opentelemetry.sdk._logs.export import ConsoleLogExporter
from opentelemetry.sdk._logs.export import (
ConsoleLogExporter,
SimpleLogRecordProcessor,
)
from opentelemetry.sdk.environment_variables import (
OTEL_TRACES_SAMPLER,
OTEL_TRACES_SAMPLER_ARG,
Expand All @@ -62,7 +65,10 @@
)
from opentelemetry.sdk.metrics.view import Aggregation
from opentelemetry.sdk.resources import SERVICE_NAME, Resource
from opentelemetry.sdk.trace.export import ConsoleSpanExporter
from opentelemetry.sdk.trace.export import (
ConsoleSpanExporter,
SimpleSpanProcessor,
)
from opentelemetry.sdk.trace.id_generator import IdGenerator, RandomIdGenerator
from opentelemetry.sdk.trace.sampling import (
ALWAYS_ON,
Expand Down Expand Up @@ -396,6 +402,16 @@ def test_trace_init_exporter_uses_exporter_args_map(self):
exporter = provider.processor.exporter
self.assertEqual(exporter.compression, "gzip")

def test_trace_init_custom_span_processor(self):
_init_tracing(
{"otlp": OTLPSpanExporter},
id_generator=RandomIdGenerator(),
processor=SimpleSpanProcessor,
)

provider = self.set_provider_mock.call_args[0][0]
self.assertTrue(isinstance(provider.processor, SimpleSpanProcessor))

@patch.dict(environ, {OTEL_PYTHON_ID_GENERATOR: "custom_id_generator"})
@patch("opentelemetry.sdk._configuration.IdGenerator", new=IdGenerator)
@patch("opentelemetry.sdk._configuration.entry_points")
Expand Down Expand Up @@ -706,6 +722,17 @@ def test_logging_init_exporter_uses_exporter_args_map(self):
provider = self.set_provider_mock.call_args[0][0]
self.assertEqual(provider.processor.exporter.compression, "gzip")

def test_logging_init_custom_log_record_processor(self):
with ResetGlobalLoggingState():
resource = Resource.create({})
_init_logging(
{"otlp": DummyOTLPLogExporter},
resource=resource,
processor=SimpleLogRecordProcessor,
)
provider = self.set_provider_mock.call_args[0][0]
self.assertIsInstance(provider.processor, SimpleLogRecordProcessor)

@patch.dict(
environ,
{"OTEL_RESOURCE_ATTRIBUTES": "service.name=otlp-service"},
Expand Down Expand Up @@ -742,7 +769,7 @@ def test_logging_init_disable_default(self, logging_mock, tracing_mock):
_initialize_components(auto_instrumentation_version="auto-version")
self.assertEqual(tracing_mock.call_count, 1)
logging_mock.assert_called_once_with(
mock.ANY, mock.ANY, False, exporter_args_map=None
mock.ANY, mock.ANY, False, exporter_args_map=None, processor=None
)

@patch.dict(
Expand All @@ -758,7 +785,11 @@ def test_logging_init_enable_env(self, logging_mock, tracing_mock):
with self.assertLogs(level=WARNING):
_initialize_components(auto_instrumentation_version="auto-version")
logging_mock.assert_called_once_with(
mock.ANY, mock.ANY, True, exporter_args_map=None
mock.ANY,
mock.ANY,
True,
exporter_args_map=None,
processor=None,
)
self.assertEqual(tracing_mock.call_count, 1)

Expand Down Expand Up @@ -843,6 +874,8 @@ def test_initialize_components_kwargs(
"id_generator": "TEST_GENERATOR",
"setup_logging_handler": True,
"exporter_args_map": {1: {"compression": "gzip"}},
"log_record_processor": SimpleLogRecordProcessor,
"span_processor": SimpleSpanProcessor,
}
_initialize_components(**kwargs)

Expand Down Expand Up @@ -877,6 +910,7 @@ def test_initialize_components_kwargs(
sampler="TEST_SAMPLER",
resource="TEST_RESOURCE",
exporter_args_map={1: {"compression": "gzip"}},
processor=SimpleSpanProcessor,
)
metrics_mock.assert_called_once_with(
"TEST_METRICS_EXPORTERS_DICT",
Expand All @@ -888,6 +922,7 @@ def test_initialize_components_kwargs(
"TEST_RESOURCE",
True,
exporter_args_map={1: {"compression": "gzip"}},
processor=SimpleLogRecordProcessor,
)

def test_basicConfig_works_with_otel_handler(self):
Expand Down
Loading