digitalkin 0.3.2.dev7__tar.gz → 0.3.2.dev10__tar.gz

{digitalkin-0.3.2.dev7 → digitalkin-0.3.2.dev10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalkin
-Version: 0.3.2.dev7
+Version: 0.3.2.dev10
 Summary: SDK to build kin used in DigitalKin
 Author-email: "DigitalKin.ai" <contact@digitalkin.ai>
 License: Attribution-NonCommercial-ShareAlike 4.0 International

digitalkin-0.3.2.dev10/examples/modules/archetype_with_tools_module.py

@@ -0,0 +1,244 @@
+"""Example archetype module with tool cache integration."""
+
+import logging
+from typing import Any, ClassVar, Literal
+
+from pydantic import BaseModel, Field
+
+from digitalkin.models.grpc_servers.models import ClientConfig, SecurityMode, ServerMode
+from digitalkin.models.module.module_context import ModuleContext
+from digitalkin.models.module.setup_types import SetupModel
+from digitalkin.models.module.tool_reference import (
+    ToolReference,
+    ToolReferenceConfig,
+    ToolSelectionMode,
+)
+from digitalkin.modules._base_module import BaseModule  # noqa: PLC2701
+from digitalkin.services.services_models import ServicesStrategy
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+)
+logger = logging.getLogger(__name__)
+
+
+class MessageInputPayload(BaseModel):
+    """Message input payload."""
+
+    payload_type: Literal["message"] = "message"
+    user_prompt: str
+
+
+class ArchetypeInput(BaseModel):
+    """Archetype input."""
+
+    payload: MessageInputPayload = Field(discriminator="payload_type")
+
+
+class MessageOutputPayload(BaseModel):
+    """Message output payload."""
+
+    payload_type: Literal["message"] = "message"
+    response: str
+    tools_used: list[str] = Field(default_factory=list)
+
+
+class ArchetypeOutput(BaseModel):
+    """Archetype output."""
+
+    payload: MessageOutputPayload = Field(discriminator="payload_type")
+
+
+class ArchetypeSetup(SetupModel):
+    """Setup with tool references resolved during config setup."""
+
+    model_name: str = Field(
+        default="gpt-4",
+        json_schema_extra={"config": True},
+    )
+    temperature: float = Field(
+        default=0.7,
+        json_schema_extra={"config": True},
+    )
+
+    search_tool: ToolReference = Field(
+        default_factory=lambda: ToolReference(
+            config=ToolReferenceConfig(
+                mode=ToolSelectionMode.FIXED,
+                module_id="search-tool-v1",
+            )
+        ),
+        json_schema_extra={"config": True},
+    )
+
+    calculator_tool: ToolReference = Field(
+        default_factory=lambda: ToolReference(
+            config=ToolReferenceConfig(
+                mode=ToolSelectionMode.TAG,
+                tag="math-calculator",
+            )
+        ),
+        json_schema_extra={"config": True},
+    )
+
+    dynamic_tool: ToolReference = Field(
+        default_factory=lambda: ToolReference(
+            config=ToolReferenceConfig(
+                mode=ToolSelectionMode.DISCOVERABLE,
+            )
+        ),
+        json_schema_extra={"config": True},
+    )
+
+    system_prompt: str = Field(
+        default="You are a helpful assistant with access to tools.",
+        json_schema_extra={"hidden": True},
+    )
+
+
+class ArchetypeConfigSetup(BaseModel):
+    """Config setup model."""
+
+    additional_instructions: str | None = None
+
+
+class ArchetypeSecret(BaseModel):
+    """Secrets model."""
+
+
+client_config = ClientConfig(
+    host="[::]",
+    port=50152,
+    mode=ServerMode.ASYNC,
+    security=SecurityMode.INSECURE,
+    credentials=None,
+)
+
+
+class ArchetypeWithToolsModule(
+    BaseModule[
+        ArchetypeInput,
+        ArchetypeOutput,
+        ArchetypeSetup,
+        ArchetypeSecret,
+    ]
+):
+    """Archetype module demonstrating tool cache usage."""
+
+    name = "ArchetypeWithToolsModule"
+    description = "Archetype with tool cache integration"
+
+    config_setup_format = ArchetypeConfigSetup
+    input_format = ArchetypeInput
+    output_format = ArchetypeOutput
+    setup_format = ArchetypeSetup
+    secret_format = ArchetypeSecret
+
+    metadata: ClassVar[dict[str, Any]] = {
+        "name": "ArchetypeWithToolsModule",
+        "version": "1.0.0",
+        "tags": ["archetype", "tools"],
+    }
+
+    services_config_strategies: ClassVar[dict[str, ServicesStrategy | None]] = {}
+    services_config_params: ClassVar[dict[str, dict[str, Any | None] | None]] = {
+        "registry": {
+            "config": {},
+            "client_config": client_config,
+        },
+    }
+
+    async def run_config_setup(
+        self,
+        context: ModuleContext,  # noqa: ARG002
+        config_setup_data: ArchetypeSetup,
+    ) -> ArchetypeSetup:
+        """Custom config setup logic, runs in parallel with tool resolution.
+
+        Args:
+            context: Module context with services.
+            config_setup_data: Setup data being configured.
+
+        Returns:
+            Configured setup data.
+        """
+        logger.info("Running config setup for %s", self.name)
+        return config_setup_data
+
+    async def initialize(self, context: ModuleContext, setup_data: ArchetypeSetup) -> None:  # noqa: ARG002
+        """Initialize module.
+
+        Args:
+            context: Module context with services and tool cache.
+            setup_data: Setup data for the module.
+        """
+        logger.info("Initializing %s", self.name)
+        if context.tool_cache:
+            logger.info("Available tools: %s", context.tool_cache.list_tools())
+
+    async def run(
+        self,
+        input_data: ArchetypeInput,
+        setup_data: ArchetypeSetup,  # noqa: ARG002
+    ) -> None:
+        """Run module with tool cache lookups and call_module_by_id.
+
+        Args:
+            input_data: Input data to process.
+            setup_data: Setup configuration.
+        """
+        logger.info("Running %s", self.name)
+
+        tools_used: list[str] = []
+        tool_results: list[str] = []
+
+        # Get search tool from cache and call via call_module_by_id
+        search_info = self.context.tool_cache.get("search_tool")
+        if search_info:
+            tools_used.append(f"search:{search_info.module_id}")
+            async for response in self.context.call_module_by_id(
+                module_id=search_info.module_id,
+                input_data={"query": input_data.payload.user_prompt},
+                setup_id=self.context.session.setup_id,
+                mission_id=self.context.session.mission_id,
+            ):
+                tool_results.append(f"search_result: {response}")
+
+        # Get calculator tool from cache
+        calc_info = self.context.tool_cache.get("calculator_tool")
+        if calc_info:
+            tools_used.append(f"calculator:{calc_info.module_id}")
+            async for response in self.context.call_module_by_id(
+                module_id=calc_info.module_id,
+                input_data={"expression": "2 + 2"},
+                setup_id=self.context.session.setup_id,
+                mission_id=self.context.session.mission_id,
+            ):
+                tool_results.append(f"calc_result: {response}")
+
+        # Dynamic discovery via registry fallback for tools not in cache
+        dynamic_info = self.context.tool_cache.get(
+            "some_dynamic_tool",
+            registry=self.context.registry,
+        )
+        if dynamic_info:
+            tools_used.append(f"dynamic:{dynamic_info.module_id}")
+            async for response in self.context.call_module_by_id(
+                module_id=dynamic_info.module_id,
+                input_data={"prompt": input_data.payload.user_prompt},
+                setup_id=self.context.session.setup_id,
+                mission_id=self.context.session.mission_id,
+            ):
+                tool_results.append(f"dynamic_result: {response}")
+
+        response = MessageOutputPayload(
+            response=f"Processed: {input_data.payload.user_prompt} | Results: {len(tool_results)}",
+            tools_used=tools_used,
+        )
+
+        await self.context.callbacks.send_message(ArchetypeOutput(payload=response))
+
+    async def cleanup(self) -> None:
+        """Clean up resources."""
+        logger.info("Cleaning up %s", self.name)

digitalkin-0.3.2.dev10/examples/monitoring/digitalkin_observability/__init__.py

@@ -0,0 +1,46 @@
+"""Standalone observability module for DigitalKin.
+
+This module can be copied into your project and used independently.
+It has no dependencies on the digitalkin package.
+
+Usage:
+    from digitalkin_observability import (
+        MetricsCollector,
+        MetricsServer,
+        MetricsServerInterceptor,
+        PrometheusExporter,
+        get_metrics,
+        start_metrics_server,
+        stop_metrics_server,
+    )
+
+    # Start metrics HTTP server
+    start_metrics_server(port=8081)
+
+    # Track metrics
+    metrics = get_metrics()
+    metrics.inc_jobs_started("my_module")
+    metrics.inc_jobs_completed("my_module", duration=1.5)
+
+    # Export to Prometheus format
+    print(PrometheusExporter.export())
+"""
+
+from digitalkin_observability.http_server import (
+    MetricsServer,
+    start_metrics_server,
+    stop_metrics_server,
+)
+from digitalkin_observability.interceptors import MetricsServerInterceptor
+from digitalkin_observability.metrics import MetricsCollector, get_metrics
+from digitalkin_observability.prometheus import PrometheusExporter
+
+__all__ = [
+    "MetricsCollector",
+    "MetricsServer",
+    "MetricsServerInterceptor",
+    "PrometheusExporter",
+    "get_metrics",
+    "start_metrics_server",
+    "stop_metrics_server",
+]

digitalkin-0.3.2.dev10/examples/monitoring/digitalkin_observability/http_server.py

@@ -0,0 +1,150 @@
+"""Simple HTTP server for exposing Prometheus metrics.
+
+This module provides an HTTP server that exposes metrics at /metrics endpoint.
+No external dependencies required beyond Python standard library.
+"""
+
+from __future__ import annotations
+
+import logging
+from http.server import BaseHTTPRequestHandler, HTTPServer
+from threading import Thread
+from typing import TYPE_CHECKING, ClassVar
+
+if TYPE_CHECKING:
+    from typing import Self
+
+logger = logging.getLogger(__name__)
+
+
+class MetricsHandler(BaseHTTPRequestHandler):
+    """HTTP request handler for metrics endpoint."""
+
+    def do_GET(self) -> None:
+        """Handle GET requests."""
+        if self.path == "/metrics":
+            self._serve_metrics()
+        elif self.path == "/health":
+            self._serve_health()
+        else:
+            self.send_error(404, "Not Found")
+
+    def _serve_metrics(self) -> None:
+        """Serve Prometheus metrics."""
+        from digitalkin_observability.prometheus import PrometheusExporter
+
+        content = PrometheusExporter.export()
+        self.send_response(200)
+        self.send_header("Content-Type", "text/plain; charset=utf-8")
+        self.send_header("Content-Length", str(len(content)))
+        self.end_headers()
+        self.wfile.write(content.encode("utf-8"))
+
+    def _serve_health(self) -> None:
+        """Serve health check."""
+        content = '{"status": "ok"}'
+        self.send_response(200)
+        self.send_header("Content-Type", "application/json")
+        self.send_header("Content-Length", str(len(content)))
+        self.end_headers()
+        self.wfile.write(content.encode("utf-8"))
+
+    def log_message(self, format: str, *args: object) -> None:
+        """Suppress default logging."""
+
+
+class MetricsServer:
+    """HTTP server for exposing metrics to Prometheus.
+
+    Usage:
+        server = MetricsServer(port=8081)
+        server.start()
+        # ... run your application ...
+        server.stop()
+
+    Or as context manager:
+        with MetricsServer(port=8081):
+            # ... run your application ...
+
+    Or as async context manager:
+        async with MetricsServer(port=8081):
+            # ... run your application ...
+    """
+
+    instance: ClassVar["MetricsServer | None"] = None
+
+    def __init__(self, host: str = "0.0.0.0", port: int = 8081) -> None:
+        """Initialize the metrics server.
+
+        Args:
+            host: Host to bind to (default: 0.0.0.0 for all interfaces).
+            port: Port to listen on (default: 8081).
+        """
+        self.host = host
+        self.port = port
+        self._server: HTTPServer | None = None
+        self._thread: Thread | None = None
+
+    def start(self) -> None:
+        """Start the metrics server in a background thread."""
+        if self._server is not None:
+            logger.warning("Metrics server already running")
+            return
+
+        self._server = HTTPServer((self.host, self.port), MetricsHandler)
+        self._thread = Thread(target=self._server.serve_forever, daemon=True)
+        self._thread.start()
+        logger.info(
+            "Metrics server started on http://%s:%s/metrics",
+            self.host,
+            self.port,
+        )
+
+    def stop(self) -> None:
+        """Stop the metrics server."""
+        if self._server is not None:
+            self._server.shutdown()
+            self._server = None
+            self._thread = None
+            logger.info("Metrics server stopped")
+
+    async def __aenter__(self) -> "Self":
+        """Async context manager entry."""
+        self.start()
+        return self
+
+    async def __aexit__(self, *args: object) -> None:
+        """Async context manager exit."""
+        self.stop()
+
+    def __enter__(self) -> "Self":
+        """Context manager entry."""
+        self.start()
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        """Context manager exit."""
+        self.stop()
+
+
+def start_metrics_server(host: str = "0.0.0.0", port: int = 8081) -> MetricsServer:
+    """Start a metrics server singleton.
+
+    Args:
+        host: Host to bind to.
+        port: Port to listen on.
+
+    Returns:
+        The MetricsServer instance.
+    """
+    if MetricsServer.instance is None:
+        MetricsServer.instance = MetricsServer(host, port)
+        MetricsServer.instance.start()
+    return MetricsServer.instance
+
+
+def stop_metrics_server() -> None:
+    """Stop the metrics server singleton."""
+    if MetricsServer.instance is not None:
+        MetricsServer.instance.stop()
+        MetricsServer.instance = None

digitalkin-0.3.2.dev10/examples/monitoring/digitalkin_observability/interceptors.py

@@ -0,0 +1,176 @@
+"""gRPC interceptors for automatic metrics collection.
+
+This module provides gRPC server interceptors that automatically track
+request duration and errors. Requires grpcio package.
+"""
+
+from __future__ import annotations
+
+import time
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Awaitable, Callable
+    from typing import Any
+
+    import grpc
+
+from digitalkin_observability.metrics import get_metrics
+
+
+class MetricsServerInterceptor:
+    """Intercepts all gRPC calls to collect metrics.
+
+    This interceptor automatically tracks:
+    - Request duration (histogram)
+    - Error counts
+
+    Usage:
+        import grpc
+        from digitalkin_observability import MetricsServerInterceptor
+
+        interceptors = [MetricsServerInterceptor()]
+        server = grpc.aio.server(interceptors=interceptors)
+    """
+
+    async def intercept_service(
+        self,
+        continuation: Callable[["grpc.HandlerCallDetails"], Awaitable["grpc.RpcMethodHandler"]],
+        handler_call_details: "grpc.HandlerCallDetails",
+    ) -> "grpc.RpcMethodHandler":
+        """Intercept a gRPC service call to collect metrics.
+
+        Args:
+            continuation: The next interceptor or the actual handler.
+            handler_call_details: Details about the call being intercepted.
+
+        Returns:
+            The RPC method handler.
+        """
+        start = time.perf_counter()
+        metrics = get_metrics()
+
+        try:
+            handler = await continuation(handler_call_details)
+            return _MetricsWrappedHandler(handler, start, handler_call_details.method)
+        except Exception:
+            metrics.inc_errors()
+            metrics.observe_grpc_duration(time.perf_counter() - start)
+            raise
+
+
+class _MetricsWrappedHandler:
+    """Wrapper that measures actual handler execution time."""
+
+    def __init__(
+        self,
+        handler: "grpc.RpcMethodHandler",
+        start_time: float,
+        method: str,
+    ) -> None:
+        self._handler = handler
+        self._start_time = start_time
+        self._method = method
+
+        # Copy attributes from original handler
+        self.request_streaming = handler.request_streaming
+        self.response_streaming = handler.response_streaming
+        self.request_deserializer = handler.request_deserializer
+        self.response_serializer = handler.response_serializer
+
+        # Wrap the appropriate method based on streaming type
+        if handler.unary_unary:
+            self.unary_unary = self._wrap_unary_unary(handler.unary_unary)
+            self.unary_stream = None
+            self.stream_unary = None
+            self.stream_stream = None
+        elif handler.unary_stream:
+            self.unary_unary = None
+            self.unary_stream = self._wrap_unary_stream(handler.unary_stream)
+            self.stream_unary = None
+            self.stream_stream = None
+        elif handler.stream_unary:
+            self.unary_unary = None
+            self.unary_stream = None
+            self.stream_unary = self._wrap_stream_unary(handler.stream_unary)
+            self.stream_stream = None
+        elif handler.stream_stream:
+            self.unary_unary = None
+            self.unary_stream = None
+            self.stream_unary = None
+            self.stream_stream = self._wrap_stream_stream(handler.stream_stream)
+        else:
+            self.unary_unary = None
+            self.unary_stream = None
+            self.stream_unary = None
+            self.stream_stream = None
+
+    def _wrap_unary_unary(
+        self,
+        handler: Callable[["Any", "grpc.aio.ServicerContext"], Awaitable["Any"]],
+    ) -> Callable[["Any", "grpc.aio.ServicerContext"], Awaitable["Any"]]:
+        """Wrap a unary-unary handler."""
+        async def wrapped(request: "Any", context: "grpc.aio.ServicerContext") -> "Any":
+            metrics = get_metrics()
+            try:
+                return await handler(request, context)
+            except Exception:
+                metrics.inc_errors()
+                raise
+            finally:
+                metrics.observe_grpc_duration(time.perf_counter() - self._start_time)
+
+        return wrapped
+
+    def _wrap_unary_stream(
+        self,
+        handler: Callable[["Any", "grpc.aio.ServicerContext"], "Any"],
+    ) -> Callable[["Any", "grpc.aio.ServicerContext"], "Any"]:
+        """Wrap a unary-stream handler."""
+        async def wrapped(request: "Any", context: "grpc.aio.ServicerContext") -> "Any":
+            metrics = get_metrics()
+            try:
+                async for response in handler(request, context):
+                    yield response
+            except Exception:
+                metrics.inc_errors()
+                raise
+            finally:
+                metrics.observe_grpc_duration(time.perf_counter() - self._start_time)
+
+        return wrapped
+
+    def _wrap_stream_unary(
+        self,
+        handler: Callable[["Any", "grpc.aio.ServicerContext"], Awaitable["Any"]],
+    ) -> Callable[["Any", "grpc.aio.ServicerContext"], Awaitable["Any"]]:
+        """Wrap a stream-unary handler."""
+        async def wrapped(request_iterator: "Any", context: "grpc.aio.ServicerContext") -> "Any":
+            metrics = get_metrics()
+            try:
+                return await handler(request_iterator, context)
+            except Exception:
+                metrics.inc_errors()
+                raise
+            finally:
+                metrics.observe_grpc_duration(time.perf_counter() - self._start_time)
+
+        return wrapped
+
+    def _wrap_stream_stream(
+        self,
+        handler: Callable[["Any", "grpc.aio.ServicerContext"], "Any"],
+    ) -> Callable[["Any", "grpc.aio.ServicerContext"], "Any"]:
+        """Wrap a stream-stream handler."""
+        async def wrapped(request_iterator: "Any", context: "grpc.aio.ServicerContext") -> "Any":
+            metrics = get_metrics()
+            try:
+                async for response in handler(request_iterator, context):
+                    yield response
+            except Exception:
+                metrics.inc_errors()
+                raise
+            finally:
+                metrics.observe_grpc_duration(time.perf_counter() - self._start_time)
+
+        return wrapped