openlit 1.29.3__py3-none-any.whl → 1.30.0__py3-none-any.whl

openlit/__helpers.py

@@ -13,6 +13,20 @@ from opentelemetry.trace import Status, StatusCode
 # Set up logging
 logger = logging.getLogger(__name__)
 
+def response_as_dict(response):
+    """
+    Return parsed response as a dict
+    """
+    # pylint: disable=no-else-return
+    if isinstance(response, dict):
+        return response
+    if hasattr(response, "model_dump"):
+        return response.model_dump()
+    elif hasattr(response, "parse"):
+        return response_as_dict(response.parse())
+    else:
+        return response
+
 def get_env_variable(name, arg_value, error_message):
     """
     Retrieve an environment variable if the argument is not provided

openlit/__init__.py

@@ -46,6 +46,8 @@ from openlit.instrumentation.pinecone import PineconeInstrumentor
 from openlit.instrumentation.qdrant import QdrantInstrumentor
 from openlit.instrumentation.milvus import MilvusInstrumentor
 from openlit.instrumentation.transformers import TransformersInstrumentor
+from openlit.instrumentation.litellm import LiteLLMInstrumentor
+from openlit.instrumentation.crewai import CrewAIInstrumentor
 from openlit.instrumentation.gpu import GPUInstrumentor
 import openlit.guard
 import openlit.evals
@@ -228,6 +230,8 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
         "qdrant": "qdrant_client",
         "milvus": "pymilvus",
         "transformers": "transformers",
+        "litellm": "litellm",
+        "crewai": "crewai",
     }
 
     invalid_instrumentors = [
@@ -305,6 +309,8 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
             "qdrant": QdrantInstrumentor(),
             "milvus": MilvusInstrumentor(),
             "transformers": TransformersInstrumentor(),
+            "litellm": LiteLLMInstrumentor(),
+            "crewai": CrewAIInstrumentor(),
         }
 
         # Initialize and instrument only the enabled instrumentors

openlit/instrumentation/crewai/__init__.py

@@ -0,0 +1,50 @@
+# pylint: disable=useless-return, bad-staticmethod-argument, disable=duplicate-code
+"""Initializer of Auto Instrumentation of CrewAI Functions"""
+
+from typing import Collection
+import importlib.metadata
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from wrapt import wrap_function_wrapper
+
+from openlit.instrumentation.crewai.crewai import (
+    crew_wrap
+)
+
+_instruments = ("crewai >= 0.80.0",)
+
+class CrewAIInstrumentor(BaseInstrumentor):
+    """
+    An instrumentor for CrewAI'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("crewai")
+
+        wrap_function_wrapper(
+            "crewai.agent",
+            "Agent.execute_task",
+            crew_wrap("crewai.agent_execute_task", version, environment, application_name,
+                  tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "crewai.task",
+            "Task._execute_core",
+            crew_wrap("crewai.task_execute_core", 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/crewai/crewai.py

@@ -0,0 +1,149 @@
+# pylint: disable=duplicate-code, broad-exception-caught, too-many-statements, unused-argument, too-many-branches
+"""
+Module for monitoring LiteLLM calls.
+"""
+
+import logging
+import json
+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 _parse_tools(tools):
+    result = []
+    for tool in tools:
+        res = {}
+        if hasattr(tool, "name") and tool.name is not None:
+            res["name"] = tool.name
+        if hasattr(tool, "description") and tool.description is not None:
+            res["description"] = tool.description
+        if res:
+            result.append(res)
+    return json.dumps(result)
+
+def crew_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 OpenAI API.
+        tracer: OpenTelemetry tracer for creating spans.
+        pricing_info: Information used for calculating the cost of OpenAI 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_OPENAI)
+                span.set_attribute(SemanticConvetion.GEN_AI_TYPE,
+                                    SemanticConvetion.GEN_AI_TYPE_CHAT)
+                span.set_attribute(SemanticConvetion.GEN_AI_ENDPOINT,
+                                    gen_ai_endpoint)
+
+                instance_class = instance.__class__.__name__
+
+                if instance_class == "Task":
+                    task = {}
+                    for key, value in instance.__dict__.items():
+                        if value is None:
+                            continue
+                        if key == "tools":
+                            value = _parse_tools(value)
+                            task[key] = value
+                        elif key == "agent":
+                            task[key] = value.role
+                        else:
+                            task[key] = str(value)
+
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_TASK_ID,
+                                        task.get('id', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_TASK,
+                                        task.get('description', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_EXPECTED_OUTPUT,
+                                        task.get('expected_output', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ACTUAL_OUTPUT,
+                                        task.get('output', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_HUMAN_INPUT,
+                                        task.get('human_input', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_TASK_ASSOCIATION,
+                                       str(task.get('processed_by_agents', '')))
+
+                elif instance_class == "Agent":
+                    agent = {}
+                    for key, value in instance.__dict__.items():
+                        if key == "tools":
+                            value = _parse_tools(value)
+                        if value is None:
+                            continue
+                        agent[key] = str(value)
+
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ID,
+                                        agent.get('id', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ROLE,
+                                        agent.get('role', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_GOAL,
+                                        agent.get('goal', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_CONTEXT,
+                                        agent.get('backstory', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ENABLE_CACHE,
+                                        agent.get('cache', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ALLOW_DELEGATION,
+                                        agent.get('allow_delegation', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_ALLOW_CODE_EXECUTION,
+                                        agent.get('allow_code_execution', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_MAX_RETRY_LIMIT,
+                                        agent.get('max_retry_limit', ''))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_TOOLS,
+                                        str(agent.get('tools', '')))
+                    span.set_attribute(SemanticConvetion.GEN_AI_AGENT_TOOL_RESULTS,
+                                        str(agent.get('tools_results', '')))
+
+                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/litellm/__init__.py

@@ -0,0 +1,54 @@
+# pylint: disable=useless-return, bad-staticmethod-argument, disable=duplicate-code
+"""Initializer of Auto Instrumentation of LiteLLM Functions"""
+
+from typing import Collection
+import importlib.metadata
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from wrapt import wrap_function_wrapper
+
+from openlit.instrumentation.litellm.litellm import (
+    completion
+)
+from openlit.instrumentation.litellm.async_litellm import (
+   acompletion
+)
+
+_instruments = ("litellm >= 1.52.6",)
+
+class LiteLLMInstrumentor(BaseInstrumentor):
+    """
+    An instrumentor for LiteLLM'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("litellm")
+
+        # completion
+        wrap_function_wrapper(
+            "litellm",
+            "completion",
+            completion("litellm.completion", version, environment, application_name,
+                  tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "litellm",
+            "acompletion",
+            acompletion("litellm.completion", version, environment, application_name,
+                  tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+
+    def _uninstrument(self, **kwargs):
+        # Proper uninstrumentation logic to revert patched methods
+        pass