provide-foundation 0.0.0.dev0__py3-none-any.whl → 0.0.0.dev1__py3-none-any.whl

provide/foundation/eventsets/sets/database.py

@@ -0,0 +1,125 @@
+"""
+Database operations event set for Foundation.
+"""
+
+from provide.foundation.eventsets.types import EventSet, EventMapping, FieldMapping
+
+EVENT_SET = EventSet(
+    name="database",
+    description="Database interaction and query enrichment",
+    mappings=[
+        EventMapping(
+            name="db_system",
+            visual_markers={
+                "postgres": "🐘",
+                "mysql": "🐬",
+                "sqlite": "💾",
+                "mongodb": "🍃",
+                "redis": "🟥",
+                "elasticsearch": "🔍",
+                "default": "🗄️",
+            },
+            metadata_fields={
+                "postgres": {"db.type": "sql", "db.vendor": "postgresql"},
+                "mysql": {"db.type": "sql", "db.vendor": "mysql"},
+                "sqlite": {"db.type": "sql", "db.vendor": "sqlite"},
+                "mongodb": {"db.type": "nosql", "db.vendor": "mongodb"},
+                "redis": {"db.type": "cache", "db.vendor": "redis"},
+                "elasticsearch": {"db.type": "search", "db.vendor": "elastic"},
+            },
+            default_key="default"
+        ),
+        EventMapping(
+            name="db_operation",
+            visual_markers={
+                "query": "🔍",
+                "select": "🔍",
+                "insert": "➕",
+                "update": "🔄",
+                "delete": "🗑️",
+                "connect": "🔗",
+                "disconnect": "💔",
+                "transaction_begin": "💳🟢",
+                "transaction_commit": "💳✅",
+                "transaction_rollback": "💳❌",
+                "default": "⚙️",
+            },
+            metadata_fields={
+                "select": {"db.read": True},
+                "query": {"db.read": True},
+                "insert": {"db.write": True},
+                "update": {"db.write": True},
+                "delete": {"db.write": True},
+            },
+            default_key="default"
+        ),
+        EventMapping(
+            name="db_outcome",
+            visual_markers={
+                "success": "👍",
+                "error": "🔥",
+                "not_found": "❓🤷",
+                "timeout": "⏱️",
+                "default": "➡️",
+            },
+            metadata_fields={
+                "success": {"db.success": True},
+                "error": {"db.error": True},
+                "timeout": {"db.timeout": True},
+            },
+            default_key="default"
+        ),
+    ],
+    field_mappings=[
+        FieldMapping(
+            log_key="db.system",
+            event_set_name="database",
+            description="Database system type",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="db.operation",
+            event_set_name="database",
+            description="Database operation performed",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="db.outcome",
+            event_set_name="database",
+            description="Operation outcome",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="db.statement",
+            event_set_name="database",
+            description="SQL or query statement",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="db.table",
+            event_set_name="database",
+            description="Table name",
+            value_type="string",
+            default_override_key="default"
+        ),
+        FieldMapping(
+            log_key="db.rows_affected",
+            event_set_name="database",
+            description="Number of rows affected",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="duration_ms",
+            event_set_name="database",
+            description="Query duration in milliseconds",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="trace_id",
+            event_set_name="database",
+            description="Distributed trace ID",
+            value_type="string"
+        ),
+    ],
+    priority=90
+)

provide/foundation/eventsets/sets/http.py

@@ -0,0 +1,153 @@
+"""
+HTTP request/response event set for Foundation.
+"""
+
+from provide.foundation.eventsets.types import EventMapping, EventSet, FieldMapping
+
+EVENT_SET = EventSet(
+    name="http",
+    description="HTTP client and server interaction enrichment",
+    mappings=[
+        EventMapping(
+            name="http_method",
+            visual_markers={
+                "get": "📥",
+                "post": "📤",
+                "put": "📝⬆️",
+                "delete": "🗑️",
+                "patch": "🩹",
+                "head": "👤❔",
+                "options": "⚙️❔",
+                "default": "🌐",
+            },
+            default_key="default"
+        ),
+        EventMapping(
+            name="http_status_class",
+            visual_markers={
+                "1xx": "ℹ️",
+                "2xx": "✅",
+                "3xx": "↪️",
+                "4xx": "⚠️CLIENT",
+                "5xx": "🔥SERVER",
+                "default": "❓",
+            },
+            metadata_fields={
+                "2xx": {"http.success": True},
+                "4xx": {"http.client_error": True},
+                "5xx": {"http.server_error": True},
+            },
+            default_key="default"
+        ),
+        EventMapping(
+            name="http_target_type",
+            visual_markers={
+                "path": "🛣️",
+                "query": "❓",
+                "fragment": "#️⃣",
+                "default": "🎯",
+            },
+            default_key="default"
+        ),
+    ],
+    field_mappings=[
+        FieldMapping(
+            log_key="http.method",
+            event_set_name="http",
+            description="HTTP request method",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="http.status_class",
+            event_set_name="http",
+            description="HTTP status code class",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="http.target",
+            event_set_name="http",
+            description="Request target path and query",
+            value_type="string",
+            default_override_key="path"
+        ),
+        FieldMapping(
+            log_key="http.url",
+            event_set_name="http",
+            description="Full HTTP URL",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="http.scheme",
+            event_set_name="http",
+            description="URL scheme",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="http.host",
+            event_set_name="http",
+            description="Request hostname",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="http.status_code",
+            event_set_name="http",
+            description="HTTP response status code",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="http.request.body.size",
+            event_set_name="http",
+            description="Request body size in bytes",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="http.response.body.size",
+            event_set_name="http",
+            description="Response body size in bytes",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="client.address",
+            event_set_name="http",
+            description="Client IP address",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="server.address",
+            event_set_name="http",
+            description="Server address or hostname",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="duration_ms",
+            event_set_name="http",
+            description="Request duration in milliseconds",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="trace_id",
+            event_set_name="http",
+            description="Distributed trace ID",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="span_id",
+            event_set_name="http",
+            description="Span ID",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="error.message",
+            event_set_name="http",
+            description="Error message if request failed",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="error.type",
+            event_set_name="http",
+            description="Error type if request failed",
+            value_type="string"
+        ),
+    ],
+    priority=80
+)

provide/foundation/eventsets/sets/llm.py

@@ -0,0 +1,139 @@
+"""
+Large Language Model (LLM) interaction event set for Foundation.
+"""
+
+from provide.foundation.eventsets.types import EventSet, EventMapping, FieldMapping
+
+EVENT_SET = EventSet(
+    name="llm",
+    description="LLM provider and interaction enrichment",
+    mappings=[
+        EventMapping(
+            name="llm_provider",
+            visual_markers={
+                "openai": "🤖",
+                "anthropic": "📚",
+                "google": "🇬",
+                "meta": "🦙",
+                "mistral": "🌬️",
+                "perplexity": "❓",
+                "cohere": "🔊",
+                "default": "💡",
+            },
+            metadata_fields={
+                "openai": {"llm.vendor": "openai", "llm.api": "openai"},
+                "anthropic": {"llm.vendor": "anthropic", "llm.api": "claude"},
+                "google": {"llm.vendor": "google", "llm.api": "gemini"},
+                "meta": {"llm.vendor": "meta", "llm.api": "llama"},
+                "mistral": {"llm.vendor": "mistral", "llm.api": "mistral"},
+            },
+            default_key="default"
+        ),
+        EventMapping(
+            name="llm_task",
+            visual_markers={
+                "generation": "✍️",
+                "completion": "✅",
+                "embedding": "🔗",
+                "chat": "💬",
+                "tool_use": "🛠️",
+                "summarization": "📜",
+                "translation": "🌐",
+                "classification": "🏷️",
+                "default": "⚡",
+            },
+            metadata_fields={
+                "generation": {"llm.type": "generative"},
+                "completion": {"llm.type": "completion"},
+                "embedding": {"llm.type": "embedding"},
+                "chat": {"llm.type": "conversational"},
+                "tool_use": {"llm.type": "function_calling"},
+            },
+            default_key="default"
+        ),
+        EventMapping(
+            name="llm_outcome",
+            visual_markers={
+                "success": "👍",
+                "error": "🔥",
+                "filtered_input": "🛡️👁️",
+                "filtered_output": "🛡️🗣️",
+                "rate_limit": "⏳",
+                "partial_success": "🤏",
+                "tool_call": "📞",
+                "default": "➡️",
+            },
+            metadata_fields={
+                "success": {"llm.success": True},
+                "error": {"llm.error": True},
+                "rate_limit": {"llm.rate_limited": True},
+                "filtered_input": {"llm.filtered": True, "llm.filter_type": "input"},
+                "filtered_output": {"llm.filtered": True, "llm.filter_type": "output"},
+            },
+            default_key="default"
+        ),
+    ],
+    field_mappings=[
+        FieldMapping(
+            log_key="llm.provider",
+            event_set_name="llm",
+            description="LLM provider name",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="llm.task",
+            event_set_name="llm",
+            description="LLM task type",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="llm.model",
+            event_set_name="llm",
+            description="Model identifier",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="llm.outcome",
+            event_set_name="llm",
+            description="Operation outcome",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="llm.input.tokens",
+            event_set_name="llm",
+            description="Input token count",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="llm.output.tokens",
+            event_set_name="llm",
+            description="Output token count",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="llm.tool.name",
+            event_set_name="llm",
+            description="Tool/function name",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="llm.tool.call_id",
+            event_set_name="llm",
+            description="Tool call identifier",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="duration_ms",
+            event_set_name="llm",
+            description="LLM operation duration",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="trace_id",
+            event_set_name="llm",
+            description="Distributed trace ID",
+            value_type="string"
+        ),
+    ],
+    priority=100  # High priority for LLM operations
+)

provide/foundation/eventsets/sets/task_queue.py

@@ -0,0 +1,107 @@
+"""
+Task queue and async job processing event set for Foundation.
+"""
+
+from provide.foundation.eventsets.types import EventSet, EventMapping, FieldMapping
+
+EVENT_SET = EventSet(
+    name="task_queue",
+    description="Asynchronous task queue operation enrichment",
+    mappings=[
+        EventMapping(
+            name="task_system",
+            visual_markers={
+                "celery": "🥕",
+                "rq": "🟥🇶",
+                "dramatiq": "🎭",
+                "kafka": "🌊",
+                "rabbitmq": "🐇",
+                "default": "📨",
+            },
+            metadata_fields={
+                "celery": {"task.broker": "celery"},
+                "rq": {"task.broker": "redis"},
+                "dramatiq": {"task.broker": "dramatiq"},
+                "kafka": {"task.broker": "kafka", "task.streaming": True},
+                "rabbitmq": {"task.broker": "amqp"},
+            },
+            default_key="default"
+        ),
+        EventMapping(
+            name="task_status",
+            visual_markers={
+                "submitted": "➡️📨",
+                "received": "📥",
+                "started": "▶️",
+                "progress": "🔄",
+                "retrying": "🔁",
+                "success": "✅🏁",
+                "failure": "❌🔥",
+                "revoked": "🚫",
+                "default": "❓",
+            },
+            metadata_fields={
+                "submitted": {"task.state": "pending"},
+                "received": {"task.state": "pending"},
+                "started": {"task.state": "active"},
+                "progress": {"task.state": "active"},
+                "retrying": {"task.state": "retry"},
+                "success": {"task.state": "completed", "task.success": True},
+                "failure": {"task.state": "failed", "task.success": False},
+                "revoked": {"task.state": "cancelled"},
+            },
+            default_key="default"
+        ),
+    ],
+    field_mappings=[
+        FieldMapping(
+            log_key="task.system",
+            event_set_name="task_queue",
+            description="Task queue system",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="task.status",
+            event_set_name="task_queue",
+            description="Task execution status",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="task.id",
+            event_set_name="task_queue",
+            description="Unique task identifier",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="task.name",
+            event_set_name="task_queue",
+            description="Task or job name",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="task.queue_name",
+            event_set_name="task_queue",
+            description="Queue name",
+            value_type="string"
+        ),
+        FieldMapping(
+            log_key="task.retries",
+            event_set_name="task_queue",
+            description="Retry attempt count",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="duration_ms",
+            event_set_name="task_queue",
+            description="Task execution duration",
+            value_type="integer"
+        ),
+        FieldMapping(
+            log_key="trace_id",
+            event_set_name="task_queue",
+            description="Distributed trace ID",
+            value_type="string"
+        ),
+    ],
+    priority=70
+)

provide/foundation/eventsets/types.py

@@ -0,0 +1,70 @@
+"""
+Event set type definitions for the Foundation event enrichment system.
+"""
+
+from collections.abc import Callable
+from typing import Any
+
+from attrs import define, field
+
+
+@define(frozen=True, slots=True)
+class EventMapping:
+    """
+    Individual event enrichment mapping for a specific domain.
+    
+    Attributes:
+        name: Unique identifier for this mapping
+        visual_markers: Mapping of values to visual indicators (e.g., emojis)
+        metadata_fields: Additional metadata to attach based on values
+        transformations: Value transformation functions
+        default_key: Key to use when no specific match is found
+    """
+    
+    name: str
+    visual_markers: dict[str, str] = field(factory=lambda: {})
+    metadata_fields: dict[str, dict[str, Any]] = field(factory=lambda: {})
+    transformations: dict[str, Callable[[Any], Any]] = field(factory=lambda: {})
+    default_key: str = field(default="default")
+
+
+@define(frozen=True, slots=True)
+class FieldMapping:
+    """
+    Maps a log field to an event set for enrichment.
+    
+    Attributes:
+        log_key: The field key in log events (e.g., "http.method", "llm.provider")
+        description: Human-readable description of this field
+        value_type: Expected type of the field value
+        event_set_name: Name of the EventSet to use for enrichment
+        default_override_key: Override the default key for this specific field
+        default_value: Default value to use if field is not present
+    """
+    
+    log_key: str
+    description: str | None = field(default=None)
+    value_type: str | None = field(default=None)
+    event_set_name: str | None = field(default=None)
+    default_override_key: str | None = field(default=None)
+    default_value: Any | None = field(default=None)
+
+
+@define(frozen=True, slots=True)
+class EventSet:
+    """
+    Complete event enrichment domain definition.
+    
+    Attributes:
+        name: Unique identifier for this event set
+        description: Human-readable description
+        mappings: List of EventMapping definitions
+        field_mappings: List of field-to-mapping associations
+        priority: Higher priority sets override lower ones
+    """
+    
+    name: str
+    description: str | None = field(default=None)
+    mappings: list[EventMapping] = field(factory=lambda: [])
+    field_mappings: list[FieldMapping] = field(factory=lambda: [])
+    priority: int = field(default=0, converter=int)