opentelemetry-instrumentation-openai 0.15.9__tar.gz → 0.15.11__tar.gz

{opentelemetry_instrumentation_openai-0.15.9 → opentelemetry_instrumentation_openai-0.15.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opentelemetry-instrumentation-openai
-Version: 0.15.9
+Version: 0.15.11
 Summary: OpenTelemetry OpenAI instrumentation
 Home-page: https://github.com/traceloop/openllmetry/tree/main/packages/opentelemetry-instrumentation-openai
 License: Apache-2.0

{opentelemetry_instrumentation_openai-0.15.9 → opentelemetry_instrumentation_openai-0.15.11}/opentelemetry/instrumentation/openai/shared/chat_wrappers.py

@@ -8,7 +8,6 @@ from opentelemetry.semconv.ai import SpanAttributes, LLMRequestTypeValues
 
 from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
 from opentelemetry.instrumentation.openai.utils import (
-    _with_tracer_wrapper,
     _with_chat_telemetry_wrapper,
 )
 from opentelemetry.instrumentation.openai.shared import (
@@ -95,7 +94,7 @@ def chat_wrapper(
             streaming_time_to_first_token,
             streaming_time_to_generate,
             start_time,
-            kwargs
+            kwargs,
         )
 
     duration = end_time - start_time
@@ -114,8 +113,20 @@ def chat_wrapper(
     return response
 
 
-@_with_tracer_wrapper
-async def achat_wrapper(tracer, wrapped, instance, args, kwargs):
+@_with_chat_telemetry_wrapper
+async def achat_wrapper(
+    tracer: Tracer,
+    token_counter: Counter,
+    choice_counter: Counter,
+    duration_histogram: Histogram,
+    exception_counter: Counter,
+    streaming_time_to_first_token: Histogram,
+    streaming_time_to_generate: Histogram,
+    wrapped,
+    instance,
+    args,
+    kwargs,
+):
     if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
         return wrapped(*args, **kwargs)
 
@@ -125,13 +136,52 @@ async def achat_wrapper(tracer, wrapped, instance, args, kwargs):
         attributes={SpanAttributes.LLM_REQUEST_TYPE: LLM_REQUEST_TYPE.value},
     )
     _handle_request(span, kwargs, instance)
-    response = await wrapped(*args, **kwargs)
+
+    try:
+        start_time = time.time()
+        response = await wrapped(*args, **kwargs)
+        end_time = time.time()
+    except Exception as e:  # pylint: disable=broad-except
+        end_time = time.time()
+        duration = end_time - start_time if "start_time" in locals() else 0
+
+        attributes = {
+            "error.type": e.__class__.__name__,
+        }
+
+        if duration > 0 and duration_histogram:
+            duration_histogram.record(duration, attributes=attributes)
+        if exception_counter:
+            exception_counter.add(1, attributes=attributes)
+
+        raise e
 
     if is_streaming_response(response):
         # span will be closed after the generator is done
-        return _abuild_from_streaming_response(span, response)
+        return _abuild_from_streaming_response(
+            span,
+            response,
+            instance,
+            token_counter,
+            choice_counter,
+            duration_histogram,
+            streaming_time_to_first_token,
+            streaming_time_to_generate,
+            start_time,
+            kwargs,
+        )
 
-    _handle_response(response, span)
+    duration = end_time - start_time
+
+    _handle_response(
+        response,
+        span,
+        instance,
+        token_counter,
+        choice_counter,
+        duration_histogram,
+        duration,
+    )
     span.end()
 
     return response
@@ -285,6 +335,61 @@ def _set_completions(span, choices):
             )
 
 
+def _set_streaming_token_metrics(
+    request_kwargs, complete_response, span, token_counter, shared_attributes
+):
+    # use tiktoken calculate token usage
+    if not should_record_stream_token_usage():
+        return
+
+    # kwargs={'model': 'gpt-3.5', 'messages': [{'role': 'user', 'content': '...'}], 'stream': True}
+    prompt_usage = -1
+    completion_usage = -1
+
+    # prompt_usage
+    if request_kwargs and request_kwargs.get("messages"):
+        prompt_content = ""
+        model_name = request_kwargs.get("model") or None
+        for msg in request_kwargs.get("messages"):
+            if msg.get("content"):
+                prompt_content += msg.get("content")
+        if model_name:
+            prompt_usage = get_token_count_from_string(prompt_content, model_name)
+
+    # completion_usage
+    if complete_response.get("choices"):
+        completion_content = ""
+        model_name = complete_response.get("model") or None
+
+        for choice in complete_response.get("choices"):  # type: dict
+            if choice.get("message") and choice.get("message").get("content"):
+                completion_content += choice["message"]["content"]
+
+        if model_name:
+            completion_usage = get_token_count_from_string(
+                completion_content, model_name
+            )
+
+    # span record
+    _set_span_stream_usage(span, prompt_usage, completion_usage)
+
+    # metrics record
+    if token_counter:
+        if type(prompt_usage) is int and prompt_usage >= 0:
+            attributes_with_token_type = {
+                **shared_attributes,
+                "llm.usage.token_type": "prompt",
+            }
+            token_counter.add(prompt_usage, attributes=attributes_with_token_type)
+
+        if type(completion_usage) is int and completion_usage >= 0:
+            attributes_with_token_type = {
+                **shared_attributes,
+                "llm.usage.token_type": "completion",
+            }
+            token_counter.add(completion_usage, attributes=attributes_with_token_type)
+
+
 def _build_from_streaming_response(
     span,
     response,
@@ -295,7 +400,7 @@ def _build_from_streaming_response(
     streaming_time_to_first_token=None,
     streaming_time_to_generate=None,
     start_time=None,
-    request_kwargs=None
+    request_kwargs=None,
 ):
     complete_response = {"choices": [], "model": ""}
 
@@ -322,46 +427,9 @@ def _build_from_streaming_response(
         "stream": True,
     }
 
-    # use tiktoken calculate token usage
-    if should_record_stream_token_usage():
-        # kwargs={'model': 'gpt-3.5', 'messages': [{'role': 'user', 'content': '...'}], 'stream': True}
-        prompt_usage = -1
-        completion_usage = -1
-
-        # prompt_usage
-        if request_kwargs and request_kwargs.get("messages"):
-            prompt_content = ""
-            model_name = request_kwargs.get("model") or None
-            for msg in request_kwargs.get("messages"):
-                if msg.get("content"):
-                    prompt_content += msg.get("content")
-            if model_name:
-                prompt_usage = get_token_count_from_string(prompt_content, model_name)
-
-        # completion_usage
-        if complete_response.get("choices"):
-            completion_content = ""
-            model_name = complete_response.get("model") or None
-
-            for choice in complete_response.get("choices"):  # type: dict
-                if choice.get("message") and choice.get("message").get("content"):
-                    completion_content += choice["message"]["content"]
-
-            if model_name:
-                completion_usage = get_token_count_from_string(completion_content, model_name)
-
-        # span record
-        _set_span_stream_usage(span, prompt_usage, completion_usage)
-
-        # metrics record
-        if token_counter:
-            if type(prompt_usage) is int and prompt_usage >= 0:
-                attributes_with_token_type = {**shared_attributes, "llm.usage.token_type": "prompt"}
-                token_counter.add(prompt_usage, attributes=attributes_with_token_type)
-
-            if type(completion_usage) is int and completion_usage >= 0:
-                attributes_with_token_type = {**shared_attributes, "llm.usage.token_type": "completion"}
-                token_counter.add(completion_usage, attributes=attributes_with_token_type)
+    _set_streaming_token_metrics(
+        request_kwargs, complete_response, span, token_counter, shared_attributes
+    )
 
     # choice metrics
     if choice_counter and complete_response.get("choices"):
@@ -388,14 +456,63 @@ def _build_from_streaming_response(
     span.end()
 
 
-async def _abuild_from_streaming_response(span, response):
+async def _abuild_from_streaming_response(
+    span,
+    response,
+    instance=None,
+    token_counter=None,
+    choice_counter=None,
+    duration_histogram=None,
+    streaming_time_to_first_token=None,
+    streaming_time_to_generate=None,
+    start_time=None,
+    request_kwargs=None,
+):
     complete_response = {"choices": [], "model": ""}
+
+    first_token = True
+    time_of_first_token = start_time  # will be updated when first token is received
+
     async for item in response:
+        span.add_event(name="llm.content.completion.chunk")
+
         item_to_yield = item
+
+        if first_token and streaming_time_to_first_token:
+            time_of_first_token = time.time()
+            streaming_time_to_first_token.record(time_of_first_token - start_time)
+            first_token = False
+
         _accumulate_stream_items(item, complete_response)
 
         yield item_to_yield
 
+    shared_attributes = {
+        "llm.response.model": complete_response.get("model") or None,
+        "server.address": _get_openai_base_url(instance),
+        "stream": True,
+    }
+
+    _set_streaming_token_metrics(
+        request_kwargs, complete_response, span, token_counter, shared_attributes
+    )
+
+    # choice metrics
+    if choice_counter and complete_response.get("choices"):
+        _set_choice_counter_metrics(
+            choice_counter, complete_response.get("choices"), shared_attributes
+        )
+
+    # duration metrics
+    if start_time and isinstance(start_time, (float, int)):
+        duration = time.time() - start_time
+    else:
+        duration = None
+    if duration and isinstance(duration, (float, int)) and duration_histogram:
+        duration_histogram.record(duration, attributes=shared_attributes)
+    if streaming_time_to_generate and time_of_first_token:
+        streaming_time_to_generate.record(time.time() - time_of_first_token)
+
     _set_response_attributes(span, complete_response)
 
     if should_send_prompts():

{opentelemetry_instrumentation_openai-0.15.9 → opentelemetry_instrumentation_openai-0.15.11}/opentelemetry/instrumentation/openai/v1/__init__.py

@@ -160,7 +160,15 @@ class OpenAIV1Instrumentor(BaseInstrumentor):
         wrap_function_wrapper(
             "openai.resources.chat.completions",
             "AsyncCompletions.create",
-            achat_wrapper(tracer),
+            achat_wrapper(
+                tracer,
+                chat_token_counter,
+                chat_choice_counter,
+                chat_duration_histogram,
+                chat_exception_counter,
+                streaming_time_to_first_token,
+                streaming_time_to_generate,
+            ),
         )
         wrap_function_wrapper(
             "openai.resources.completions",

opentelemetry_instrumentation_openai-0.15.11/opentelemetry/instrumentation/openai/version.py

@@ -0,0 +1 @@
+__version__ = "0.15.11"

{opentelemetry_instrumentation_openai-0.15.9 → opentelemetry_instrumentation_openai-0.15.11}/pyproject.toml

@@ -8,7 +8,7 @@ show_missing = true
 
 [tool.poetry]
 name = "opentelemetry-instrumentation-openai"
-version = "0.15.9"
+version = "0.15.11"
 description = "OpenTelemetry OpenAI instrumentation"
 authors = [
   "Gal Kleinman <gal@traceloop.com>",
@@ -34,7 +34,7 @@ autopep8 = "2.1.0"
 flake8 = "7.0.0"
 
 [tool.poetry.group.test.dependencies]
-pytest = "8.1.0"
+pytest = "8.1.1"
 pytest-sugar = "1.0.0"
 vcrpy = "^6.0.1"
 pytest-recording = "^0.13.1"

opentelemetry_instrumentation_openai-0.15.9/opentelemetry/instrumentation/openai/version.py

@@ -1 +0,0 @@
-__version__ = "0.15.9"