feat: instrument micro-service entrypoints with OpenTelemetry (refs #4)

Author: pmcfadin

app/main_comment.py

@@ -11,6 +11,7 @@
 from app.api.v1.endpoints.comments_ratings import (
     router as comments_ratings_router,
 )
+from app.utils.observability import configure_observability
 
 logger = logging.getLogger(__name__)
 
@@ -30,6 +31,9 @@
 
 service_app.include_router(comments_ratings_router, prefix=settings.API_V1_STR)
 
+# Initialise observability
+configure_observability(service_app)
+
 
 @service_app.on_event("startup")
 async def startup_event() -> None:

app/main_moderation.py

@@ -9,6 +9,7 @@
 from app.db.astra_client import init_astra_db
 from app.models.common import ProblemDetail
 from app.api.v1.endpoints.moderation import router as moderation_router
+from app.utils.observability import configure_observability
 
 logger = logging.getLogger(__name__)
 
@@ -27,6 +28,9 @@
 
 service_app.include_router(moderation_router, prefix=settings.API_V1_STR)
 
+# Initialise observability
+configure_observability(service_app)
+
 
 @service_app.on_event("startup")
 async def startup_event() -> None:

app/main_reco.py

@@ -12,6 +12,7 @@
     router as recommendations_feed_router,
 )
 from app.api.v1.endpoints.reco_internal import router as reco_internal_router
+from app.utils.observability import configure_observability
 
 logger = logging.getLogger(__name__)
 
@@ -32,6 +33,9 @@
 service_app.include_router(recommendations_feed_router, prefix=settings.API_V1_STR)
 service_app.include_router(reco_internal_router, prefix=settings.API_V1_STR)
 
+# Initialise observability
+configure_observability(service_app)
+
 
 @service_app.on_event("startup")
 async def startup_event() -> None:

app/main_search.py

@@ -11,6 +11,7 @@
 from app.api.v1.endpoints.search_catalog import (
     router as search_catalog_router,
 )
+from app.utils.observability import configure_observability
 
 logger = logging.getLogger(__name__)
 
@@ -29,6 +30,9 @@
 
 service_app.include_router(search_catalog_router, prefix=settings.API_V1_STR)
 
+# Initialise observability
+configure_observability(service_app)
+
 
 @service_app.on_event("startup")
 async def startup_event() -> None:

app/main_user.py

@@ -11,6 +11,7 @@
 from app.api.v1.endpoints.account_management import (
     router as account_management_router,
 )
+from app.utils.observability import configure_observability
 
 logger = logging.getLogger(__name__)
 
@@ -32,6 +33,9 @@
 # Include router(s)
 service_app.include_router(account_management_router, prefix=settings.API_V1_STR)
 
+# Initialise observability (metrics, traces, logs) if enabled
+configure_observability(service_app)
+
 
 @service_app.on_event("startup")
 async def startup_event() -> None:

app/main_video.py

@@ -10,6 +10,7 @@
 from app.models.common import ProblemDetail
 from app.api.v1.endpoints.video_catalog import router as video_catalog_router
 from app.api.v1.endpoints.flags import router as flags_router
+from app.utils.observability import configure_observability
 
 logger = logging.getLogger(__name__)
 
@@ -30,6 +31,9 @@
 service_app.include_router(video_catalog_router, prefix=settings.API_V1_STR)
 service_app.include_router(flags_router, prefix=settings.API_V1_STR)
 
+# Initialise observability
+configure_observability(service_app)
+
 
 @service_app.on_event("startup")
 async def startup_event() -> None:

env.example

@@ -48,6 +48,32 @@ SECRET_KEY=please-change-me-to-a-long-random-string
 # migrations & backfill jobs have run successfully.
 VECTOR_SEARCH_ENABLED=false
 
+# --------------------------------------------------------------------
+# Observability / Telemetry
+# --------------------------------------------------------------------
+# Enable or disable all observability integrations (Prometheus, OpenTelemetry, Loki).
+OBSERVABILITY_ENABLED=true
+
+# --- OpenTelemetry (Traces & Metrics) --------------------------------
+# Base OTLP endpoint; for local docker-compose stack use http://localhost:4318
+OTEL_EXPORTER_OTLP_ENDPOINT=http://replace-me:4318
+
+# Protocol can be "grpc" (4317) or "http" (4318). Only grpc supported right now.
+# OTEL_EXPORTER_OTLP_PROTOCOL=grpc
+
+# Example auth header – uncomment if your collector expects mcp-token header.
+# OTEL_EXPORTER_OTLP_HEADERS=mcp-token=REPLACE_ME_TOKEN
+
+# Toggle traces / metrics export (true/false)
+OTEL_TRACES_ENABLED=true
+OTEL_METRICS_ENABLED=false
+
+# --- Loki -------------------------------------------------------------
+# Ship structured logs to Loki. Ensure logging-loki dependency installed.
+# LOKI_ENABLED=false
+# LOKI_ENDPOINT=http://loki:3100/loki/api/v1
+# LOKI_EXTRA_LABELS=team=backend,feature=killrvideo
+
 #######################################################################
 # End of file
 #######################################################################