✨ Refactor: Integrate Prometheus instrumentation and tracing into application lifespan management

Author: pcrespov

services/catalog/src/simcore_service_catalog/core/application.py

@@ -5,17 +5,11 @@
 from models_library.basic_types import BootModeEnum
 from servicelib.fastapi import timing_middleware
 from servicelib.fastapi.openapi import override_fastapi_openapi_method
-from servicelib.fastapi.profiler import initialize_profiler
-from servicelib.fastapi.prometheus_instrumentation import (
-    setup_prometheus_instrumentation,
-)
-from servicelib.fastapi.tracing import initialize_tracing
 from starlette.middleware.base import BaseHTTPMiddleware
 
 from .._meta import (
     API_VERSION,
     API_VTAG,
-    APP_NAME,
     PROJECT_NAME,
     SUMMARY,
 )
@@ -65,16 +59,7 @@ def create_app() -> FastAPI:
     # STATE
     app.state.settings = settings
 
-    if settings.CATALOG_TRACING:
-        initialize_tracing(app, settings.CATALOG_TRACING, APP_NAME)
-
     # MIDDLEWARES
-    if settings.CATALOG_PROMETHEUS_INSTRUMENTATION_ENABLED:
-        setup_prometheus_instrumentation(app)
-
-    if settings.CATALOG_PROFILING:
-        initialize_profiler(app)
-
     if settings.SC_BOOT_MODE != BootModeEnum.PRODUCTION:
         # middleware to time requests (ONLY for development)
         app.add_middleware(

services/catalog/src/simcore_service_catalog/core/events.py

@@ -7,8 +7,13 @@
     PostgresLifespanStateKeys,
     postgres_lifespan,
 )
+from servicelib.fastapi.prometheus_instrumentation import (
+    initialize_prometheus_instrumentation,
+    lifespan_prometheus_instrumentation,
+)
+from servicelib.fastapi.tracing import initialize_tracing
 
-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 ..db.events import setup_database
 from ..services.director import setup_director
 from ..services.function_services import setup_function_services
@@ -33,18 +38,34 @@ async def _setup_app(app: FastAPI) -> AsyncIterator[State]:
 
     settings: ApplicationSettings = app.state.settings
 
+    if settings.CATALOG_TRACING:
+        initialize_tracing(app, settings.CATALOG_TRACING, APP_NAME)
+
     yield {
         PostgresLifespanStateKeys.POSTGRES_SETTINGS: settings.CATALOG_POSTGRES,
+        "prometheus_instrumentation_enabled": settings.CATALOG_PROMETHEUS_INSTRUMENTATION_ENABLED,
     }
 
     flush_finished_banner()
 
 
+async def _setup_prometheus_instrumentation_adapter(
+    app: FastAPI, state: State
+) -> AsyncIterator[State]:
+    enabled = state.get("prometheus_instrumentation_enabled", False)
+    if enabled:
+        initialize_prometheus_instrumentation(app)
+        async for _state in lifespan_prometheus_instrumentation(app):
+            yield _state
+
+
 def create_app_lifespan():
     # app lifespan
     app_lifespan = LifespanManager()
     app_lifespan.add(_setup_app)
 
+    # WARNING: order matters
+
     # - postgres lifespan
     postgres_lifespan.add(setup_database)
     app_lifespan.include(postgres_lifespan)
@@ -61,4 +82,7 @@ def create_app_lifespan():
     # - background task lifespan
     app_lifespan.add(setup_background_task)
 
+    # - prometheus instrumentation lifespan
+    app_lifespan.add(_setup_prometheus_instrumentation_adapter)
+
     return app_lifespan