add test to check osparc-trace-id is in response header

Author: bisgaard-itis

packages/service-library/src/servicelib/aiohttp/tracing.py

@@ -15,7 +15,7 @@
     middleware as aiohttp_server_opentelemetry_middleware,  # pylint:disable=no-name-in-module
 )
 from opentelemetry.sdk.resources import Resource
-from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace import SpanProcessor, TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from servicelib.logging_utils import log_context
 from servicelib.tracing import get_trace_id_header
@@ -52,6 +52,14 @@
     HAS_AIO_PIKA = False
 
 
+def _create_span_processor(tracing_destination: str) -> SpanProcessor:
+    otlp_exporter = OTLPSpanExporterHTTP(
+        endpoint=tracing_destination,
+    )
+    span_processor = BatchSpanProcessor(otlp_exporter)
+    return span_processor
+
+
 def _startup(
     app: web.Application,
     tracing_settings: TracingSettings,
@@ -92,12 +100,8 @@ def _startup(
         tracing_destination,
     )
 
-    otlp_exporter = OTLPSpanExporterHTTP(
-        endpoint=tracing_destination,
-    )
-
     # Add the span processor to the tracer provider
-    tracer_provider.add_span_processor(BatchSpanProcessor(otlp_exporter))  # type: ignore[attr-defined] # https://github.com/open-telemetry/opentelemetry-python/issues/3713
+    tracer_provider.add_span_processor(_create_span_processor())  # type: ignore[attr-defined] # https://github.com/open-telemetry/opentelemetry-python/issues/3713
     # Instrument aiohttp server
     # Explanation for custom middleware call DK 10/2024:
     # OpenTelemetry Aiohttp autoinstrumentation is meant to be used by only calling `AioHttpServerInstrumentor().instrument()`

packages/service-library/tests/aiohttp/conftest.py

@@ -1,2 +1,21 @@
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument
+
+
+from collections.abc import Iterator
+from unittest.mock import patch
+
+import pytest
+from opentelemetry.sdk.trace.export import SimpleSpanProcessor
+from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
+from pytest_mock import MockerFixture
+
+
+@pytest.fixture
+def mock_otel_collector(mocker: MockerFixture) -> Iterator[InMemorySpanExporter]:
+    memory_exporter = InMemorySpanExporter()
+    span_processor = SimpleSpanProcessor(memory_exporter)
+    with patch(
+        "servicelib.aiohttp.tracing._create_span_processor", return_value=span_processor
+    ):
+        yield memory_exporter

packages/service-library/tests/aiohttp/test_tracing.py

@@ -10,8 +10,10 @@
 import pytest
 from aiohttp import web
 from aiohttp.test_utils import TestClient
+from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
 from pydantic import ValidationError
 from servicelib.aiohttp.tracing import get_tracing_lifespan
+from servicelib.tracing import _OSPARC_TRACE_ID_HEADER
 from settings_library.tracing import TracingSettings
 
 
@@ -148,3 +150,45 @@ async def test_tracing_setup_package_detection(
             tracing_settings=tracing_settings,
         )(app):
             pass
+
+
+@pytest.mark.parametrize(
+    "tracing_settings_in",
+    [
+        ("http://opentelemetry-collector", 4318),
+    ],
+    indirect=True,
+)
+@pytest.mark.parametrize(
+    "response", [web.Response(text="Hello, world!"), web.HTTPNotFound()]
+)
+async def test_trace_id_in_response_header(
+    mock_otel_collector: InMemorySpanExporter,
+    aiohttp_client: Callable,
+    set_and_clean_settings_env_vars: Callable,
+    tracing_settings_in,
+    uninstrument_opentelemetry: Iterator[None],
+    response: web.Response | web.HTTPException,
+) -> None:
+    app = web.Application()
+    service_name = "simcore_service_webserver"
+    tracing_settings = TracingSettings()
+
+    async def handler(request: web.Request) -> web.Response:
+        if isinstance(response, web.HTTPException):
+            raise response
+        return response
+
+    app.router.add_get("/", handler)
+
+    async for _ in get_tracing_lifespan(
+        app,
+        service_name=service_name,
+        tracing_settings=tracing_settings,
+        add_response_trace_id_header=True,
+    )(app):
+        client = await aiohttp_client(app)
+        response = await client.get("/")
+        assert _OSPARC_TRACE_ID_HEADER in response.headers
+        trace_id = response.headers[_OSPARC_TRACE_ID_HEADER]
+        assert len(trace_id) == 32  # Ensure trace ID is a 32-character hex string