openlit 1.31.0__py3-none-any.whl → 1.32.0__py3-none-any.whl

openlit/instrumentation/multion/multion.py

@@ -0,0 +1,131 @@
+# pylint: disable=duplicate-code, broad-exception-caught, too-many-statements, unused-argument, too-many-branches
+"""
+Module for monitoring multion calls.
+"""
+
+import logging
+from opentelemetry.trace import SpanKind, Status, StatusCode
+from opentelemetry.sdk.resources import TELEMETRY_SDK_NAME
+from openlit.__helpers import (
+    handle_exception,
+)
+from openlit.semcov import SemanticConvetion
+
+# Initialize logger for logging potential issues and operations
+logger = logging.getLogger(__name__)
+
+def multion_wrap(gen_ai_endpoint, version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics):
+    """
+    Generates a telemetry wrapper for chat completions to collect metrics.
+
+    Args:
+        gen_ai_endpoint: Endpoint identifier for logging and tracing.
+        version: Version of the monitoring package.
+        environment: Deployment environment (e.g., production, staging).
+        application_name: Name of the application using the multion Agent.
+        tracer: OpenTelemetry tracer for creating spans.
+        pricing_info: Information used for calculating the cost of multion usage.
+        trace_content: Flag indicating whether to trace the actual content.
+
+    Returns:
+        A function that wraps the chat completions method to add telemetry.
+    """
+
+    def wrapper(wrapped, instance, args, kwargs):
+        """
+        Wraps the 'chat.completions' API call to add telemetry.
+
+        This collects metrics such as execution time, cost, and token usage, and handles errors
+        gracefully, adding details to the trace for observability.
+
+        Args:
+            wrapped: The original 'chat.completions' method to be wrapped.
+            instance: The instance of the class where the original method is defined.
+            args: Positional arguments for the 'chat.completions' method.
+            kwargs: Keyword arguments for the 'chat.completions' method.
+
+        Returns:
+            The response from the original 'chat.completions' method.
+        """
+
+        # pylint: disable=line-too-long
+        with tracer.start_as_current_span(gen_ai_endpoint, kind= SpanKind.CLIENT) as span:
+            response = wrapped(*args, **kwargs)
+
+            try:
+                # Set base span attribues
+                span.set_attribute(TELEMETRY_SDK_NAME, "openlit")
+                span.set_attribute(SemanticConvetion.GEN_AI_SYSTEM,
+                                    SemanticConvetion.GEN_AI_SYSTEM_MULTION)
+                span.set_attribute(SemanticConvetion.GEN_AI_TYPE,
+                                    SemanticConvetion.GEN_AI_TYPE_AGENT)
+                span.set_attribute(SemanticConvetion.GEN_AI_ENDPOINT,
+                                    gen_ai_endpoint)
+                span.set_attribute(SemanticConvetion.GEN_AI_APPLICATION_NAME,
+                                    application_name)
+
+                if gen_ai_endpoint == "multion.browse":
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_BROWSE_URL,
+                                    kwargs.get("url", ""))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_STEP_COUNT,
+                                    response.metadata.step_count)
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_RESPONSE_TIME,
+                                    response.metadata.processing_time)
+
+                    if trace_content:
+                        span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_PROMPT_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_PROMPT: kwargs.get("cmd", ""),
+                            },
+                        )
+                        span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_COMPLETION_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_COMPLETION: response.message,
+                            },
+                        )
+                elif gen_ai_endpoint == "multion.retrieve":
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_BROWSE_URL,
+                                    kwargs.get("url", ""))
+
+                    if trace_content:
+                        span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_PROMPT_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_PROMPT: kwargs.get("cmd", ""),
+                            },
+                        )
+                        span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_COMPLETION_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_COMPLETION: response.message,
+                            },
+                        )
+
+                elif gen_ai_endpoint == "multion.sessions.create":
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_BROWSE_URL,
+                                    kwargs.get("url", ""))
+
+                    if trace_content:
+                        span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_COMPLETION_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_COMPLETION: response.message,
+                            },
+                        )
+
+                span.set_status(Status(StatusCode.OK))
+
+                # Return original response
+                return response
+
+            except Exception as e:
+                handle_exception(span, e)
+                logger.error("Error in trace creation: %s", e)
+
+                # Return original response
+                return response
+
+    return wrapper

openlit/instrumentation/phidata/__init__.py

@@ -0,0 +1,42 @@
+# pylint: disable=useless-return, bad-staticmethod-argument, disable=duplicate-code
+"""Initializer of Auto Instrumentation of Phidata Functions"""
+
+from typing import Collection
+import importlib.metadata
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from wrapt import wrap_function_wrapper
+
+from openlit.instrumentation.phidata.phidata import (
+    phidata_wrap
+)
+
+_instruments = ("phidata >= 2.5.32",)
+
+class PhidataInstrumentor(BaseInstrumentor):
+    """
+    An instrumentor for Phidata's client library.
+    """
+
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
+    def _instrument(self, **kwargs):
+        application_name = kwargs.get("application_name", "default_application")
+        environment = kwargs.get("environment", "default_environment")
+        tracer = kwargs.get("tracer")
+        metrics = kwargs.get("metrics_dict")
+        pricing_info = kwargs.get("pricing_info", {})
+        trace_content = kwargs.get("trace_content", False)
+        disable_metrics = kwargs.get("disable_metrics")
+        version = importlib.metadata.version("phidata")
+
+        wrap_function_wrapper(
+            "phi.agent",
+            "Agent.print_response",
+            phidata_wrap("phidata.print_response", version, environment, application_name,
+                  tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+    def _uninstrument(self, **kwargs):
+        # Proper uninstrumentation logic to revert patched methods
+        pass

openlit/instrumentation/phidata/phidata.py

@@ -0,0 +1,98 @@
+# pylint: disable=duplicate-code, broad-exception-caught, too-many-statements, unused-argument
+"""
+Module for monitoring Phidata calls.
+"""
+
+import logging
+from opentelemetry.trace import SpanKind, Status, StatusCode
+from opentelemetry.sdk.resources import TELEMETRY_SDK_NAME
+from openlit.__helpers import (
+    handle_exception,
+)
+from openlit.semcov import SemanticConvetion
+
+# Initialize logger for logging potential issues and operations
+logger = logging.getLogger(__name__)
+
+def phidata_wrap(gen_ai_endpoint, version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics):
+    """
+    Generates a telemetry wrapper for chat completions to collect metrics.
+
+    Args:
+        gen_ai_endpoint: Endpoint identifier for logging and tracing.
+        version: Version of the monitoring package.
+        environment: Deployment environment (e.g., production, staging).
+        application_name: Name of the application using the Phidata Agent.
+        tracer: OpenTelemetry tracer for creating spans.
+        pricing_info: Information used for calculating the cost of Phidata usage.
+        trace_content: Flag indicating whether to trace the actual content.
+
+    Returns:
+        A function that wraps the chat completions method to add telemetry.
+    """
+
+    def wrapper(wrapped, instance, args, kwargs):
+        """
+        Wraps the 'chat.completions' API call to add telemetry.
+
+        This collects metrics such as execution time, cost, and token usage, and handles errors
+        gracefully, adding details to the trace for observability.
+
+        Args:
+            wrapped: The original 'chat.completions' method to be wrapped.
+            instance: The instance of the class where the original method is defined.
+            args: Positional arguments for the 'chat.completions' method.
+            kwargs: Keyword arguments for the 'chat.completions' method.
+
+        Returns:
+            The response from the original 'chat.completions' method.
+        """
+
+        # pylint: disable=line-too-long
+        with tracer.start_as_current_span(gen_ai_endpoint, kind= SpanKind.CLIENT) as span:
+            response = wrapped(*args, **kwargs)
+
+            try:
+                # Set base span attribues
+                span.set_attribute(TELEMETRY_SDK_NAME, "openlit")
+                span.set_attribute(SemanticConvetion.GEN_AI_SYSTEM,
+                                    SemanticConvetion.GEN_AI_SYSTEM_PHIDATA)
+                span.set_attribute(SemanticConvetion.GEN_AI_TYPE,
+                                    SemanticConvetion.GEN_AI_TYPE_AGENT)
+                span.set_attribute(SemanticConvetion.GEN_AI_ENDPOINT,
+                                    gen_ai_endpoint)
+                span.set_attribute(SemanticConvetion.GEN_AI_APPLICATION_NAME,
+                                    application_name)
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ID,
+                                    getattr(instance, 'agent_id', '') or '')
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ROLE,
+                                    getattr(instance, 'name', '') or '')
+                span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MODEL,
+                                    getattr(getattr(instance, 'model', None), 'id', '') or '')
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_TOOLS,
+                                    str(getattr(instance, 'tools', '')) or '')
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_CONTEXT,
+                                    str(getattr(instance, 'knowledge', '')) or '')
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_TASK,
+                                    str(getattr(instance, 'task', '')) or '')
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_INSTRUCTIONS,
+                                    str(getattr(instance, 'instructions', '')) or '')
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_STORAGE,
+                                    str(getattr(instance, 'storage', '')) or '')
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ENABLE_HISTORY,
+                                    str(getattr(instance, 'add_history_to_messages', '')) or '')
+
+                span.set_status(Status(StatusCode.OK))
+
+                # Return original response
+                return response
+
+            except Exception as e:
+                handle_exception(span, e)
+                logger.error("Error in trace creation: %s", e)
+
+                # Return original response
+                return response
+
+    return wrapper

openlit/instrumentation/premai/__init__.py

@@ -0,0 +1,51 @@
+# pylint: disable=useless-return, bad-staticmethod-argument, disable=duplicate-code
+"""Initializer of Auto Instrumentation of Prem AI Functions"""
+
+from typing import Collection
+import importlib.metadata
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from wrapt import wrap_function_wrapper
+
+from openlit.instrumentation.premai.premai import (
+    chat, embedding
+)
+
+_instruments = ("premai >= 0.3.79",)
+
+class PremAIInstrumentor(BaseInstrumentor):
+    """
+    An instrumentor for Prem AI's client library.
+    """
+
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
+    def _instrument(self, **kwargs):
+        application_name = kwargs.get("application_name", "default_application")
+        environment = kwargs.get("environment", "default_environment")
+        tracer = kwargs.get("tracer")
+        metrics = kwargs.get("metrics_dict")
+        pricing_info = kwargs.get("pricing_info", {})
+        trace_content = kwargs.get("trace_content", False)
+        disable_metrics = kwargs.get("disable_metrics")
+        version = importlib.metadata.version("premai")
+
+        # sync chat
+        wrap_function_wrapper(
+            "premai.api",
+            "ChatCompletionsModule.create",
+            chat("premai.chat.completions", version, environment, application_name,
+                  tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        # sync embedding
+        wrap_function_wrapper(
+            "premai.api",
+            "EmbeddingsModule.create",
+            embedding("premai.embeddings", version, environment, application_name,
+                  tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+    def _uninstrument(self, **kwargs):
+        # Proper uninstrumentation logic to revert patched methods
+        pass