hatchet-sdk 1.10.0__tar.gz → 1.10.1__tar.gz

{hatchet_sdk-1.10.0 → hatchet_sdk-1.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hatchet-sdk
-Version: 1.10.0
+Version: 1.10.1
 Summary: 
 License: MIT
 Author: Alexander Belanger

{hatchet_sdk-1.10.0 → hatchet_sdk-1.10.1}/hatchet_sdk/__init__.py

@@ -130,7 +130,7 @@ from hatchet_sdk.clients.rest.models.workflow_version_definition import (
     WorkflowVersionDefinition,
 )
 from hatchet_sdk.clients.rest.models.workflow_version_meta import WorkflowVersionMeta
-from hatchet_sdk.config import ClientConfig
+from hatchet_sdk.config import ClientConfig, ClientTLSConfig, OpenTelemetryConfig
 from hatchet_sdk.context.context import Context, DurableContext
 from hatchet_sdk.context.worker_context import WorkerContext
 from hatchet_sdk.contracts.workflows_pb2 import (
@@ -149,6 +149,7 @@ from hatchet_sdk.runnables.types import (
     TaskDefaults,
     WorkflowConfig,
 )
+from hatchet_sdk.utils.opentelemetry import OTelAttribute
 from hatchet_sdk.waits import (
     Condition,
     OrGroup,
@@ -271,4 +272,7 @@ __all__ = [
     "BulkCancelReplayOpts",
     "RunFilter",
     "V1TaskStatus",
+    "OTelAttribute",
+    "OpenTelemetryConfig",
+    "ClientTLSConfig",
 ]

{hatchet_sdk-1.10.0 → hatchet_sdk-1.10.1}/hatchet_sdk/clients/dispatcher/action_listener.py

@@ -3,7 +3,7 @@ import json
 import time
 from dataclasses import field
 from enum import Enum
-from typing import Any, AsyncGenerator, cast
+from typing import TYPE_CHECKING, Any, AsyncGenerator, cast
 
 import grpc
 import grpc.aio
@@ -18,7 +18,6 @@ from hatchet_sdk.clients.events import proto_timestamp_now
 from hatchet_sdk.clients.listeners.run_event_listener import (
     DEFAULT_ACTION_LISTENER_RETRY_INTERVAL,
 )
-from hatchet_sdk.config import ClientConfig
 from hatchet_sdk.connection import new_conn
 from hatchet_sdk.contracts.dispatcher_pb2 import ActionType as ActionTypeProto
 from hatchet_sdk.contracts.dispatcher_pb2 import (
@@ -32,9 +31,14 @@ from hatchet_sdk.contracts.dispatcher_pb2_grpc import DispatcherStub
 from hatchet_sdk.logger import logger
 from hatchet_sdk.metadata import get_metadata
 from hatchet_sdk.utils.backoff import exp_backoff_sleep
+from hatchet_sdk.utils.opentelemetry import OTelAttribute
 from hatchet_sdk.utils.proto_enums import convert_proto_enum_to_python
 from hatchet_sdk.utils.typing import JSONSerializableMapping
 
+if TYPE_CHECKING:
+    from hatchet_sdk.config import ClientConfig
+
+
 DEFAULT_ACTION_TIMEOUT = 600  # seconds
 DEFAULT_ACTION_LISTENER_RETRY_COUNT = 15
 
@@ -134,32 +138,35 @@ class Action(BaseModel):
         except Exception:
             return str(self.action_payload)
 
-    @property
-    def otel_attributes(self) -> dict[str, str | int]:
+    def get_otel_attributes(self, config: "ClientConfig") -> dict[str, str | int]:
         try:
             payload_str = json.dumps(self.action_payload.model_dump(), default=str)
         except Exception:
             payload_str = str(self.action_payload)
 
-        attrs: dict[str, str | int | None] = {
-            "hatchet.tenant_id": self.tenant_id,
-            "hatchet.worker_id": self.worker_id,
-            "hatchet.workflow_run_id": self.workflow_run_id,
-            "hatchet.step_id": self.step_id,
-            "hatchet.step_run_id": self.step_run_id,
-            "hatchet.retry_count": self.retry_count,
-            "hatchet.parent_workflow_run_id": self.parent_workflow_run_id,
-            "hatchet.child_workflow_index": self.child_workflow_index,
-            "hatchet.child_workflow_key": self.child_workflow_key,
-            "hatchet.action_payload": payload_str,
-            "hatchet.workflow_name": self.job_name,
-            "hatchet.action_name": self.action_id,
-            "hatchet.get_group_key_run_id": self.get_group_key_run_id,
-            "hatchet.workflow_id": self.workflow_id,
-            "hatchet.workflow_version_id": self.workflow_version_id,
+        attrs: dict[OTelAttribute, str | int | None] = {
+            OTelAttribute.TENANT_ID: self.tenant_id,
+            OTelAttribute.WORKER_ID: self.worker_id,
+            OTelAttribute.WORKFLOW_RUN_ID: self.workflow_run_id,
+            OTelAttribute.STEP_ID: self.step_id,
+            OTelAttribute.STEP_RUN_ID: self.step_run_id,
+            OTelAttribute.RETRY_COUNT: self.retry_count,
+            OTelAttribute.PARENT_WORKFLOW_RUN_ID: self.parent_workflow_run_id,
+            OTelAttribute.CHILD_WORKFLOW_INDEX: self.child_workflow_index,
+            OTelAttribute.CHILD_WORKFLOW_KEY: self.child_workflow_key,
+            OTelAttribute.ACTION_PAYLOAD: payload_str,
+            OTelAttribute.WORKFLOW_NAME: self.job_name,
+            OTelAttribute.ACTION_NAME: self.action_id,
+            OTelAttribute.GET_GROUP_KEY_RUN_ID: self.get_group_key_run_id,
+            OTelAttribute.WORKFLOW_ID: self.workflow_id,
+            OTelAttribute.WORKFLOW_VERSION_ID: self.workflow_version_id,
         }
 
-        return {k: v for k, v in attrs.items() if v}
+        return {
+            f"hatchet.{k.value}": v
+            for k, v in attrs.items()
+            if v and k not in config.otel.excluded_attributes
+        }
 
     @property
     def key(self) -> ActionKey:
@@ -185,7 +192,7 @@ def parse_additional_metadata(additional_metadata: str) -> JSONSerializableMappi
 
 
 class ActionListener:
-    def __init__(self, config: ClientConfig, worker_id: str) -> None:
+    def __init__(self, config: "ClientConfig", worker_id: str) -> None:
         self.config = config
         self.worker_id = worker_id
 

{hatchet_sdk-1.10.0 → hatchet_sdk-1.10.1}/hatchet_sdk/config.py

@@ -6,6 +6,7 @@ from pydantic import Field, field_validator, model_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 from hatchet_sdk.token import get_addresses_from_jwt, get_tenant_id_from_jwt
+from hatchet_sdk.utils.opentelemetry import OTelAttribute
 
 
 def create_settings_config(env_prefix: str) -> SettingsConfigDict:
@@ -37,6 +38,17 @@ class HealthcheckConfig(BaseSettings):
     enabled: bool = False
 
 
+class OpenTelemetryConfig(BaseSettings):
+    model_config = create_settings_config(
+        env_prefix="HATCHET_CLIENT_OPENTELEMETRY_",
+    )
+
+    excluded_attributes: list[OTelAttribute] = Field(
+        default_factory=list,
+        description='Note that if specifying this field via an environment variable, the variable must be a valid JSON array. For example: \'["action_name", "action_payload"]\'',
+    )
+
+
 DEFAULT_HOST_PORT = "localhost:7070"
 
 
@@ -55,6 +67,7 @@ class ClientConfig(BaseSettings):
 
     tls_config: ClientTLSConfig = Field(default_factory=lambda: ClientTLSConfig())
     healthcheck: HealthcheckConfig = Field(default_factory=lambda: HealthcheckConfig())
+    otel: OpenTelemetryConfig = Field(default_factory=lambda: OpenTelemetryConfig())
 
     listener_v2_timeout: int | None = None
     grpc_max_recv_message_length: int = Field(

{hatchet_sdk-1.10.0 → hatchet_sdk-1.10.1}/hatchet_sdk/opentelemetry/instrumentor.py

@@ -27,6 +27,7 @@ except (RuntimeError, ImportError, ModuleNotFoundError):
     )
 
 import hatchet_sdk
+from hatchet_sdk import ClientConfig
 from hatchet_sdk.clients.admin import (
     AdminClient,
     TriggerWorkflowOptions,
@@ -148,13 +149,17 @@ class HatchetInstrumentor(BaseInstrumentor):  # type: ignore[misc]
             If not provided, the global tracer provider will be used.
     :param meter_provider: MeterProvider | None: The OpenTelemetry MeterProvider to use.
             If not provided, a no-op meter provider will be used.
+    :param config: ClientConfig | None: The configuration for the Hatchet client. If not provided,
+            a default configuration will be used.
     """
 
     def __init__(
         self,
         tracer_provider: TracerProvider | None = None,
         meter_provider: MeterProvider | None = None,
+        config: ClientConfig | None = None,
     ):
+        self.config = config or ClientConfig()
 
         self.tracer_provider = tracer_provider or get_tracer_provider()
         self.meter_provider = meter_provider or NoOpMeterProvider()
@@ -233,7 +238,7 @@ class HatchetInstrumentor(BaseInstrumentor):  # type: ignore[misc]
 
         with self._tracer.start_as_current_span(
             "hatchet.start_step_run",
-            attributes=action.otel_attributes,
+            attributes=action.get_otel_attributes(self.config),
             context=traceparent,
         ) as span:
             result = await wrapped(*args, **kwargs)
@@ -255,7 +260,7 @@ class HatchetInstrumentor(BaseInstrumentor):  # type: ignore[misc]
 
         with self._tracer.start_as_current_span(
             "hatchet.get_group_key_run",
-            attributes=action.otel_attributes,
+            attributes=action.get_otel_attributes(self.config),
         ) as span:
             result = await wrapped(*args, **kwargs)
 

hatchet_sdk-1.10.1/hatchet_sdk/utils/opentelemetry.py

@@ -0,0 +1,19 @@
+from enum import Enum
+
+
+class OTelAttribute(str, Enum):
+    ACTION_NAME = "action_name"
+    ACTION_PAYLOAD = "action_payload"
+    CHILD_WORKFLOW_INDEX = "child_workflow_index"
+    CHILD_WORKFLOW_KEY = "child_workflow_key"
+    GET_GROUP_KEY_RUN_ID = "get_group_key_run_id"
+    PARENT_WORKFLOW_RUN_ID = "parent_workflow_run_id"
+    RETRY_COUNT = "retry_count"
+    STEP_ID = "step_id"
+    STEP_RUN_ID = "step_run_id"
+    TENANT_ID = "tenant_id"
+    WORKER_ID = "worker_id"
+    WORKFLOW_ID = "workflow_id"
+    WORKFLOW_NAME = "workflow_name"
+    WORKFLOW_RUN_ID = "workflow_run_id"
+    WORKFLOW_VERSION_ID = "workflow_version_id"

{hatchet_sdk-1.10.0 → hatchet_sdk-1.10.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hatchet-sdk"
-version = "1.10.0"
+version = "1.10.1"
 description = ""
 authors = ["Alexander Belanger <alexander@hatchet.run>"]
 readme = "README.md"