openlit 1.33.15__py3-none-any.whl → 1.33.16__py3-none-any.whl

openlit/__init__.py

@@ -65,6 +65,7 @@ from openlit.instrumentation.controlflow import ControlFlowInstrumentor
 from openlit.instrumentation.crawl4ai import Crawl4AIInstrumentor
 from openlit.instrumentation.firecrawl import FireCrawlInstrumentor
 from openlit.instrumentation.letta import LettaInstrumentor
+from openlit.instrumentation.openai_agents import OpenAIAgentsInstrumentor
 from openlit.instrumentation.gpu import GPUInstrumentor
 import openlit.guard
 import openlit.evals
@@ -293,6 +294,7 @@ def init(
         "firecrawl": "firecrawl",
         "letta": "letta",
         "together": "together",
+        "openai-agents": "agents"
     }
 
     invalid_instrumentors = [
@@ -411,6 +413,7 @@ def init(
             "firecrawl": FireCrawlInstrumentor(),
             "letta": LettaInstrumentor(),
             "together": TogetherInstrumentor(),
+            "openai-agents": OpenAIAgentsInstrumentor(),
         }
 
         # Initialize and instrument only the enabled instrumentors

openlit/instrumentation/openai/__init__.py

@@ -5,11 +5,11 @@ import importlib.metadata
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from wrapt import wrap_function_wrapper
 
-from openlit.instrumentation.openai.openai import chat_completions, embedding
+from openlit.instrumentation.openai.openai import chat_completions, embedding, responses
 from openlit.instrumentation.openai.openai import image_generate, image_variatons, audio_create
 from openlit.instrumentation.openai.async_openai import async_chat_completions, async_embedding
 from openlit.instrumentation.openai.async_openai import async_image_generate, async_image_variatons
-from openlit.instrumentation.openai.async_openai import async_audio_create
+from openlit.instrumentation.openai.async_openai import async_audio_create, async_responses
 
 _instruments = ("openai >= 1.1.1",)
 
@@ -45,6 +45,22 @@ class OpenAIInstrumentor(BaseInstrumentor):
                                metrics, disable_metrics),
         )
 
+        wrap_function_wrapper(
+            "openai.resources.responses.responses",  
+            "Responses.create",  
+            responses(version, environment, application_name,
+                         tracer, pricing_info, capture_message_content,
+                         metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "openai.resources.responses.responses",  
+            "AsyncResponses.create",  
+            async_responses(version, environment, application_name,
+                         tracer, pricing_info, capture_message_content,
+                         metrics, disable_metrics),
+        )
+
         wrap_function_wrapper(
             "openai.resources.images",  
             "Images.generate",  

openlit/instrumentation/openai/async_openai.py

@@ -13,6 +13,8 @@ from openlit.__helpers import (
     get_image_model_cost,
     general_tokens,
     handle_exception,
+    extract_and_format_input,
+    concatenate_all_contents,
     response_as_dict,
     calculate_ttft,
     calculate_tbt,
@@ -24,6 +26,409 @@ from openlit.semcov import SemanticConvetion
 # Initialize logger for logging potential issues and operations
 logger = logging.getLogger(__name__)
 
+def async_responses(version, environment, application_name,
+                     tracer, pricing_info, capture_message_content, metrics, disable_metrics):
+    """
+    Generates a telemetry wrapper for chat completions to collect metrics.
+
+    Args:
+        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.
+        capture_message_content: Flag indicating whether to trace the actual content.
+
+    Returns:
+        A function that wraps the chat completions method to add telemetry.
+    """
+
+    class TracedAsyncStream:
+        """
+        Wrapper for streaming responses to collect metrics and trace data.
+        Wraps the response to collect message IDs and aggregated response.
+
+        This class implements the '__aiter__' and '__anext__' methods that
+        handle asynchronous streaming responses.
+
+        This class also implements '__aenter__' and '__aexit__' methods that
+        handle asynchronous context management protocol.
+        """
+        def __init__(
+                self,
+                wrapped,
+                span,
+                kwargs,
+                server_address,
+                server_port,
+                **args,
+            ):
+            self.__wrapped__ = wrapped
+            self._span = span
+            # Placeholder for aggregating streaming response
+            self._llmresponse = ""
+            self._response_id = ""
+            self._response_model = ""
+            self._finish_reason = ""
+            self._input_tokens = ""
+            self._output_tokens = ""
+
+            self._args = args
+            self._kwargs = kwargs
+            self._start_time = time.time()
+            self._end_time = None
+            self._timestamps = []
+            self._ttft = 0
+            self._tbt = 0
+            self._server_address = server_address
+            self._server_port = server_port
+
+        async def __aenter__(self):
+            await self.__wrapped__.__aenter__()
+            return self
+
+        async def __aexit__(self, exc_type, exc_value, traceback):
+            await self.__wrapped__.__aexit__(exc_type, exc_value, traceback)
+
+        def __aiter__(self):
+            return self
+
+        async def __getattr__(self, name):
+            """Delegate attribute access to the wrapped object."""
+            return getattr(await self.__wrapped__, name)
+
+        async def __anext__(self):
+            try:
+                chunk = await self.__wrapped__.__anext__()
+                end_time = time.time()
+                # Record the timestamp for the current chunk
+                self._timestamps.append(end_time)
+
+                if len(self._timestamps) == 1:
+                    # Calculate time to first chunk
+                    self._ttft = calculate_ttft(self._timestamps, self._start_time)
+
+                chunked = response_as_dict(chunk)
+                # Collect message IDs and aggregated response from events
+                if chunked.get('type') == "response.output_text.delta":
+                    self._llmresponse += chunked.get('delta')
+                if chunked.get('type') == "response.completed":
+                    self._response_id = chunked.get('response').get('id')
+                    self._response_model = chunked.get('response').get('model')
+                    self._finish_reason = chunked.get('response').get('status')
+                    self._input_tokens = chunked.get('response').get('usage').get('input_tokens')
+                    self._output_tokens = chunked.get('response').get('usage').get('output_tokens')
+                return chunk
+            except StopAsyncIteration:
+                # Handling exception ensure observability without disrupting operation
+                try:
+                    self._end_time = time.time()
+                    if len(self._timestamps) > 1:
+                        self._tbt = calculate_tbt(self._timestamps)
+
+                    try:
+                        formatted_messages = extract_and_format_input(self._kwargs.get('input', ''))
+                        prompt = concatenate_all_contents(formatted_messages)
+                    except:
+                        prompt = self._kwargs.get('input', '')
+
+                    request_model = self._kwargs.get("model", "gpt-4o")
+
+                    # Calculate cost of the operation
+                    cost = get_chat_model_cost(request_model,
+                                                pricing_info, self._input_tokens,
+                                                self._output_tokens)
+
+                    # Set Span attributes (OTel Semconv)
+                    self._span.set_attribute(TELEMETRY_SDK_NAME, "openlit")
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_OPERATION,
+                                        SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_SYSTEM,
+                                        SemanticConvetion.GEN_AI_SYSTEM_OPENAI)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MODEL,
+                                        request_model)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_SEED,
+                                        self._kwargs.get("seed", ""))
+                    self._span.set_attribute(SemanticConvetion.SERVER_PORT,
+                                        self._server_port)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MAX_TOKENS,
+                                        self._kwargs.get("max_output_tokens", -1))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_STOP_SEQUENCES,
+                                        self._kwargs.get("stop", []))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_TEMPERATURE,
+                                        self._kwargs.get("temperature", 1.0))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_TOP_P,
+                                        self._kwargs.get("top_p", 1.0))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_FINISH_REASON,
+                                        [self._finish_reason])
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_ID,
+                                        self._response_id)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_MODEL,
+                                        self._response_model)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_USAGE_INPUT_TOKENS,
+                                        self._input_tokens)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_USAGE_OUTPUT_TOKENS,
+                                        self._output_tokens)
+                    self._span.set_attribute(SemanticConvetion.SERVER_ADDRESS,
+                                        self._server_address)
+                    if isinstance(self._llmresponse, str):
+                        self._span.set_attribute(SemanticConvetion.GEN_AI_OUTPUT_TYPE,
+                                        "text")
+                    else:
+                        self._span.set_attribute(SemanticConvetion.GEN_AI_OUTPUT_TYPE,
+                                        "json")
+
+                    # Set Span attributes (Extra)
+                    self._span.set_attribute(DEPLOYMENT_ENVIRONMENT,
+                                        environment)
+                    self._span.set_attribute(SERVICE_NAME,
+                                        application_name)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_USER,
+                                        self._kwargs.get("user", ""))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_IS_STREAM,
+                                        True)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_USAGE_TOTAL_TOKENS,
+                                        self._input_tokens + self._output_tokens)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_USAGE_COST,
+                                        cost)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_SERVER_TBT,
+                                        self._tbt)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_SERVER_TTFT,
+                                        self._ttft)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_SDK_VERSION,
+                                        version)
+
+                    if capture_message_content:
+                        self._span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_PROMPT_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_PROMPT: prompt,
+                            },
+                        )
+                        self._span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_COMPLETION_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_COMPLETION: self._llmresponse,
+                            },
+                        )
+                    self._span.set_status(Status(StatusCode.OK))
+
+                    if disable_metrics is False:
+                        attributes = create_metrics_attributes(
+                            service_name=application_name,
+                            deployment_environment=environment,
+                            operation=SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT,
+                            system=SemanticConvetion.GEN_AI_SYSTEM_OPENAI,
+                            request_model=request_model,
+                            server_address=self._server_address,
+                            server_port=self._server_port,
+                            response_model=self._response_model,
+                        )
+
+                        metrics["genai_client_usage_tokens"].record(
+                            self._input_tokens + self._output_tokens, attributes
+                        )
+                        metrics["genai_client_operation_duration"].record(
+                            self._end_time - self._start_time, attributes
+                        )
+                        metrics["genai_server_tbt"].record(
+                            self._tbt, attributes
+                        )
+                        metrics["genai_server_ttft"].record(
+                            self._ttft, attributes
+                        )
+                        metrics["genai_requests"].add(1, attributes)
+                        metrics["genai_completion_tokens"].add(self._output_tokens, attributes)
+                        metrics["genai_prompt_tokens"].add(self._input_tokens, attributes)
+                        metrics["genai_cost"].record(cost, attributes)
+
+                except Exception as e:
+                    handle_exception(self._span, e)
+                    logger.error("Error in trace creation: %s", e)
+                finally:
+                    self._span.end()
+                raise
+
+    async 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.
+        """
+
+        # Check if streaming is enabled for the API call
+        streaming = kwargs.get("stream", False)
+        server_address, server_port = set_server_address_and_port(instance, "api.openai.com", 443)
+        request_model = kwargs.get("model", "gpt-4o")
+
+        span_name = f"{SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT} {request_model}"
+
+        # pylint: disable=no-else-return
+        if streaming:
+            # Special handling for streaming response to accommodate the nature of data flow
+            awaited_wrapped = await wrapped(*args, **kwargs)
+            span = tracer.start_span(span_name, kind=SpanKind.CLIENT)
+
+            return TracedAsyncStream(awaited_wrapped, span, kwargs, server_address, server_port)
+
+        # Handling for non-streaming responses
+        else:
+            with tracer.start_as_current_span(span_name, kind= SpanKind.CLIENT) as span:
+                start_time = time.time()
+                response = await wrapped(*args, **kwargs)
+                end_time = time.time()
+
+                response_dict = response_as_dict(response)
+
+                try:
+                    try:
+                        formatted_messages = extract_and_format_input(kwargs.get('input', ''))
+                        prompt = concatenate_all_contents(formatted_messages)
+                    except:
+                        prompt = kwargs.get('input', '')
+
+                    input_tokens = response_dict.get('usage').get('input_tokens')
+                    output_tokens = response_dict.get('usage').get('output_tokens')
+
+                    # Calculate cost of the operation
+                    cost = get_chat_model_cost(request_model,
+                                                pricing_info, input_tokens,
+                                                output_tokens)
+
+                    # Set base span attribues (OTel Semconv)
+                    span.set_attribute(TELEMETRY_SDK_NAME, "openlit")
+                    span.set_attribute(SemanticConvetion.GEN_AI_OPERATION,
+                                        SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT)
+                    span.set_attribute(SemanticConvetion.GEN_AI_SYSTEM,
+                                        SemanticConvetion.GEN_AI_SYSTEM_OPENAI)
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MODEL,
+                                        request_model)
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_SEED,
+                                        kwargs.get("seed", ""))
+                    span.set_attribute(SemanticConvetion.SERVER_PORT,
+                                        server_port)
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MAX_TOKENS,
+                                        kwargs.get("max_output_tokens", -1))
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_STOP_SEQUENCES,
+                                        kwargs.get("stop", []))
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_TEMPERATURE,
+                                        str(response_dict.get("temperature", 1.0)))
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_TOP_P,
+                                        str(response_dict.get("top_p", 1.0)))
+                    span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_ID,
+                                        response_dict.get("id"))
+                    span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_MODEL,
+                                        response_dict.get('model'))
+                    span.set_attribute(SemanticConvetion.GEN_AI_USAGE_INPUT_TOKENS,
+                                        input_tokens)
+                    span.set_attribute(SemanticConvetion.GEN_AI_USAGE_OUTPUT_TOKENS,
+                                        output_tokens)
+                    span.set_attribute(SemanticConvetion.SERVER_ADDRESS,
+                                        server_address)
+
+                    # Set base span attribues (Extras)
+                    span.set_attribute(DEPLOYMENT_ENVIRONMENT,
+                                        environment)
+                    span.set_attribute(SERVICE_NAME,
+                                        application_name)
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_USER,
+                                        kwargs.get("user", ""))
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_IS_STREAM,
+                                        False)
+                    span.set_attribute(SemanticConvetion.GEN_AI_USAGE_TOTAL_TOKENS,
+                                        input_tokens + output_tokens)
+                    span.set_attribute(SemanticConvetion.GEN_AI_USAGE_COST,
+                                        cost)
+                    span.set_attribute(SemanticConvetion.GEN_AI_SERVER_TTFT,
+                                        end_time - start_time)
+                    span.set_attribute(SemanticConvetion.GEN_AI_SDK_VERSION,
+                                        version)
+
+                    if capture_message_content:
+                        span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_PROMPT_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_PROMPT: prompt,
+                            },
+                        )
+
+                    for i in range(kwargs.get('n',1)):
+                        span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_FINISH_REASON,
+                                           [response_dict.get('status')])
+                        try:
+                            llm_response = str(response_dict.get('output')[i].get('content')[0].get('text',''))
+                        except:
+                            llm_response = ''
+
+                        if capture_message_content:
+                            span.add_event(
+                                name=SemanticConvetion.GEN_AI_CONTENT_COMPLETION_EVENT,
+                                attributes={
+                                    # pylint: disable=line-too-long
+                                    SemanticConvetion.GEN_AI_CONTENT_COMPLETION: llm_response,
+                                },
+                            )
+                        if kwargs.get('tools'):
+                            span.set_attribute(SemanticConvetion.GEN_AI_TOOL_CALLS,
+                                            str(response_dict.get('tools')))
+
+                        if isinstance(llm_response, str):
+                            span.set_attribute(SemanticConvetion.GEN_AI_OUTPUT_TYPE,
+                                            "text")
+                        elif llm_response is not None:
+                            span.set_attribute(SemanticConvetion.GEN_AI_OUTPUT_TYPE,
+                                            "json")
+
+                    span.set_status(Status(StatusCode.OK))
+
+                    if disable_metrics is False:
+                        attributes = create_metrics_attributes(
+                            service_name=application_name,
+                            deployment_environment=environment,
+                            operation=SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT,
+                            system=SemanticConvetion.GEN_AI_SYSTEM_OPENAI,
+                            request_model=request_model,
+                            server_address=server_address,
+                            server_port=server_port,
+                            response_model=response_dict.get('model'),
+                        )
+
+                        metrics["genai_client_usage_tokens"].record(
+                            input_tokens + output_tokens, attributes
+                        )
+                        metrics["genai_client_operation_duration"].record(
+                            end_time - start_time, attributes
+                        )
+                        metrics["genai_server_ttft"].record(
+                            end_time - start_time, attributes
+                        )
+                        metrics["genai_requests"].add(1, attributes)
+                        metrics["genai_completion_tokens"].add(output_tokens, attributes)
+                        metrics["genai_prompt_tokens"].add(input_tokens, attributes)
+                        metrics["genai_cost"].record(cost, attributes)
+
+                    # 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
+
 def async_chat_completions(version, environment, application_name,
                            tracer, pricing_info, capture_message_content, metrics, disable_metrics):
     """

openlit/instrumentation/openai/openai.py

@@ -13,6 +13,8 @@ from openlit.__helpers import (
     get_image_model_cost,
     general_tokens,
     handle_exception,
+    extract_and_format_input,
+    concatenate_all_contents,
     response_as_dict,
     calculate_ttft,
     calculate_tbt,
@@ -24,6 +26,409 @@ from openlit.semcov import SemanticConvetion
 # Initialize logger for logging potential issues and operations
 logger = logging.getLogger(__name__)
 
+def responses(version, environment, application_name,
+                     tracer, pricing_info, capture_message_content, metrics, disable_metrics):
+    """
+    Generates a telemetry wrapper for chat completions to collect metrics.
+
+    Args:
+        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.
+        capture_message_content: Flag indicating whether to trace the actual content.
+
+    Returns:
+        A function that wraps the chat completions method to add telemetry.
+    """
+
+    class TracedSyncStream:
+        """
+        Wrapper for streaming responses to collect metrics and trace data.
+        Wraps the response to collect message IDs and aggregated response.
+
+        This class implements the '__aiter__' and '__anext__' methods that
+        handle asynchronous streaming responses.
+
+        This class also implements '__aenter__' and '__aexit__' methods that
+        handle asynchronous context management protocol.
+        """
+        def __init__(
+                self,
+                wrapped,
+                span,
+                kwargs,
+                server_address,
+                server_port,
+                **args,
+            ):
+            self.__wrapped__ = wrapped
+            self._span = span
+            # Placeholder for aggregating streaming response
+            self._llmresponse = ""
+            self._response_id = ""
+            self._response_model = ""
+            self._finish_reason = ""
+            self._input_tokens = ""
+            self._output_tokens = ""
+
+            self._args = args
+            self._kwargs = kwargs
+            self._start_time = time.time()
+            self._end_time = None
+            self._timestamps = []
+            self._ttft = 0
+            self._tbt = 0
+            self._server_address = server_address
+            self._server_port = server_port
+
+        def __enter__(self):
+            self.__wrapped__.__enter__()
+            return self
+
+        def __exit__(self, exc_type, exc_value, traceback):
+            self.__wrapped__.__exit__(exc_type, exc_value, traceback)
+
+        def __iter__(self):
+            return self
+
+        def __getattr__(self, name):
+            """Delegate attribute access to the wrapped object."""
+            return getattr(self.__wrapped__, name)
+
+        def __next__(self):
+            try:
+                chunk = self.__wrapped__.__next__()
+                end_time = time.time()
+                # Record the timestamp for the current chunk
+                self._timestamps.append(end_time)
+
+                if len(self._timestamps) == 1:
+                    # Calculate time to first chunk
+                    self._ttft = calculate_ttft(self._timestamps, self._start_time)
+
+                chunked = response_as_dict(chunk)
+                # Collect message IDs and aggregated response from events
+                if chunked.get('type') == "response.output_text.delta":
+                    self._llmresponse += chunked.get('delta')
+                if chunked.get('type') == "response.completed":
+                    self._response_id = chunked.get('response').get('id')
+                    self._response_model = chunked.get('response').get('model')
+                    self._finish_reason = chunked.get('response').get('status')
+                    self._input_tokens = chunked.get('response').get('usage').get('input_tokens')
+                    self._output_tokens = chunked.get('response').get('usage').get('output_tokens')
+                return chunk
+            except StopIteration:
+                # Handling exception ensure observability without disrupting operation
+                try:
+                    self._end_time = time.time()
+                    if len(self._timestamps) > 1:
+                        self._tbt = calculate_tbt(self._timestamps)
+
+                    try:
+                        formatted_messages = extract_and_format_input(self._kwargs.get('input', ''))
+                        prompt = concatenate_all_contents(formatted_messages)
+                    except:
+                        prompt = self._kwargs.get('input', '')
+
+                    request_model = self._kwargs.get("model", "gpt-4o")
+
+                    # Calculate cost of the operation
+                    cost = get_chat_model_cost(request_model,
+                                                pricing_info, self._input_tokens,
+                                                self._output_tokens)
+
+                    # Set Span attributes (OTel Semconv)
+                    self._span.set_attribute(TELEMETRY_SDK_NAME, "openlit")
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_OPERATION,
+                                        SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_SYSTEM,
+                                        SemanticConvetion.GEN_AI_SYSTEM_OPENAI)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MODEL,
+                                        request_model)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_SEED,
+                                        self._kwargs.get("seed", ""))
+                    self._span.set_attribute(SemanticConvetion.SERVER_PORT,
+                                        self._server_port)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MAX_TOKENS,
+                                        self._kwargs.get("max_output_tokens", -1))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_STOP_SEQUENCES,
+                                        self._kwargs.get("stop", []))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_TEMPERATURE,
+                                        self._kwargs.get("temperature", 1.0))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_TOP_P,
+                                        self._kwargs.get("top_p", 1.0))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_FINISH_REASON,
+                                        [self._finish_reason])
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_ID,
+                                        self._response_id)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_MODEL,
+                                        self._response_model)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_USAGE_INPUT_TOKENS,
+                                        self._input_tokens)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_USAGE_OUTPUT_TOKENS,
+                                        self._output_tokens)
+                    self._span.set_attribute(SemanticConvetion.SERVER_ADDRESS,
+                                        self._server_address)
+                    if isinstance(self._llmresponse, str):
+                        self._span.set_attribute(SemanticConvetion.GEN_AI_OUTPUT_TYPE,
+                                        "text")
+                    else:
+                        self._span.set_attribute(SemanticConvetion.GEN_AI_OUTPUT_TYPE,
+                                        "json")
+
+                    # Set Span attributes (Extra)
+                    self._span.set_attribute(DEPLOYMENT_ENVIRONMENT,
+                                        environment)
+                    self._span.set_attribute(SERVICE_NAME,
+                                        application_name)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_USER,
+                                        self._kwargs.get("user", ""))
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_IS_STREAM,
+                                        True)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_USAGE_TOTAL_TOKENS,
+                                        self._input_tokens + self._output_tokens)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_USAGE_COST,
+                                        cost)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_SERVER_TBT,
+                                        self._tbt)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_SERVER_TTFT,
+                                        self._ttft)
+                    self._span.set_attribute(SemanticConvetion.GEN_AI_SDK_VERSION,
+                                        version)
+
+                    if capture_message_content:
+                        self._span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_PROMPT_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_PROMPT: prompt,
+                            },
+                        )
+                        self._span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_COMPLETION_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_COMPLETION: self._llmresponse,
+                            },
+                        )
+                    self._span.set_status(Status(StatusCode.OK))
+
+                    if disable_metrics is False:
+                        attributes = create_metrics_attributes(
+                            service_name=application_name,
+                            deployment_environment=environment,
+                            operation=SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT,
+                            system=SemanticConvetion.GEN_AI_SYSTEM_OPENAI,
+                            request_model=request_model,
+                            server_address=self._server_address,
+                            server_port=self._server_port,
+                            response_model=self._response_model,
+                        )
+
+                        metrics["genai_client_usage_tokens"].record(
+                            self._input_tokens + self._output_tokens, attributes
+                        )
+                        metrics["genai_client_operation_duration"].record(
+                            self._end_time - self._start_time, attributes
+                        )
+                        metrics["genai_server_tbt"].record(
+                            self._tbt, attributes
+                        )
+                        metrics["genai_server_ttft"].record(
+                            self._ttft, attributes
+                        )
+                        metrics["genai_requests"].add(1, attributes)
+                        metrics["genai_completion_tokens"].add(self._output_tokens, attributes)
+                        metrics["genai_prompt_tokens"].add(self._input_tokens, attributes)
+                        metrics["genai_cost"].record(cost, attributes)
+
+                except Exception as e:
+                    handle_exception(self._span, e)
+                    logger.error("Error in trace creation: %s", e)
+                finally:
+                    self._span.end()
+                raise
+
+    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.
+        """
+
+        # Check if streaming is enabled for the API call
+        streaming = kwargs.get("stream", False)
+        server_address, server_port = set_server_address_and_port(instance, "api.openai.com", 443)
+        request_model = kwargs.get("model", "gpt-4o")
+
+        span_name = f"{SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT} {request_model}"
+
+        # pylint: disable=no-else-return
+        if streaming:
+            # Special handling for streaming response to accommodate the nature of data flow
+            awaited_wrapped = wrapped(*args, **kwargs)
+            span = tracer.start_span(span_name, kind=SpanKind.CLIENT)
+
+            return TracedSyncStream(awaited_wrapped, span, kwargs, server_address, server_port)
+
+        # Handling for non-streaming responses
+        else:
+            with tracer.start_as_current_span(span_name, kind= SpanKind.CLIENT) as span:
+                start_time = time.time()
+                response = wrapped(*args, **kwargs)
+                end_time = time.time()
+
+                response_dict = response_as_dict(response)
+
+                try:
+                    try:
+                        formatted_messages = extract_and_format_input(kwargs.get('input', ''))
+                        prompt = concatenate_all_contents(formatted_messages)
+                    except:
+                        prompt = kwargs.get('input', '')
+
+                    input_tokens = response_dict.get('usage').get('input_tokens')
+                    output_tokens = response_dict.get('usage').get('output_tokens')
+
+                    # Calculate cost of the operation
+                    cost = get_chat_model_cost(request_model,
+                                                pricing_info, input_tokens,
+                                                output_tokens)
+
+                    # Set base span attribues (OTel Semconv)
+                    span.set_attribute(TELEMETRY_SDK_NAME, "openlit")
+                    span.set_attribute(SemanticConvetion.GEN_AI_OPERATION,
+                                        SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT)
+                    span.set_attribute(SemanticConvetion.GEN_AI_SYSTEM,
+                                        SemanticConvetion.GEN_AI_SYSTEM_OPENAI)
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MODEL,
+                                        request_model)
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_SEED,
+                                        kwargs.get("seed", ""))
+                    span.set_attribute(SemanticConvetion.SERVER_PORT,
+                                        server_port)
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MAX_TOKENS,
+                                        kwargs.get("max_output_tokens", -1))
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_STOP_SEQUENCES,
+                                        kwargs.get("stop", []))
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_TEMPERATURE,
+                                        str(response_dict.get("temperature", 1.0)))
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_TOP_P,
+                                        str(response_dict.get("top_p", 1.0)))
+                    span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_ID,
+                                        response_dict.get("id"))
+                    span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_MODEL,
+                                        response_dict.get('model'))
+                    span.set_attribute(SemanticConvetion.GEN_AI_USAGE_INPUT_TOKENS,
+                                        input_tokens)
+                    span.set_attribute(SemanticConvetion.GEN_AI_USAGE_OUTPUT_TOKENS,
+                                        output_tokens)
+                    span.set_attribute(SemanticConvetion.SERVER_ADDRESS,
+                                        server_address)
+
+                    # Set base span attribues (Extras)
+                    span.set_attribute(DEPLOYMENT_ENVIRONMENT,
+                                        environment)
+                    span.set_attribute(SERVICE_NAME,
+                                        application_name)
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_USER,
+                                        kwargs.get("user", ""))
+                    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_IS_STREAM,
+                                        False)
+                    span.set_attribute(SemanticConvetion.GEN_AI_USAGE_TOTAL_TOKENS,
+                                        input_tokens + output_tokens)
+                    span.set_attribute(SemanticConvetion.GEN_AI_USAGE_COST,
+                                        cost)
+                    span.set_attribute(SemanticConvetion.GEN_AI_SERVER_TTFT,
+                                        end_time - start_time)
+                    span.set_attribute(SemanticConvetion.GEN_AI_SDK_VERSION,
+                                        version)
+
+                    if capture_message_content:
+                        span.add_event(
+                            name=SemanticConvetion.GEN_AI_CONTENT_PROMPT_EVENT,
+                            attributes={
+                                SemanticConvetion.GEN_AI_CONTENT_PROMPT: prompt,
+                            },
+                        )
+
+                    for i in range(kwargs.get('n',1)):
+                        span.set_attribute(SemanticConvetion.GEN_AI_RESPONSE_FINISH_REASON,
+                                           [response_dict.get('status')])
+                        try:
+                            llm_response = response_dict.get('output')[i].get('content')[0].get('text','')
+                        except:
+                            llm_response = ''
+
+                        if capture_message_content:
+                            span.add_event(
+                                name=SemanticConvetion.GEN_AI_CONTENT_COMPLETION_EVENT,
+                                attributes={
+                                    # pylint: disable=line-too-long
+                                    SemanticConvetion.GEN_AI_CONTENT_COMPLETION: llm_response,
+                                },
+                            )
+                        if kwargs.get('tools'):
+                            span.set_attribute(SemanticConvetion.GEN_AI_TOOL_CALLS,
+                                            str(response_dict.get('tools')))
+
+                        if isinstance(llm_response, str):
+                            span.set_attribute(SemanticConvetion.GEN_AI_OUTPUT_TYPE,
+                                            "text")
+                        elif llm_response is not None:
+                            span.set_attribute(SemanticConvetion.GEN_AI_OUTPUT_TYPE,
+                                            "json")
+
+                    span.set_status(Status(StatusCode.OK))
+
+                    if disable_metrics is False:
+                        attributes = create_metrics_attributes(
+                            service_name=application_name,
+                            deployment_environment=environment,
+                            operation=SemanticConvetion.GEN_AI_OPERATION_TYPE_CHAT,
+                            system=SemanticConvetion.GEN_AI_SYSTEM_OPENAI,
+                            request_model=request_model,
+                            server_address=server_address,
+                            server_port=server_port,
+                            response_model=response_dict.get('model'),
+                        )
+
+                        metrics["genai_client_usage_tokens"].record(
+                            input_tokens + output_tokens, attributes
+                        )
+                        metrics["genai_client_operation_duration"].record(
+                            end_time - start_time, attributes
+                        )
+                        metrics["genai_server_ttft"].record(
+                            end_time - start_time, attributes
+                        )
+                        metrics["genai_requests"].add(1, attributes)
+                        metrics["genai_completion_tokens"].add(output_tokens, attributes)
+                        metrics["genai_prompt_tokens"].add(input_tokens, attributes)
+                        metrics["genai_cost"].record(cost, attributes)
+
+                    # 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
+
 def chat_completions(version, environment, application_name,
                      tracer, pricing_info, capture_message_content, metrics, disable_metrics):
     """

openlit/instrumentation/openai_agents/__init__.py

@@ -0,0 +1,42 @@
+"""Initializer of Auto Instrumentation of OpenAI Agents Functions"""
+
+from typing import Collection
+import importlib.metadata
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from wrapt import wrap_function_wrapper
+
+from openlit.instrumentation.openai_agents.openai_agents import (
+    create_agent
+)
+
+_instruments = ('openai-agents >= 0.0.3',)
+
+class OpenAIAgentsInstrumentor(BaseInstrumentor):
+    """
+    An instrumentor for openai-agents's client library.
+    """
+
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
+    def _instrument(self, **kwargs):
+        application_name = kwargs.get('application_name', 'default')
+        environment = kwargs.get('environment', 'default')
+        tracer = kwargs.get('tracer')
+        event_provider = kwargs.get('event_provider')
+        metrics = kwargs.get('metrics_dict')
+        pricing_info = kwargs.get('pricing_info', {})
+        capture_message_content = kwargs.get('capture_message_content', False)
+        disable_metrics = kwargs.get('disable_metrics')
+        version = importlib.metadata.version('openai-agents')
+
+        wrap_function_wrapper(
+            'agents.agent',
+            'Agent.__init__',
+            create_agent(version, environment, application_name,
+                  tracer, event_provider, pricing_info, capture_message_content, metrics, disable_metrics),
+        )
+
+    def _uninstrument(self, **kwargs):
+        # Proper uninstrumentation logic to revert patched methods
+        pass

openlit/instrumentation/openai_agents/openai_agents.py

@@ -0,0 +1,65 @@
+"""
+Module for monitoring AG2 API calls.
+"""
+
+import logging
+from opentelemetry.trace import SpanKind, Status, StatusCode
+from opentelemetry.sdk.resources import SERVICE_NAME, TELEMETRY_SDK_NAME, DEPLOYMENT_ENVIRONMENT
+from openlit.__helpers import (
+    handle_exception,
+)
+from openlit.semcov import SemanticConvetion
+
+# Initialize logger for logging potential issues and operations
+logger = logging.getLogger(__name__)
+
+def set_span_attributes(span, version, operation_name, environment,
+        application_name, server_address, server_port, request_model):
+    """
+    Set common attributes for the span.
+    """
+
+    # Set Span attributes (OTel Semconv)
+    span.set_attribute(TELEMETRY_SDK_NAME, 'openlit')
+    span.set_attribute(SemanticConvetion.GEN_AI_OPERATION, operation_name)
+    span.set_attribute(SemanticConvetion.GEN_AI_SYSTEM, SemanticConvetion.GEN_AI_SYSTEM_AG2)
+    span.set_attribute(SemanticConvetion.SERVER_ADDRESS, server_address)
+    span.set_attribute(SemanticConvetion.SERVER_PORT, server_port)
+    span.set_attribute(SemanticConvetion.GEN_AI_REQUEST_MODEL, request_model)
+
+    # Set Span attributes (Extras)
+    span.set_attribute(DEPLOYMENT_ENVIRONMENT, environment)
+    span.set_attribute(SERVICE_NAME, application_name)
+    span.set_attribute(SemanticConvetion.GEN_AI_SDK_VERSION, version)
+
+def create_agent(version, environment, application_name,
+                      tracer, event_provider, pricing_info, capture_message_content, metrics, disable_metrics):
+    """
+    Generates a telemetry wrapper for GenAI function call
+    """
+    def wrapper(wrapped, instance, args, kwargs):
+        server_address, server_port = '127.0.0.1', 80
+
+        agent_name = kwargs.get('name', 'openai_agent')
+        span_name = f'{SemanticConvetion.GEN_AI_OPERATION_TYPE_CREATE_AGENT} {agent_name}'
+
+        with tracer.start_as_current_span(span_name, kind=SpanKind.CLIENT) as span:
+            try:
+                response = wrapped(*args, **kwargs)
+
+                set_span_attributes(span, version, SemanticConvetion.GEN_AI_OPERATION_TYPE_CREATE_AGENT,
+                    environment, application_name, server_address, server_port, kwargs.get('model', 'gpt-4o'))
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_NAME, agent_name)
+
+                span.set_attribute(SemanticConvetion.GEN_AI_AGENT_DESCRIPTION, kwargs.get('instructions', ''))
+
+                span.set_status(Status(StatusCode.OK))
+
+                return response
+
+            except Exception as e:
+                handle_exception(span, e)
+                logger.error('Error in trace creation: %s', e)
+                return response
+
+    return wrapper

{openlit-1.33.15.dist-info → openlit-1.33.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openlit
-Version: 1.33.15
+Version: 1.33.16
 Summary: OpenTelemetry-native Auto instrumentation library for monitoring LLM Applications and GPUs, facilitating the integration of observability into your GenAI-driven projects
 License: Apache-2.0
 Keywords: OpenTelemetry,otel,otlp,llm,tracing,openai,anthropic,claude,cohere,llm monitoring,observability,monitoring,gpt,Generative AI,chatGPT,gpu

{openlit-1.33.15.dist-info → openlit-1.33.16.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openlit/__helpers.py,sha256=9K9nz_RunwtnFeAk591uOJZiY3J88HsYv7T2H8elHWA,10262
-openlit/__init__.py,sha256=87uE_wi6YF2FKkmVy0VLmRKeNMuJ9e6XrycIbad9T6A,23755
+openlit/__init__.py,sha256=iHGwg8XB2DhNVCktU3FLFqubAOiQVQCp1F7L7OHp6cg,23921
 openlit/evals/__init__.py,sha256=nJe99nuLo1b5rf7pt9U9BCdSDedzbVi2Fj96cgl7msM,380
 openlit/evals/all.py,sha256=oWrue3PotE-rB5WePG3MRYSA-ro6WivkclSHjYlAqGs,7154
 openlit/evals/bias_detection.py,sha256=mCdsfK7x1vX7S3psC3g641IMlZ-7df3h-V6eiICj5N8,8154
@@ -92,9 +92,11 @@ openlit/instrumentation/ollama/__init__.py,sha256=JjxSqEegmRoRqIVz7ZAq9dLyXPZ2Dq
 openlit/instrumentation/ollama/async_ollama.py,sha256=LhDQPy3wLyNO9JWksUEeCx-DK9oIV3K98Cgwnp4RfKg,6538
 openlit/instrumentation/ollama/ollama.py,sha256=wVyaX0quoiiCj1J3tyTiQx5Du5CmaWmt9e_lpCr7s6A,6434
 openlit/instrumentation/ollama/utils.py,sha256=zXsWNqfnZLssrcb-GNbWeZeqTKVzQb1bes8vzgl-gbQ,14549
-openlit/instrumentation/openai/__init__.py,sha256=dfgMBHd2wAT24uckVBBqTy7pzN34ESzeymKzkUy6t58,4893
-openlit/instrumentation/openai/async_openai.py,sha256=DtY26K-mNXqVAIGb_md3V3nVnGzNDn82anw9qzA3RKo,50500
-openlit/instrumentation/openai/openai.py,sha256=79ydZrzRDd_44_3WtZ7U68I3HMvTkKysKglyMhjPcNQ,50334
+openlit/instrumentation/openai/__init__.py,sha256=FiL4OHDhs957spa3k9sNC_VLt0-txtwbnujQwnevQ5I,5564
+openlit/instrumentation/openai/async_openai.py,sha256=AMievEMil486B9ibV0Nm54xkxAiHA-XzWWKAGQ4himI,71523
+openlit/instrumentation/openai/openai.py,sha256=d-I-RyJMNcz1m0vdkEW-l6G0WaUNCavT9BvB_EGEFYg,71266
+openlit/instrumentation/openai_agents/__init__.py,sha256=tRTSIrUtkXc_lfQnVanXmQLd2Sy9RqBNTHF5FhhZx7o,1530
+openlit/instrumentation/openai_agents/openai_agents.py,sha256=teVgsn7lIKCGPmdl9RrgPavhdcCXjh3vMeGKskrd2vo,2666
 openlit/instrumentation/phidata/__init__.py,sha256=tqls5-UI6FzbjxYgq_qqAfALhWJm8dHn2NtgqiQA4f8,1557
 openlit/instrumentation/phidata/phidata.py,sha256=-BU_g3FpGcttOt-W-QIER5qquCRORob2UFLdaOW3F_s,4819
 openlit/instrumentation/pinecone/__init__.py,sha256=0guSEPmObaZiOF8yHExpOGY-qW_egHXfZGog3rKGi8M,2596
@@ -121,7 +123,7 @@ openlit/otel/events.py,sha256=VrMjTpvnLtYRBHCiFwJojTQqqNpRCxoD4yJYeQrtPsk,3560
 openlit/otel/metrics.py,sha256=Iwx6baEiCZPNqsFf92K5mDWU8are8DOF0uQAuNZsCKg,6826
 openlit/otel/tracing.py,sha256=tjV2bEbEDPUB1Z46gE-UsJsb04sRdFrfbhIDkxViZc0,3103
 openlit/semcov/__init__.py,sha256=lM0Y3wMYYmCvfcNGD3k0xSn1XZUiGw-bKgCuwcGsOp8,13302
-openlit-1.33.15.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openlit-1.33.15.dist-info/METADATA,sha256=U42XXpGEvUd110xDAVzIqGDJMhOOBjiN75b7ICXifjo,23471
-openlit-1.33.15.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-openlit-1.33.15.dist-info/RECORD,,
+openlit-1.33.16.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openlit-1.33.16.dist-info/METADATA,sha256=epse0c3md_EmHgIFIkCpRBNK2xUk7t_e-gQ9O7fyJDY,23471
+openlit-1.33.16.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+openlit-1.33.16.dist-info/RECORD,,