Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

2.5 KB
Raw Blame
"""Telemetry gateway contracts and data structures.

This module defines the envelope format for telemetry events and the routing
configuration that determines how each event type is processed.
"""

from __future__ import annotations

from enum import StrEnum
from typing import Any

from pydantic import BaseModel, ConfigDict


class TelemetryCase(StrEnum):
    """Enumeration of all known telemetry event cases."""

    WORKFLOW_RUN = "workflow_run"
    NODE_EXECUTION = "node_execution"
    DRAFT_NODE_EXECUTION = "draft_node_execution"
    MESSAGE_RUN = "message_run"
    TOOL_EXECUTION = "tool_execution"
    MODERATION_CHECK = "moderation_check"
    SUGGESTED_QUESTION = "suggested_question"
    DATASET_RETRIEVAL = "dataset_retrieval"
    GENERATE_NAME = "generate_name"
    PROMPT_GENERATION = "prompt_generation"
    APP_CREATED = "app_created"
    APP_UPDATED = "app_updated"
    APP_DELETED = "app_deleted"
    FEEDBACK_CREATED = "feedback_created"


class SignalType(StrEnum):
    """Signal routing type for telemetry cases.

    TRACE:
        The trace task builds a typed ``TraceInfo``, then dispatches it
        to both third-party trace providers (Langfuse, LangSmith, …) and
        ``EnterpriseOtelTrace``.

    METRIC_LOG:
        Used for lightweight signal-driven
        counters (app created/deleted, feedback) that don't need the
        full ``TraceInfo`` data model.
    """

    TRACE = "trace"
    METRIC_LOG = "metric_log"


class CaseRoute(BaseModel):
    """Routing configuration for a telemetry case.

    Attributes:
        signal_type: The type of signal (trace or metric_log).
        ce_eligible: Whether this case is eligible for community edition tracing.
    """

    signal_type: SignalType
    ce_eligible: bool


class TelemetryEnvelope(BaseModel):
    """Envelope for telemetry events.

    Attributes:
        case: The telemetry case type.
        tenant_id: The tenant identifier.
        event_id: Unique event identifier for deduplication.
        payload: The main event payload (inline for small payloads,
            empty when offloaded to storage via ``payload_ref``).
        metadata: Optional metadata dictionary.  When the gateway
            offloads a large payload to object storage, this contains
            ``{"payload_ref": "<storage_key>"}``.
    """

    model_config = ConfigDict(extra="forbid", use_enum_values=False)

    case: TelemetryCase
    tenant_id: str
    event_id: str
    payload: dict[str, Any]
    metadata: dict[str, Any] | None = None