use lifespan manager approach

Author: bisgaard-itis

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

@@ -70,7 +70,7 @@
     HAS_AIOPIKA_INSTRUMENTOR = False
 
 
-def _startup(
+def initialize_tracing(
     app: FastAPI, tracing_settings: TracingSettings, service_name: str
 ) -> None:
     if (
@@ -191,7 +191,7 @@ def setup_tracing(
     app: FastAPI, tracing_settings: TracingSettings, service_name: str
 ) -> None:
 
-    _startup(app, tracing_settings, service_name)
+    initialize_tracing(app, tracing_settings, service_name)
 
     def _on_shutdown() -> None:
         _shutdown()
@@ -200,15 +200,11 @@ def _on_shutdown() -> None:
 
 
 async def tracing_instrumentation_lifespan(
-    *,
     app: FastAPI,
-    state: State,
-    tracing_settings: TracingSettings,
-    service_name: str,
 ) -> AsyncIterator[State]:
+    # initialize tracing must be called (typically right after the app is created)
+    assert app  # nosec
 
-    _startup(app, tracing_settings, service_name)
-
-    yield state
+    yield {}
 
     _shutdown()

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

@@ -11,7 +11,10 @@
 import pytest
 from fastapi import FastAPI
 from pydantic import ValidationError
-from servicelib.fastapi.tracing import tracing_instrumentation_lifespan
+from servicelib.fastapi.tracing import (
+    initialize_tracing,
+    tracing_instrumentation_lifespan,
+)
 from settings_library.tracing import TracingSettings
 
 
@@ -63,17 +66,21 @@ async def test_valid_tracing_settings(
     uninstrument_opentelemetry: Iterator[None],
 ):
     tracing_settings = TracingSettings()
-    async for state in tracing_instrumentation_lifespan(
+    initialize_tracing(
         app=mocked_app,
-        state={},
         tracing_settings=tracing_settings,
         service_name="Mock-Openetlemetry-Pytest",
+    )
+    async for state in tracing_instrumentation_lifespan(
+        app=mocked_app,
     ):
-        async for _ in tracing_instrumentation_lifespan(
+        initialize_tracing(
             app=mocked_app,
-            state=state,
             tracing_settings=tracing_settings,
             service_name="Mock-Openetlemetry-Pytest",
+        )
+        async for _ in tracing_instrumentation_lifespan(
+            app=mocked_app,
         ):
             pass
 
@@ -103,11 +110,14 @@ async def test_invalid_tracing_settings(
     app = mocked_app
     with pytest.raises((BaseException, ValidationError, TypeError)):  # noqa: PT012
         tracing_settings = TracingSettings()
-        async for _ in tracing_instrumentation_lifespan(
+        initialize_tracing(
             app=app,
-            state={},
             tracing_settings=tracing_settings,
             service_name="Mock-Openetlemetry-Pytest",
+        )
+
+        async for _ in tracing_instrumentation_lifespan(
+            app=app,
         ):
             pass
 
@@ -162,17 +172,21 @@ async def test_tracing_setup_package_detection(
     importlib.import_module(package_name)
     tracing_settings = TracingSettings()
     # Use tracing_instrumentation_lifespan instead of _startup
-    async for _ in tracing_instrumentation_lifespan(
+    initialize_tracing(
         app=mocked_app,
-        state={},
         tracing_settings=tracing_settings,
         service_name="Mock-Openetlemetry-Pytest",
+    )
+    async for _ in tracing_instrumentation_lifespan(
+        app=mocked_app,
     ):
         # idempotency: call again
-        async for _ in tracing_instrumentation_lifespan(
+        initialize_tracing(
             app=mocked_app,
-            state={},
             tracing_settings=tracing_settings,
             service_name="Mock-Openetlemetry-Pytest",
+        )
+        async for _ in tracing_instrumentation_lifespan(
+            app=mocked_app,
         ):
             pass

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/core/application.py

@@ -4,7 +4,7 @@
 )
 from servicelib.fastapi.openapi import override_fastapi_openapi_method
 from servicelib.fastapi.profiler import initialize_profiler
-from servicelib.fastapi.tracing import setup_tracing
+from servicelib.fastapi.tracing import initialize_tracing
 
 from .._meta import API_VERSION, API_VTAG, APP_NAME, PROJECT_NAME, SUMMARY
 from ..api.frontend import initialize_frontend
@@ -25,7 +25,7 @@ def create_app(settings: ApplicationSettings | None = None) -> FastAPI:
             "/doc" if app_settings.DYNAMIC_SCHEDULER_SWAGGER_API_DOC_ENABLED else None
         ),
         redoc_url=None,
-        lifespan=events.create_app_lifespan(),
+        lifespan=events.create_app_lifespan(settings=app_settings),
     )
     override_fastapi_openapi_method(app)
 
@@ -34,7 +34,7 @@ def create_app(settings: ApplicationSettings | None = None) -> FastAPI:
     assert app.state.settings.API_VERSION == API_VERSION  # nosec
 
     if app_settings.DYNAMIC_SCHEDULER_TRACING:
-        setup_tracing(app, app_settings.DYNAMIC_SCHEDULER_TRACING, APP_NAME)
+        initialize_tracing(app, app_settings.DYNAMIC_SCHEDULER_TRACING, APP_NAME)
 
     initialize_rest_api(app)
 

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/core/events.py

@@ -13,6 +13,7 @@
 from servicelib.fastapi.postgres_lifespan import (
     create_postgres_database_input_state,
 )
+from servicelib.fastapi.tracing import tracing_instrumentation_lifespan
 
 from .._meta import APP_FINISHED_BANNER_MSG, APP_STARTED_BANNER_MSG
 from ..api.rpc.routes import rpc_api_routes_lifespan
@@ -50,10 +51,13 @@ async def _settings_lifespan(app: FastAPI) -> AsyncIterator[State]:
     }
 
 
-def create_app_lifespan() -> LifespanManager:
+def create_app_lifespan(settings: ApplicationSettings) -> LifespanManager:
     app_lifespan = LifespanManager()
     app_lifespan.add(_settings_lifespan)
 
+    if settings.DYNAMIC_SCHEDULER_TRACING:
+        app_lifespan.add(tracing_instrumentation_lifespan)
+
     app_lifespan.include(repository_lifespan_manager)
     app_lifespan.add(director_v2_lifespan)
     app_lifespan.add(director_v0_lifespan)