add getter for tracing instrumentation lifespan

Author: bisgaard-itis

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

@@ -70,9 +70,7 @@
     HAS_AIOPIKA_INSTRUMENTOR = False
 
 
-def initialize_tracing(
-    app: FastAPI, tracing_settings: TracingSettings, service_name: str
-) -> None:
+def _startup(tracing_settings: TracingSettings, service_name: str) -> None:
     if (
         not tracing_settings.TRACING_OPENTELEMETRY_COLLECTOR_ENDPOINT
         and not tracing_settings.TRACING_OPENTELEMETRY_COLLECTOR_PORT
@@ -102,8 +100,6 @@ def initialize_tracing(
     otlp_exporter = OTLPSpanExporterHTTP(endpoint=tracing_destination)
     span_processor = BatchSpanProcessor(otlp_exporter)
     global_tracer_provider.add_span_processor(span_processor)
-    # Instrument FastAPI
-    FastAPIInstrumentor().instrument_app(app)
 
     if HAS_AIOPG:
         with log_context(
@@ -191,20 +187,31 @@ def setup_tracing(
     app: FastAPI, tracing_settings: TracingSettings, service_name: str
 ) -> None:
 
-    initialize_tracing(app, tracing_settings, service_name)
+    _startup(tracing_settings=tracing_settings, service_name=service_name)
+
+    def _on_startup() -> None:
+        FastAPIInstrumentor().instrument_app(app)
 
     def _on_shutdown() -> None:
         _shutdown()
 
+    app.add_event_handler("startup", _on_startup)
     app.add_event_handler("shutdown", _on_shutdown)
 
 
-async def tracing_instrumentation_lifespan(
-    app: FastAPI,
-) -> AsyncIterator[State]:
-    # initialize tracing must be called (typically right after the app is created)
-    assert app  # nosec
+def get_tracing_instrumentation_lifespan(
+    tracing_settings: TracingSettings, service_name: str
+):
+
+    _startup(tracing_settings=tracing_settings, service_name=service_name)
 
-    yield {}
+    async def tracing_instrumentation_lifespan(
+        app: FastAPI,
+    ) -> AsyncIterator[State]:
+        FastAPIInstrumentor().instrument_app(app)
+
+        yield {}
+
+        _shutdown()
 
-    _shutdown()
+    return tracing_instrumentation_lifespan

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

@@ -12,8 +12,7 @@
 from fastapi import FastAPI
 from pydantic import ValidationError
 from servicelib.fastapi.tracing import (
-    initialize_tracing,
-    tracing_instrumentation_lifespan,
+    get_tracing_instrumentation_lifespan,
 )
 from settings_library.tracing import TracingSettings
 
@@ -66,22 +65,14 @@ async def test_valid_tracing_settings(
     uninstrument_opentelemetry: Iterator[None],
 ):
     tracing_settings = TracingSettings()
-    initialize_tracing(
-        app=mocked_app,
+    async for _ in get_tracing_instrumentation_lifespan(
         tracing_settings=tracing_settings,
         service_name="Mock-Openetlemetry-Pytest",
-    )
-    async for state in tracing_instrumentation_lifespan(
-        app=mocked_app,
-    ):
-        initialize_tracing(
-            app=mocked_app,
+    )(app=mocked_app):
+        async for _ in get_tracing_instrumentation_lifespan(
             tracing_settings=tracing_settings,
             service_name="Mock-Openetlemetry-Pytest",
-        )
-        async for _ in tracing_instrumentation_lifespan(
-            app=mocked_app,
-        ):
+        )(app=mocked_app):
             pass
 
 
@@ -110,15 +101,10 @@ async def test_invalid_tracing_settings(
     app = mocked_app
     with pytest.raises((BaseException, ValidationError, TypeError)):  # noqa: PT012
         tracing_settings = TracingSettings()
-        initialize_tracing(
-            app=app,
+        async for _ in get_tracing_instrumentation_lifespan(
             tracing_settings=tracing_settings,
             service_name="Mock-Openetlemetry-Pytest",
-        )
-
-        async for _ in tracing_instrumentation_lifespan(
-            app=app,
-        ):
+        )(app=app):
             pass
 
 
@@ -171,22 +157,13 @@ async def test_tracing_setup_package_detection(
     package_name = manage_package
     importlib.import_module(package_name)
     tracing_settings = TracingSettings()
-    # Use tracing_instrumentation_lifespan instead of _startup
-    initialize_tracing(
-        app=mocked_app,
+    async for _ in get_tracing_instrumentation_lifespan(
         tracing_settings=tracing_settings,
         service_name="Mock-Openetlemetry-Pytest",
-    )
-    async for _ in tracing_instrumentation_lifespan(
-        app=mocked_app,
-    ):
-        # idempotency: call again
-        initialize_tracing(
-            app=mocked_app,
+    )(app=mocked_app):
+        # idempotency check
+        async for _ in get_tracing_instrumentation_lifespan(
             tracing_settings=tracing_settings,
             service_name="Mock-Openetlemetry-Pytest",
-        )
-        async for _ in tracing_instrumentation_lifespan(
-            app=mocked_app,
-        ):
+        )(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 initialize_tracing
+from servicelib.fastapi.tracing import _startup
 
 from .._meta import API_VERSION, API_VTAG, APP_NAME, PROJECT_NAME, SUMMARY
 from ..api.frontend import initialize_frontend
@@ -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:
-        initialize_tracing(app, app_settings.DYNAMIC_SCHEDULER_TRACING, APP_NAME)
+        _startup(app, app_settings.DYNAMIC_SCHEDULER_TRACING, APP_NAME)
 
     initialize_rest_api(app)
 

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

@@ -13,9 +13,9 @@
 from servicelib.fastapi.postgres_lifespan import (
     create_postgres_database_input_state,
 )
-from servicelib.fastapi.tracing import tracing_instrumentation_lifespan
+from servicelib.fastapi.tracing import get_tracing_instrumentation_lifespan
 
-from .._meta import APP_FINISHED_BANNER_MSG, APP_STARTED_BANNER_MSG
+from .._meta import APP_FINISHED_BANNER_MSG, APP_NAME, APP_STARTED_BANNER_MSG
 from ..api.rpc.routes import rpc_api_routes_lifespan
 from ..repository.events import repository_lifespan_manager
 from ..services.catalog import catalog_lifespan
@@ -56,7 +56,12 @@ def create_app_lifespan(settings: ApplicationSettings) -> LifespanManager:
     app_lifespan.add(_settings_lifespan)
 
     if settings.DYNAMIC_SCHEDULER_TRACING:
-        app_lifespan.add(tracing_instrumentation_lifespan)
+        app_lifespan.add(
+            get_tracing_instrumentation_lifespan(
+                tracing_settings=settings.DYNAMIC_SCHEDULER_TRACING,
+                service_name=APP_NAME,
+            )
+        )
 
     app_lifespan.include(repository_lifespan_manager)
     app_lifespan.add(director_v2_lifespan)