Merge pull request #1205 from roboflow/fix/correlation-id-env-typo

Add CORRELATION_ID_LOG_KEY; fix typo for CORRELATION_ID_HEADER; control logging across modules with single env variable API_LOGGING_ENABLED

Author: PawelPeczek-Roboflow

inference/core/env.py

@@ -242,8 +242,14 @@
 # Whether is's GCP serverless service
 GCP_SERVERLESS = str2bool(os.getenv("GCP_SERVERLESS", "False"))
 
+# Flag to enable API logging, default is False
+API_LOGGING_ENABLED = str2bool(os.getenv("API_LOGGING_ENABLED", "False"))
+
+# Header where correlaction ID for logging is stored
+CORRELATION_ID_HEADER = os.getenv("CORRELATION_ID_HEADER", "X-Request-ID")
+
 # Header where correlaction ID for logging is stored
-CORRELACTION_ID_HEADER = os.getenv("CORRELACTION_ID_HEADER", "X-Request-ID")
+CORRELATION_ID_LOG_KEY = os.getenv("CORRELATION_ID_LOG_KEY", "request_id")
 
 # Flag to enable legacy route, default is True
 LEGACY_ROUTE_ENABLED = str2bool(os.getenv("LEGACY_ROUTE_ENABLED", True))

inference/core/interfaces/http/http_api.py

@@ -100,6 +100,7 @@
 from inference.core.env import (
     ALLOW_ORIGINS,
     API_KEY,
+    API_LOGGING_ENABLED,
     BUILDER_ORIGIN,
     CORE_MODEL_CLIP_ENABLED,
     CORE_MODEL_DOCTR_ENABLED,
@@ -111,8 +112,7 @@
     CORE_MODEL_TROCR_ENABLED,
     CORE_MODEL_YOLO_WORLD_ENABLED,
     CORE_MODELS_ENABLED,
-    CORRELACTION_ID_HEADER,
-    DEDICATED_DEPLOYMENT_ID,
+    CORRELATION_ID_HEADER,
     DEDICATED_DEPLOYMENT_WORKSPACE_URL,
     DEPTH_ESTIMATION_ENABLED,
     DISABLE_WORKFLOW_ENDPOINTS,
@@ -636,10 +636,10 @@ async def on_shutdown():
                 strip_dirs=False,
                 sort_by="cumulative",
             )
-        if DEDICATED_DEPLOYMENT_ID or GCP_SERVERLESS:
+        if API_LOGGING_ENABLED:
             app.add_middleware(
                 asgi_correlation_id.CorrelationIdMiddleware,
-                header_name=CORRELACTION_ID_HEADER,
+                header_name=CORRELATION_ID_HEADER,
                 update_request_header=True,
                 generator=lambda: uuid4().hex,
                 validator=lambda a: True,

inference/core/logger.py

@@ -6,7 +6,7 @@
 from rich.logging import RichHandler
 from structlog.processors import CallsiteParameter
 
-from inference.core.env import LOG_LEVEL
+from inference.core.env import API_LOGGING_ENABLED, CORRELATION_ID_LOG_KEY, LOG_LEVEL
 from inference.core.utils.environment import str2bool
 
 if LOG_LEVEL == "ERROR" or LOG_LEVEL == "FATAL":
@@ -20,11 +20,11 @@ def add_correlation(
 
     request_id = correlation_id.get()
     if request_id:
-        event_dict["request_id"] = request_id
+        event_dict[CORRELATION_ID_LOG_KEY] = request_id
     return event_dict
 
 
-if str2bool(os.getenv("API_LOGGING_ENABLED", "False")):
+if API_LOGGING_ENABLED:
     import structlog
 
     structlog.configure(