hatchet-sdk 0.42.5__py3-none-any.whl → 0.43.1__py3-none-any.whl

hatchet_sdk/hatchet.py

@@ -1,6 +1,6 @@
 import asyncio
 import logging
-from typing import Any, Callable, Optional, Type, TypeVar, Union
+from typing import Any, Callable, Optional, ParamSpec, Type, TypeVar, Union
 
 from pydantic import BaseModel
 from typing_extensions import deprecated
@@ -35,6 +35,9 @@ from .workflow import (
 )
 
 T = TypeVar("T", bound=BaseModel)
+R = TypeVar("R")
+P = ParamSpec("P")
+
 TWorkflow = TypeVar("TWorkflow", bound=object)
 
 
@@ -87,10 +90,10 @@ def step(
     desired_worker_labels: dict[str, DesiredWorkerLabel] = {},
     backoff_factor: float | None = None,
     backoff_max_seconds: int | None = None,
-) -> Callable[..., Any]:
+) -> Callable[[Callable[P, R]], Callable[P, R]]:
     parents = parents or []
 
-    def inner(func: Callable[[Context], Any]) -> Callable[[Context], Any]:
+    def inner(func: Callable[P, R]) -> Callable[P, R]:
         limits = None
         if rate_limits:
             limits = [rate_limit._req for rate_limit in rate_limits or []]
@@ -99,7 +102,6 @@ def step(
         setattr(func, "_step_parents", parents)
         setattr(func, "_step_timeout", timeout)
         setattr(func, "_step_retries", retries)
-        setattr(func, "_step_rate_limits", retries)
         setattr(func, "_step_rate_limits", limits)
         setattr(func, "_step_backoff_factor", backoff_factor)
         setattr(func, "_step_backoff_max_seconds", backoff_max_seconds)

hatchet_sdk/loader.py

@@ -43,6 +43,8 @@ class ClientConfig:
         otel_service_name: str | None = None,
         otel_exporter_oltp_headers: dict[str, str] | None = None,
         otel_exporter_oltp_protocol: str | None = None,
+        worker_healthcheck_port: int | None = None,
+        worker_healthcheck_enabled: bool | None = None,
     ):
         self.tenant_id = tenant_id
         self.tls_config = tls_config
@@ -57,6 +59,8 @@ class ClientConfig:
         self.otel_service_name = otel_service_name
         self.otel_exporter_oltp_headers = otel_exporter_oltp_headers
         self.otel_exporter_oltp_protocol = otel_exporter_oltp_protocol
+        self.worker_healthcheck_port = worker_healthcheck_port
+        self.worker_healthcheck_enabled = worker_healthcheck_enabled
 
         if not self.logInterceptor:
             self.logInterceptor = getLogger()
@@ -163,6 +167,23 @@ class ConfigLoader:
             "otel_exporter_oltp_protocol", "HATCHET_CLIENT_OTEL_EXPORTER_OTLP_PROTOCOL"
         )
 
+        worker_healthcheck_port = int(
+            get_config_value(
+                "worker_healthcheck_port", "HATCHET_CLIENT_WORKER_HEALTHCHECK_PORT"
+            )
+            or 8001
+        )
+
+        worker_healthcheck_enabled = (
+            str(
+                get_config_value(
+                    "worker_healthcheck_port",
+                    "HATCHET_CLIENT_WORKER_HEALTHCHECK_ENABLED",
+                )
+            )
+            == "True"
+        )
+
         return ClientConfig(
             tenant_id=tenant_id,
             tls_config=tls_config,
@@ -178,6 +199,8 @@ class ConfigLoader:
             otel_service_name=otel_service_name,
             otel_exporter_oltp_headers=otel_exporter_oltp_headers,
             otel_exporter_oltp_protocol=otel_exporter_oltp_protocol,
+            worker_healthcheck_port=worker_healthcheck_port,
+            worker_healthcheck_enabled=worker_healthcheck_enabled,
         )
 
     def _load_tls_config(self, tls_data: Dict, host_port) -> ClientTLSConfig:

hatchet_sdk/worker/worker.py

@@ -12,7 +12,10 @@ from multiprocessing.process import BaseProcess
 from types import FrameType
 from typing import Any, Callable, TypeVar, get_type_hints
 
-from pydantic import BaseModel
+from aiohttp import web
+from aiohttp.web_request import Request
+from aiohttp.web_response import Response
+from prometheus_client import CONTENT_TYPE_LATEST, Gauge, generate_latest
 
 from hatchet_sdk import Context
 from hatchet_sdk.client import Client, new_client_raw
@@ -88,6 +91,10 @@ class Worker:
 
         self._setup_signal_handlers()
 
+        self.worker_status_gauge = Gauge(
+            "hatchet_worker_status", "Current status of the Hatchet worker"
+        )
+
     def register_function(self, action: str, func: Callable[[Context], Any]) -> None:
         self.action_registry[action] = func
 
@@ -155,6 +162,39 @@ class Worker:
             created_loop = True
             return created_loop
 
+    async def health_check_handler(self, request: Request) -> Response:
+        status = self.status()
+
+        return web.json_response({"status": status.name})
+
+    async def metrics_handler(self, request: Request) -> Response:
+        self.worker_status_gauge.set(1 if self.status() == WorkerStatus.HEALTHY else 0)
+
+        return web.Response(body=generate_latest(), content_type="text/plain")
+
+    async def start_health_server(self) -> None:
+        port = self.config.worker_healthcheck_port or 8001
+
+        app = web.Application()
+        app.add_routes(
+            [
+                web.get("/health", self.health_check_handler),
+                web.get("/metrics", self.metrics_handler),
+            ]
+        )
+
+        runner = web.AppRunner(app)
+
+        try:
+            await runner.setup()
+            await web.TCPSite(runner, "0.0.0.0", port).start()
+        except Exception as e:
+            logger.error("failed to start healthcheck server")
+            logger.error(str(e))
+            return
+
+        logger.info(f"healthcheck server running on port {port}")
+
     def start(
         self, options: WorkerStartOptions = WorkerStartOptions()
     ) -> Future[asyncio.Task[Any] | None]:
@@ -196,6 +236,9 @@ class Worker:
         if not _from_start:
             self.setup_loop(options.loop)
 
+        if self.config.worker_healthcheck_enabled:
+            await self.start_health_server()
+
         self.action_listener_process = self._start_listener()
 
         self.action_runner = self._run_action_runner()

{hatchet_sdk-0.42.5.dist-info → hatchet_sdk-0.43.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hatchet-sdk
-Version: 0.42.5
+Version: 0.43.1
 Summary: 
 Author: Alexander Belanger
 Author-email: alexander@hatchet.run
@@ -17,12 +17,13 @@ Requires-Dist: grpcio (>=1.68.1,<2.0.0)
 Requires-Dist: grpcio-tools (>=1.68.1,<2.0.0)
 Requires-Dist: loguru (>=0.7.2,<0.8.0)
 Requires-Dist: nest-asyncio (>=1.6.0,<2.0.0)
-Requires-Dist: opentelemetry-api (>=1.27.0,<2.0.0)
-Requires-Dist: opentelemetry-distro (>=0.48b0,<0.49)
-Requires-Dist: opentelemetry-exporter-otlp (>=1.27.0,<2.0.0)
-Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.27.0,<2.0.0)
-Requires-Dist: opentelemetry-instrumentation (>=0.48b0,<0.49)
-Requires-Dist: opentelemetry-sdk (>=1.27.0,<2.0.0)
+Requires-Dist: opentelemetry-api (>=1.28.0,<2.0.0)
+Requires-Dist: opentelemetry-distro (>=0.49b0)
+Requires-Dist: opentelemetry-exporter-otlp (>=1.28.0,<2.0.0)
+Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.28.0,<2.0.0)
+Requires-Dist: opentelemetry-instrumentation (>=0.49b0)
+Requires-Dist: opentelemetry-sdk (>=1.28.0,<2.0.0)
+Requires-Dist: prometheus-client (>=0.21.1,<0.22.0)
 Requires-Dist: protobuf (>=5.29.1,<6.0.0)
 Requires-Dist: pydantic (>=2.6.3,<3.0.0)
 Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)

{hatchet_sdk-0.42.5.dist-info → hatchet_sdk-0.43.1.dist-info}/RECORD

@@ -203,11 +203,12 @@ hatchet_sdk/contracts/workflows_pb2.pyi,sha256=2r5d4DWaR0kwY8jKSzcffTAMMlWrusRXC
 hatchet_sdk/contracts/workflows_pb2_grpc.py,sha256=AFu0wRpfyCyNVIYZLKian6s5qPnVDCwtuE91JMaMmUI,10522
 hatchet_sdk/features/cron.py,sha256=4lKMH0MqiN8cHJk2jhF0Ueqs6z5ozwJzlOeSeaWqvO0,10217
 hatchet_sdk/features/scheduled.py,sha256=YhEbNWl8dWOH61rXVjAyu8iG1BZqpSkD4kgaxkKIHgY,9504
-hatchet_sdk/hatchet.py,sha256=UpCDv3q-Mrbwi7tFHS2FonBwwXlbs5kRFfCfx4DJVeI,10027
+hatchet_sdk/hatchet.py,sha256=L6O9cTeZtGqFUxO5H8knXKdiej0iAequ1Wl7vSNO9FY,10027
 hatchet_sdk/labels.py,sha256=Axfp1yUNowzE9mL8AQA1ADqwOaNmq3QP_45wb1Ed1aI,272
-hatchet_sdk/loader.py,sha256=dGs6Tt8wdEgHeCBesbbQsP6ZYiARBvoqwIdXIO1P5Os,7913
+hatchet_sdk/loader.py,sha256=ddwQ7BAWYsJ9LEsNxajCkv78hRLUMftVG0vdg5V09iQ,8746
 hatchet_sdk/logger.py,sha256=5uOr52T4mImSQm1QvWT8HvZFK5WfPNh3Y1cBQZRFgUQ,333
 hatchet_sdk/metadata.py,sha256=M_Cb-CXRKitzVMQHeaHUtbY28ET__fAbyGX1YKaeN4I,80
+hatchet_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hatchet_sdk/rate_limit.py,sha256=IIzpe65i-518t9kQcZVEykDQ2VY8sOw2F7qlQ4wlAjw,4421
 hatchet_sdk/semver.py,sha256=PrgBL0TnyXl3p_OK1iSMk9Gpujfh5asQpJ4DHJLCW2k,998
 hatchet_sdk/token.py,sha256=Ap3jnbaPAL10F2G_D71wj7OpBcvrI3RuE0keqXx1lAE,698
@@ -226,10 +227,10 @@ hatchet_sdk/worker/runner/run_loop_manager.py,sha256=nV7fhNxJKCcrBm0ci118aszF_7A
 hatchet_sdk/worker/runner/runner.py,sha256=uNHPViiQvtwvX4uJ9TqcbFPonJnhhoEM3WNOWEKyop0,18517
 hatchet_sdk/worker/runner/utils/capture_logs.py,sha256=s_BGxeykelVbusx6u31EPx3vv9c2BHkuBnYcaLW680E,2381
 hatchet_sdk/worker/runner/utils/error_with_traceback.py,sha256=Iih_s8JNqrinXETFJ3ZS88EhaTekfM6m5fqIP7QWoIM,181
-hatchet_sdk/worker/worker.py,sha256=R4UEf_1e7qe1LrXS8-0fjfriwcSb3W_38RUR6pOxBCo,11547
+hatchet_sdk/worker/worker.py,sha256=7UPm3qTzNYSSm9QTNX6zBBMJqVA6nKFeCbAdqLLjUBs,13007
 hatchet_sdk/workflow.py,sha256=XRj5jcCQSvPQMXxBipf-ZlARua2E8Z9igRzGcQ5alkI,9375
 hatchet_sdk/workflow_run.py,sha256=BwK5cefvXXvyQ1Ednj_7LeejMwQJqWnvUC_FTBmJNxk,1805
-hatchet_sdk-0.42.5.dist-info/METADATA,sha256=BztALlvM5Evu2RNQwVaMfnWJR6WqsKwgxCE3HCb4oZg,1514
-hatchet_sdk-0.42.5.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-hatchet_sdk-0.42.5.dist-info/entry_points.txt,sha256=LTtQRABmSGYOxRI68cUVEz5dp9Qb57eqXGic9lU8RMo,1023
-hatchet_sdk-0.42.5.dist-info/RECORD,,
+hatchet_sdk-0.43.1.dist-info/METADATA,sha256=E9nxiPbh3-x6S1TPXCVhPmgAm3sqolSmtIW8xPQ2wws,1554
+hatchet_sdk-0.43.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+hatchet_sdk-0.43.1.dist-info/entry_points.txt,sha256=LTtQRABmSGYOxRI68cUVEz5dp9Qb57eqXGic9lU8RMo,1023
+hatchet_sdk-0.43.1.dist-info/RECORD,,