HEALTHCHECK_APPKEY

Author: pcrespov

services/web/server/src/simcore_service_webserver/diagnostics/_healthcheck.py

@@ -55,7 +55,7 @@ def value(self) -> float:
 HEALTH_LAST_REQUESTS_AVG_LATENCY: Final = f"{__name__}.last_requests_avg_latency"
 HEALTH_MAX_AVG_RESP_LATENCY: Final = f"{__name__}.max_avg_response_latency"
 HEALTH_MAX_TASK_DELAY: Final = f"{__name__}.max_task_delay"
-HEALTH_PLUGIN_START_TIME: Final = f"{__name__}.plugin_start_time"
+HEALTH_PLUGIN_START_TIME: Final = web.AppKey("HEALTH_PLUGIN_START_TIME", time.time)
 HEALTH_START_SENSING_DELAY_SECS: Final = f"{__name__}.start_sensing_delay"
 
 

services/web/server/src/simcore_service_webserver/diagnostics/plugin.py

@@ -9,7 +9,7 @@
 
 from ..application_settings import get_application_settings
 from ..application_setup import ModuleCategory, app_setup_func
-from ..rest.healthcheck import HealthCheck
+from ..rest.healthcheck import HEALTHCHECK_APPKEY
 from ..rest.plugin import setup_rest
 from . import _handlers
 from ._healthcheck import (
@@ -52,7 +52,7 @@ def setup_diagnostics(app: web.Application):
     setup_monitoring(app)
 
     if settings.DIAGNOSTICS_HEALTHCHECK_ENABLED:
-        healthcheck: HealthCheck = app[HealthCheck.__name__]
+        healthcheck = app[HEALTHCHECK_APPKEY]
         healthcheck.on_healthcheck.append(_on_healthcheck_async_adapter)
 
     # adds other diagnostic routes: healthcheck, etc

services/web/server/src/simcore_service_webserver/rabbitmq.py

@@ -17,7 +17,7 @@
 
 from .application_setup import ModuleCategory, app_setup_func
 from .rabbitmq_settings import RabbitSettings, get_plugin_settings
-from .rest.healthcheck import HealthCheck, HealthCheckError
+from .rest.healthcheck import HEALTHCHECK_APPKEY, HealthCheckError
 
 _logger = logging.getLogger(__name__)
 
@@ -46,7 +46,7 @@ async def _rabbitmq_client_cleanup_ctx(app: web.Application) -> AsyncIterator[No
         )
 
     # injects healthcheck
-    healthcheck: HealthCheck = app[HealthCheck.__name__]
+    healthcheck = app[HEALTHCHECK_APPKEY]
     healthcheck.on_healthcheck.append(_on_healthcheck_async_adapter)
 
     yield

services/web/server/src/simcore_service_webserver/rest/_handlers.py

@@ -14,7 +14,7 @@
 from ..products import products_web
 from ..redis import get_redis_scheduled_maintenance_client
 from ..utils_aiohttp import envelope_json_response
-from .healthcheck import HealthCheck, HealthCheckError
+from .healthcheck import HEALTHCHECK_APPKEY, HealthCheckError
 
 _logger = logging.getLogger(__name__)
 
@@ -30,7 +30,7 @@ async def healthcheck_liveness_probe(request: web.Request):
 
     SEE doc in healthcheck.py
     """
-    healthcheck: HealthCheck = request.app[HealthCheck.__name__]
+    healthcheck = request.app[HEALTHCHECK_APPKEY]
 
     try:
         # if slots append get too delayed, just timeout
@@ -53,7 +53,7 @@ async def healthcheck_readiness_probe(request: web.Request):
     SEE doc in healthcheck.py
     """
 
-    healthcheck: HealthCheck = request.app[HealthCheck.__name__]
+    healthcheck = request.app[HEALTHCHECK_APPKEY]
     app_info = healthcheck.get_app_info(request.app)
     # NOTE: do NOT run healthcheck here, just return info fast.
     return envelope_json_response(app_info)

services/web/server/src/simcore_service_webserver/rest/healthcheck.py

@@ -1,4 +1,4 @@
-""" Service healthcheck
+"""Service healthcheck
 
 
 ## Types of health checks
@@ -43,11 +43,10 @@
 Taken from https://docs.docker.com/engine/reference/builder/#healthcheck
 """
 
-
 import asyncio
 import inspect
 from collections.abc import Awaitable, Callable
-from typing import TypeAlias
+from typing import Final, TypeAlias
 
 from aiohttp import web
 from aiosignal import Signal
@@ -122,6 +121,9 @@ async def run(self, app: web.Application) -> HealthInfoDict:
             heath_report: HealthInfoDict = self.get_app_info(app)
             return heath_report
 
-        except asyncio.TimeoutError as err:
+        except TimeoutError as err:
             msg = "Service is slowing down"
             raise HealthCheckError(msg) from err
+
+
+HEALTHCHECK_APPKEY: Final = web.AppKey("HEALTHCHECK_APPKEY", HealthCheck)

services/web/server/src/simcore_service_webserver/rest/plugin.py

@@ -20,7 +20,7 @@
 from ..security.plugin import setup_security
 from . import _handlers
 from ._utils import get_openapi_specs_path
-from .healthcheck import HealthCheck
+from .healthcheck import HEALTHCHECK_APPKEY, HealthCheck
 from .settings import RestSettings, get_plugin_settings
 
 _logger = logging.getLogger(__name__)
@@ -39,8 +39,8 @@ def setup_rest(app: web.Application):
 
     spec_path = get_openapi_specs_path(api_version_dir=API_VTAG)
 
-    app[HealthCheck.__name__] = HealthCheck(app)
-    _logger.debug("Setup %s", f"{app[HealthCheck.__name__]=}")
+    app[HEALTHCHECK_APPKEY] = HealthCheck(app)
+    _logger.debug("Setup %s", f"{app[HEALTHCHECK_APPKEY]=}")
 
     # basic routes
     app.add_routes(_handlers.routes)