feat: add baggage span processor

Author: LucasAlvesSoares

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sap-cloud-sdk"
-version = "0.2.0"
+version = "0.3.0"
 description = "SAP Cloud SDK for Python"
 readme = "README.md"
 license = "Apache-2.0"
@@ -17,6 +17,7 @@ dependencies = [
     "hatchling~=1.27.0",
     "opentelemetry-exporter-otlp-proto-grpc~=1.38.0",
     "opentelemetry-exporter-otlp-proto-http~=1.38.0",
+    "opentelemetry-processor-baggage~=0.61b0",
     "traceloop-sdk~=0.52.0"
 ]
 

src/sap_cloud_sdk/core/telemetry/auto_instrument.py

@@ -7,13 +7,19 @@
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
     OTLPSpanExporter as HTTPSpanExporter,
 )
-from opentelemetry.sdk.trace.export import ConsoleSpanExporter
+from opentelemetry import trace
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.processor.baggage import ALLOW_ALL_BAGGAGE_KEYS, BaggageSpanProcessor
+from opentelemetry.sdk.trace.export import ConsoleSpanExporter, SpanExporter
 from traceloop.sdk import Traceloop
 
 from sap_cloud_sdk.core.telemetry import Module, Operation
 from sap_cloud_sdk.core.telemetry.config import (
     create_resource_attributes_from_env,
     _get_app_name,
+    ENV_OTLP_ENDPOINT,
+    ENV_TRACES_EXPORTER,
+    ENV_OTLP_PROTOCOL,
 )
 from sap_cloud_sdk.core.telemetry.genai_attribute_transformer import (
     GenAIAttributeTransformer,
@@ -31,36 +37,16 @@ def auto_instrument():
     Traces are exported to the OTEL collector endpoint configured in environment with
     OTEL_EXPORTER_OTLP_ENDPOINT, or printed to console when OTEL_TRACES_EXPORTER=console.
     """
-    otel_endpoint = os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT", "")
-    console_traces = os.getenv("OTEL_TRACES_EXPORTER", "").lower() == "console"
+    otel_endpoint = os.getenv(ENV_OTLP_ENDPOINT, "")
+    console_traces = os.getenv(ENV_TRACES_EXPORTER, "").lower() == "console"
 
     if not otel_endpoint and not console_traces:
         logger.warning(
             "OTEL_EXPORTER_OTLP_ENDPOINT not set. Instrumentation will be disabled."
         )
         return
 
-    if console_traces:
-        logger.info("Initializing auto instrumentation with console exporter")
-        base_exporter = ConsoleSpanExporter()
-    else:
-        if "v1/traces" not in otel_endpoint:
-            otel_endpoint = otel_endpoint.rstrip("/") + "/v1/traces"
-        protocol = os.getenv("OTEL_EXPORTER_OTLP_PROTOCOL", "grpc").lower()
-        exporters = {"grpc": GRPCSpanExporter, "http/protobuf": HTTPSpanExporter}
-        if protocol not in exporters:
-            raise ValueError(
-                f"Unsupported OTEL_EXPORTER_OTLP_PROTOCOL: '{protocol}'. "
-                "Supported values are 'grpc' and 'http/protobuf'."
-            )
-
-        logger.info(
-            f"Initializing auto instrumentation with endpoint: {otel_endpoint} "
-            f"(protocol: {protocol})"
-        )
-        base_exporter = exporters[protocol](endpoint=otel_endpoint)
-
-    exporter = GenAIAttributeTransformer(base_exporter)
+    exporter = GenAIAttributeTransformer(_create_exporter())
 
     resource = create_resource_attributes_from_env()
     Traceloop.init(
@@ -71,4 +57,37 @@ def auto_instrument():
         disable_batch=True,
     )
 
+    _set_baggage_processor()
+
     logger.info("Cloud auto instrumentation initialized successfully")
+
+
+def _create_exporter() -> SpanExporter:
+    if os.getenv(ENV_TRACES_EXPORTER, "").lower() == "console":
+        logger.info("Initializing auto instrumentation with console exporter")
+        return ConsoleSpanExporter()
+
+    endpoint = os.getenv(ENV_OTLP_ENDPOINT, "")
+    protocol = os.getenv(ENV_OTLP_PROTOCOL, "grpc").lower()
+    exporters = {"grpc": GRPCSpanExporter, "http/protobuf": HTTPSpanExporter}
+    if protocol not in exporters:
+        raise ValueError(
+            f"Unsupported OTEL_EXPORTER_OTLP_PROTOCOL: '{protocol}'. "
+            "Supported values are 'grpc' and 'http/protobuf'."
+        )
+
+    logger.info(
+        f"Initializing auto instrumentation with endpoint: {endpoint} "
+        f"(protocol: {protocol})"
+    )
+    return exporters[protocol]()
+
+
+def _set_baggage_processor():
+    provider = trace.get_tracer_provider()
+    if not isinstance(provider, TracerProvider):
+        logger.warning("Unknown TracerProvider type. Skipping BaggageSpanProcessor")
+        return
+
+    provider.add_span_processor(BaggageSpanProcessor(ALLOW_ALL_BAGGAGE_KEYS))
+    logger.info("Registered BaggageSpanProcessor for extension attribute propagation")

src/sap_cloud_sdk/core/telemetry/config.py

@@ -29,6 +29,12 @@
 ENV_HOSTNAME = "HOSTNAME"
 ENV_SYSTEM_ROLE = "APPFND_CONHOS_SYSTEM_ROLE"
 
+# OTEL environment variable keys
+ENV_OTLP_ENDPOINT = "OTEL_EXPORTER_OTLP_ENDPOINT"
+ENV_TRACES_EXPORTER = "OTEL_TRACES_EXPORTER"
+ENV_OTLP_PROTOCOL = "OTEL_EXPORTER_OTLP_PROTOCOL"
+ENV_OTEL_DISABLED = "CLOUD_SDK_OTEL_DISABLED"
+
 
 def _get_region() -> str:
     """Get region from environment or return default."""
@@ -134,13 +140,13 @@ def from_env(cls) -> "InstrumentationConfig":
             InstrumentationConfig instance with values from environment or defaults.
         """
         # Get OTLP endpoint - if not set, telemetry is disabled
-        otlp_endpoint = os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT", "")
+        otlp_endpoint = os.getenv(ENV_OTLP_ENDPOINT, "")
 
         # Enable telemetry only if endpoint is configured
         # Can be explicitly disabled with CLOUD_SDK_OTEL_DISABLED=true
         enabled = (
             bool(otlp_endpoint)
-            and os.getenv("CLOUD_SDK_OTEL_DISABLED", "false").lower() != "true"
+            and os.getenv(ENV_OTEL_DISABLED, "false").lower() != "true"
         )
 
         return cls(

tests/core/unit/telemetry/test_auto_instrument.py

@@ -1,9 +1,11 @@
 """Tests for auto-instrumentation functionality."""
 
 import pytest
-from unittest.mock import patch, MagicMock
+from unittest.mock import patch, MagicMock, create_autospec
 from contextlib import ExitStack
 
+from opentelemetry.sdk.trace import TracerProvider as SDKTracerProvider
+
 from sap_cloud_sdk.core.telemetry.auto_instrument import auto_instrument
 
 
@@ -17,6 +19,8 @@ def mock_traceloop_components():
             'http_exporter': stack.enter_context(patch('sap_cloud_sdk.core.telemetry.auto_instrument.HTTPSpanExporter')),
             'console_exporter': stack.enter_context(patch('sap_cloud_sdk.core.telemetry.auto_instrument.ConsoleSpanExporter')),
             'transformer': stack.enter_context(patch('sap_cloud_sdk.core.telemetry.auto_instrument.GenAIAttributeTransformer')),
+            'baggage_processor': stack.enter_context(patch('sap_cloud_sdk.core.telemetry.auto_instrument.BaggageSpanProcessor')),
+            'get_tracer_provider': stack.enter_context(patch('sap_cloud_sdk.core.telemetry.auto_instrument.trace.get_tracer_provider', return_value=create_autospec(SDKTracerProvider))),
             'create_resource': stack.enter_context(patch('sap_cloud_sdk.core.telemetry.auto_instrument.create_resource_attributes_from_env')),
             'get_app_name': stack.enter_context(patch('sap_cloud_sdk.core.telemetry.auto_instrument._get_app_name')),
         }
@@ -41,31 +45,16 @@ def test_auto_instrument_with_endpoint_success(self, mock_traceloop_components):
             assert call_kwargs['should_enrich_metrics'] is True
             assert call_kwargs['disable_batch'] is True
 
-    def test_auto_instrument_appends_v1_traces_to_endpoint(self, mock_traceloop_components):
-        """Test that auto_instrument appends /v1/traces to endpoint if not present."""
+    def test_auto_instrument_uses_grpc_exporter_by_default(self, mock_traceloop_components):
+        """Test that auto_instrument uses gRPC exporter by default, letting it read endpoint from env."""
         mock_traceloop_components['get_app_name'].return_value = 'test-app'
         mock_traceloop_components['create_resource'].return_value = {}
 
         with patch.dict('os.environ', {'OTEL_EXPORTER_OTLP_ENDPOINT': 'http://localhost:4317'}, clear=True):
             auto_instrument()
 
-            # Verify exporter was called with /v1/traces appended (grpc by default)
-            mock_traceloop_components['grpc_exporter'].assert_called_once_with(
-                endpoint='http://localhost:4317/v1/traces'
-            )
-
-    def test_auto_instrument_preserves_existing_v1_traces(self, mock_traceloop_components):
-        """Test that auto_instrument doesn't duplicate /v1/traces if already present."""
-        mock_traceloop_components['get_app_name'].return_value = 'test-app'
-        mock_traceloop_components['create_resource'].return_value = {}
-
-        with patch.dict('os.environ', {'OTEL_EXPORTER_OTLP_ENDPOINT': 'http://localhost:4317/v1/traces'}, clear=True):
-            auto_instrument()
-
-            # Verify exporter was called with original endpoint (grpc by default)
-            mock_traceloop_components['grpc_exporter'].assert_called_once_with(
-                endpoint='http://localhost:4317/v1/traces'
-            )
+            mock_traceloop_components['grpc_exporter'].assert_called_once_with()
+            mock_traceloop_components['http_exporter'].assert_not_called()
 
     def test_auto_instrument_creates_resource_with_attributes(self, mock_traceloop_components):
         """Test that auto_instrument creates resource with correct attributes."""
@@ -104,17 +93,14 @@ def test_auto_instrument_logs_initialization(self, mock_traceloop_components):
                 assert any('initialized successfully' in msg.lower() for msg in info_calls)
 
     def test_auto_instrument_with_trailing_slash(self, mock_traceloop_components):
-        """Test that auto_instrument handles endpoint with trailing slash."""
+        """Test that auto_instrument works with a trailing slash endpoint (exporter reads from env)."""
         mock_traceloop_components['get_app_name'].return_value = 'test-app'
         mock_traceloop_components['create_resource'].return_value = {}
 
         with patch.dict('os.environ', {'OTEL_EXPORTER_OTLP_ENDPOINT': 'http://localhost:4317/'}, clear=True):
             auto_instrument()
 
-            # Verify trailing slash is removed before appending /v1/traces (grpc by default)
-            mock_traceloop_components['grpc_exporter'].assert_called_once_with(
-                endpoint='http://localhost:4317/v1/traces'
-            )
+            mock_traceloop_components['grpc_exporter'].assert_called_once_with()
 
     def test_auto_instrument_with_http_protobuf_protocol(self, mock_traceloop_components):
         """Test that auto_instrument uses HTTP exporter when OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf."""
@@ -127,11 +113,7 @@ def test_auto_instrument_with_http_protobuf_protocol(self, mock_traceloop_compon
         }, clear=True):
             auto_instrument()
 
-            # Verify HTTP exporter was called with /v1/traces appended
-            mock_traceloop_components['http_exporter'].assert_called_once_with(
-                endpoint='http://localhost:4318/v1/traces'
-            )
-            # Verify gRPC exporter was not called
+            mock_traceloop_components['http_exporter'].assert_called_once_with()
             mock_traceloop_components['grpc_exporter'].assert_not_called()
 
     def test_auto_instrument_passes_transformer_to_traceloop(self, mock_traceloop_components):
@@ -226,3 +208,16 @@ def test_auto_instrument_without_endpoint_or_console(self):
                 mock_logger.warning.assert_called_once()
                 warning_message = mock_logger.warning.call_args[0][0]
                 assert "OTEL_EXPORTER_OTLP_ENDPOINT not set" in warning_message
+
+    def test_auto_instrument_passes_baggage_span_processor(self, mock_traceloop_components):
+        """Test that auto_instrument registers a BaggageSpanProcessor on the tracer provider."""
+        mock_traceloop_components['get_app_name'].return_value = 'test-app'
+        mock_traceloop_components['create_resource'].return_value = {}
+        mock_processor_instance = MagicMock()
+        mock_traceloop_components['baggage_processor'].return_value = mock_processor_instance
+
+        with patch.dict('os.environ', {'OTEL_EXPORTER_OTLP_ENDPOINT': 'http://localhost:4317'}, clear=True):
+            auto_instrument()
+
+            mock_traceloop_components['baggage_processor'].assert_called_once()
+            mock_traceloop_components['get_tracer_provider'].return_value.add_span_processor.assert_called_once_with(mock_processor_instance)