added tracing to agent service

Author: Andrei Neagu

.env-devel

@@ -17,6 +17,7 @@ AGENT_VOLUMES_CLEANUP_S3_ENDPOINT=http://172.17.0.1:9001
 AGENT_VOLUMES_CLEANUP_S3_PROVIDER=MINIO
 AGENT_VOLUMES_CLEANUP_S3_REGION=us-east-1
 AGENT_VOLUMES_CLEANUP_S3_SECRET_KEY=12345678
+AGENT_TRACING={}
 
 API_SERVER_DEV_FEATURES_ENABLED=0
 API_SERVER_LOGLEVEL=INFO

services/agent/src/simcore_service_agent/core/application.py

@@ -5,6 +5,7 @@
     get_common_oas_options,
     override_fastapi_openapi_method,
 )
+from servicelib.fastapi.tracing import setup_tracing
 from servicelib.logging_utils import config_all_loggers
 
 from .._meta import (
@@ -59,6 +60,9 @@ def create_app() -> FastAPI:
     setup_rest_api(app)
     setup_rpc_api_routes(app)
 
+    if settings.AGENT_TRACING:
+        setup_tracing(app, settings.AGENT_TRACING, APP_NAME)
+
     async def _on_startup() -> None:
         print(APP_STARTED_BANNER_MSG, flush=True)  # noqa: T201
 

services/agent/src/simcore_service_agent/core/settings.py

@@ -6,6 +6,7 @@
 from settings_library.base import BaseCustomSettings
 from settings_library.r_clone import S3Provider
 from settings_library.rabbit import RabbitSettings
+from settings_library.tracing import TracingSettings
 from settings_library.utils_logging import MixinLoggingSettings
 
 
@@ -77,6 +78,10 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
         auto_default_from_env=True, description="settings for service/rabbitmq"
     )
 
+    AGENT_TRACING: TracingSettings | None = Field(
+        auto_default_from_env=True, description="settings for opentelemetry tracing"
+    )
+
     @validator("LOGLEVEL")
     @classmethod
     def valid_log_level(cls, value) -> LogLevel:

services/agent/tests/conftest.py

@@ -58,6 +58,7 @@ def mock_environment(
             "RABBIT_SECURE": "false",
             "RABBIT_USER": "test",
             "AGENT_DOCKER_NODE_ID": docker_node_id,
+            "AGENT_TRACING": "null",
         },
     )
 

services/docker-compose.yml

@@ -1053,6 +1053,10 @@ services:
       RABBIT_USER: ${RABBIT_USER}
       RABBIT_SECURE: ${RABBIT_SECURE}
 
+      AGENT_TRACING: ${AGENT_TRACING}
+      TRACING_OPENTELEMETRY_COLLECTOR_ENDPOINT: ${TRACING_OPENTELEMETRY_COLLECTOR_ENDPOINT}
+      TRACING_OPENTELEMETRY_COLLECTOR_PORT: ${TRACING_OPENTELEMETRY_COLLECTOR_PORT}
+
   dask-sidecar:
     image: ${DOCKER_REGISTRY:-itisfoundation}/dask-sidecar:${DOCKER_IMAGE_TAG:-latest}
     init: true