opentelemetry-instrumentation-openai 0.33.12__py3-none-any.whl → 0.34.0__py3-none-any.whl

opentelemetry/instrumentation/openai/__init__.py

@@ -23,6 +23,7 @@ class OpenAIInstrumentor(BaseInstrumentor):
         upload_base64_image: Optional[
             Callable[[str, str, str, str], Coroutine[None, None, str]]
         ] = lambda *args: "",
+        enable_trace_context_propagation: bool = True,
     ):
         super().__init__()
         Config.enrich_assistant = enrich_assistant
@@ -30,6 +31,7 @@ class OpenAIInstrumentor(BaseInstrumentor):
         Config.exception_logger = exception_logger
         Config.get_common_metrics_attributes = get_common_metrics_attributes
         Config.upload_base64_image = upload_base64_image
+        Config.enable_trace_context_propagation = enable_trace_context_propagation
 
     def instrumentation_dependencies(self) -> Collection[str]:
         return _instruments

opentelemetry/instrumentation/openai/shared/__init__.py

@@ -7,6 +7,8 @@ import logging
 from importlib.metadata import version
 
 from opentelemetry import context as context_api
+from opentelemetry.trace.propagation import set_span_in_context
+from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
 
 from opentelemetry.instrumentation.openai.shared.config import Config
 from opentelemetry.semconv_ai import SpanAttributes
@@ -289,3 +291,10 @@ def metric_shared_attributes(
         "server.address": server_address,
         "stream": is_streaming,
     }
+
+
+def propagate_trace_context(span, kwargs):
+    extra_headers = kwargs.get("extra_headers", {})
+    ctx = set_span_in_context(span)
+    TraceContextTextMapPropagator().inject(extra_headers, context=ctx)
+    kwargs["extra_headers"] = extra_headers

opentelemetry/instrumentation/openai/shared/chat_wrappers.py

@@ -37,6 +37,7 @@ from opentelemetry.instrumentation.openai.shared import (
     should_record_stream_token_usage,
     get_token_count_from_string,
     _set_span_stream_usage,
+    propagate_trace_context,
 )
 from opentelemetry.trace import SpanKind, Tracer
 from opentelemetry.trace.status import Status, StatusCode
@@ -246,6 +247,8 @@ async def _handle_request(span, kwargs, instance):
             _set_functions_attributes(span, kwargs.get("functions"))
         elif kwargs.get("tools"):
             set_tools_attributes(span, kwargs.get("tools"))
+    if Config.enable_trace_context_propagation:
+        propagate_trace_context(span, kwargs)
 
 
 @dont_throw

opentelemetry/instrumentation/openai/shared/completion_wrappers.py

@@ -22,6 +22,7 @@ from opentelemetry.instrumentation.openai.shared import (
     should_record_stream_token_usage,
     get_token_count_from_string,
     _set_span_stream_usage,
+    propagate_trace_context,
 )
 
 from opentelemetry.instrumentation.openai.utils import is_openai_v1
@@ -29,6 +30,8 @@ from opentelemetry.instrumentation.openai.utils import is_openai_v1
 from opentelemetry.trace import SpanKind
 from opentelemetry.trace.status import Status, StatusCode
 
+from opentelemetry.instrumentation.openai.shared.config import Config
+
 SPAN_NAME = "openai.completion"
 LLM_REQUEST_TYPE = LLMRequestTypeValues.COMPLETION
 
@@ -95,6 +98,8 @@ def _handle_request(span, kwargs, instance):
         _set_prompts(span, kwargs.get("prompt"))
         _set_functions_attributes(span, kwargs.get("functions"))
     _set_client_attributes(span, instance)
+    if Config.enable_trace_context_propagation:
+        propagate_trace_context(span, kwargs)
 
 
 @dont_throw

opentelemetry/instrumentation/openai/shared/config.py

@@ -7,3 +7,4 @@ class Config:
     exception_logger = None
     get_common_metrics_attributes: Callable[[], dict] = lambda: {}
     upload_base64_image: Callable[[str, str, str], str] = lambda trace_id, span_id, base64_image_url: str
+    enable_trace_context_propagation: bool = True

opentelemetry/instrumentation/openai/shared/embeddings_wrappers.py

@@ -26,8 +26,11 @@ from opentelemetry.instrumentation.openai.shared import (
     model_as_dict,
     _get_openai_base_url,
     OPENAI_LLM_USAGE_TOKEN_TYPES,
+    propagate_trace_context,
 )
 
+from opentelemetry.instrumentation.openai.shared.config import Config
+
 from opentelemetry.instrumentation.openai.utils import is_openai_v1
 
 from opentelemetry.trace import SpanKind
@@ -161,6 +164,8 @@ def _handle_request(span, kwargs, instance):
     if should_send_prompts():
         _set_prompts(span, kwargs.get("input"))
     _set_client_attributes(span, instance)
+    if Config.enable_trace_context_propagation:
+        propagate_trace_context(span, kwargs)
 
 
 @dont_throw

opentelemetry/instrumentation/openai/v1/assistant_wrappers.py

@@ -46,11 +46,13 @@ def runs_create_wrapper(tracer, wrapped, instance, args, kwargs):
     instructions = kwargs.get("instructions")
 
     response = wrapped(*args, **kwargs)
+    response_dict = model_as_dict(response)
 
     runs[thread_id] = {
         "start_time": time.time_ns(),
         "assistant_id": kwargs.get("assistant_id"),
         "instructions": instructions,
+        "run_id": response_dict.get("id"),
     }
 
     return response
@@ -66,13 +68,15 @@ def runs_retrieve_wrapper(tracer, wrapped, instance, args, kwargs):
             parsed_response = response
         assert type(parsed_response) is Run
 
-        if parsed_response.id in runs:
+        if parsed_response.thread_id in runs:
+            thread_id = parsed_response.thread_id
             runs[thread_id]["end_time"] = time.time_ns()
+            if parsed_response.usage:
+                runs[thread_id]["usage"] = parsed_response.usage
 
     if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
         return wrapped(*args, **kwargs)
 
-    thread_id = kwargs.get("thread_id")
     response = wrapped(*args, **kwargs)
     process_response(response)
 
@@ -112,6 +116,11 @@ def messages_list_wrapper(tracer, wrapped, instance, args, kwargs):
         else:
             assistant = assistants[run["assistant_id"]]
 
+        _set_span_attribute(
+            span,
+            SpanAttributes.LLM_SYSTEM,
+            "openai",
+        )
         _set_span_attribute(
             span,
             SpanAttributes.LLM_REQUEST_MODEL,
@@ -143,6 +152,19 @@ def messages_list_wrapper(tracer, wrapped, instance, args, kwargs):
             span, f"{prefix}.content", content[0].get("text").get("value")
         )
 
+    if run.get("usage"):
+        usage_dict = model_as_dict(run.get("usage"))
+        _set_span_attribute(
+            span,
+            SpanAttributes.LLM_USAGE_COMPLETION_TOKENS,
+            usage_dict.get("completion_tokens"),
+        )
+        _set_span_attribute(
+            span,
+            SpanAttributes.LLM_USAGE_PROMPT_TOKENS,
+            usage_dict.get("prompt_tokens"),
+        )
+
     span.end(run.get("end_time"))
 
     return response
@@ -175,6 +197,11 @@ def runs_create_and_stream_wrapper(tracer, wrapped, instance, args, kwargs):
         _set_span_attribute(
             span, SpanAttributes.LLM_REQUEST_MODEL, assistants[assistant_id]["model"]
         )
+        _set_span_attribute(
+            span,
+            SpanAttributes.LLM_SYSTEM,
+            "openai",
+        )
         _set_span_attribute(
             span,
             SpanAttributes.LLM_RESPONSE_MODEL,

opentelemetry/instrumentation/openai/v1/event_handler_wrapper.py

@@ -9,6 +9,8 @@ from typing_extensions import override
 class EventHandleWrapper(AssistantEventHandler):
 
     _current_text_index = 0
+    _prompt_tokens = 0
+    _completion_tokens = 0
 
     def __init__(self, original_handler, span):
         super().__init__()
@@ -17,6 +19,16 @@ class EventHandleWrapper(AssistantEventHandler):
 
     @override
     def on_end(self):
+        _set_span_attribute(
+            self._span,
+            SpanAttributes.LLM_USAGE_PROMPT_TOKENS,
+            self._prompt_tokens,
+        )
+        _set_span_attribute(
+            self._span,
+            SpanAttributes.LLM_USAGE_COMPLETION_TOKENS,
+            self._completion_tokens,
+        )
         self._original_handler.on_end()
         self._span.end()
 
@@ -34,6 +46,9 @@ class EventHandleWrapper(AssistantEventHandler):
 
     @override
     def on_run_step_done(self, run_step):
+        if run_step.usage:
+            self._prompt_tokens += run_step.usage.prompt_tokens
+            self._completion_tokens += run_step.usage.completion_tokens
         self._original_handler.on_run_step_done(run_step)
 
     @override

opentelemetry/instrumentation/openai/version.py

@@ -1 +1 @@
-__version__ = "0.33.12"
+__version__ = "0.34.0"

{opentelemetry_instrumentation_openai-0.33.12.dist-info → opentelemetry_instrumentation_openai-0.34.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opentelemetry-instrumentation-openai
-Version: 0.33.12
+Version: 0.34.0
 Summary: OpenTelemetry OpenAI instrumentation
 Home-page: https://github.com/traceloop/openllmetry/tree/main/packages/opentelemetry-instrumentation-openai
 License: Apache-2.0
@@ -16,8 +16,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: instruments
 Requires-Dist: opentelemetry-api (>=1.28.0,<2.0.0)
-Requires-Dist: opentelemetry-instrumentation (>=0.49b0,<0.50)
-Requires-Dist: opentelemetry-semantic-conventions (>=0.49b0,<0.50)
+Requires-Dist: opentelemetry-instrumentation (>=0.50b0)
+Requires-Dist: opentelemetry-semantic-conventions (>=0.50b0)
 Requires-Dist: opentelemetry-semantic-conventions-ai (==0.4.2)
 Requires-Dist: tiktoken (>=0.6.0,<1)
 Project-URL: Repository, https://github.com/traceloop/openllmetry/tree/main/packages/opentelemetry-instrumentation-openai

opentelemetry_instrumentation_openai-0.34.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+opentelemetry/instrumentation/openai/__init__.py,sha256=ly0ZPoOTAVRo1f0EeKfyTWj8_HLna3kZfIo9GWgUJk4,1888
+opentelemetry/instrumentation/openai/shared/__init__.py,sha256=HQ2qOn8fiinyUbbN55EO3aP8c33cM5IaWJ886bGiJac,9291
+opentelemetry/instrumentation/openai/shared/chat_wrappers.py,sha256=FiVCibvVkU1f6602HOaHodU9N95EDFOAKxmND3zhC2s,28241
+opentelemetry/instrumentation/openai/shared/completion_wrappers.py,sha256=P066vEEjc3tKNrnIPXi7Inc56mVhmJl5xEz1fG_vW-I,7037
+opentelemetry/instrumentation/openai/shared/config.py,sha256=dCQviJ1a5cpFlrP0HcKgE7lpiXB98ssnumLy_CIMibQ,355
+opentelemetry/instrumentation/openai/shared/embeddings_wrappers.py,sha256=ROnTujsXOrO3YVcXiV5Z-IifeuXbPOBrdqa3Ym6IDwI,7263
+opentelemetry/instrumentation/openai/shared/image_gen_wrappers.py,sha256=A4qdJIeJdA45SfiLaFj3Vo0Ndcqqfuew1BDsGdnJU3E,2122
+opentelemetry/instrumentation/openai/utils.py,sha256=KCxCpos2-rmIucUdwzbqbJINhs65I4TKo1DGRN-3kGU,4051
+opentelemetry/instrumentation/openai/v0/__init__.py,sha256=02-bXv0aZbscMYO2W3jsHpjU521vkVK5RzdfSeGXBzg,5475
+opentelemetry/instrumentation/openai/v1/__init__.py,sha256=B2Ut0X14KQS5in_0jLBMCvXQK73SqBy2rBFIDk5ZRkc,8688
+opentelemetry/instrumentation/openai/v1/assistant_wrappers.py,sha256=PxMeM5ikB0iedev95nDA5PunNLVme8oFsFhoKu3ipQc,7115
+opentelemetry/instrumentation/openai/v1/event_handler_wrapper.py,sha256=nEdavNRw5mY__PnarGoaszG24BjRC8BqDYNrtLFc6cs,3296
+opentelemetry/instrumentation/openai/version.py,sha256=7wgjZxPxspP87CI4mDkFQuldkKgENXO5FaPiS8EXM88,23
+opentelemetry_instrumentation_openai-0.34.0.dist-info/METADATA,sha256=0vlL4CsOqFWRuKEfgyX0JVIclMyWcs4PQ-rRfcYoKnI,2294
+opentelemetry_instrumentation_openai-0.34.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+opentelemetry_instrumentation_openai-0.34.0.dist-info/entry_points.txt,sha256=vTBfiX5yXji5YHikuJHEOoBZ1TFdPQ1EI4ctd2pZSeE,93
+opentelemetry_instrumentation_openai-0.34.0.dist-info/RECORD,,

opentelemetry_instrumentation_openai-0.33.12.dist-info/RECORD

@@ -1,17 +0,0 @@
-opentelemetry/instrumentation/openai/__init__.py,sha256=ZNytfy9PeGr-O4qkyCQLtANukfPlnOEynsXJ_5L75oU,1750
-opentelemetry/instrumentation/openai/shared/__init__.py,sha256=YEkV9inSBiQlPCjpkcJJdyPdDZlgNgEEs5ZPzx_boNI,8892
-opentelemetry/instrumentation/openai/shared/chat_wrappers.py,sha256=YR-yz2T9QiINfVYb0w-aftrOCoVXwKFD_fkPtcsaG8U,28118
-opentelemetry/instrumentation/openai/shared/completion_wrappers.py,sha256=CZngvHkGtLUh-Ne4uzM6VH8LiajZsKVOV1glhmSwij0,6843
-opentelemetry/instrumentation/openai/shared/config.py,sha256=86mItW37lxSAyD8LAx4RbYWTR_-XKLeGxQgMozD5eNY,305
-opentelemetry/instrumentation/openai/shared/embeddings_wrappers.py,sha256=YI0lFGulaE8N2F1hdTGHj52kHwUy6KQPIt7Lw9AWJHc,7069
-opentelemetry/instrumentation/openai/shared/image_gen_wrappers.py,sha256=A4qdJIeJdA45SfiLaFj3Vo0Ndcqqfuew1BDsGdnJU3E,2122
-opentelemetry/instrumentation/openai/utils.py,sha256=KCxCpos2-rmIucUdwzbqbJINhs65I4TKo1DGRN-3kGU,4051
-opentelemetry/instrumentation/openai/v0/__init__.py,sha256=02-bXv0aZbscMYO2W3jsHpjU521vkVK5RzdfSeGXBzg,5475
-opentelemetry/instrumentation/openai/v1/__init__.py,sha256=B2Ut0X14KQS5in_0jLBMCvXQK73SqBy2rBFIDk5ZRkc,8688
-opentelemetry/instrumentation/openai/v1/assistant_wrappers.py,sha256=BMiZykQ3u2xrWpo2g3qZOxTJqy317JXRGO4zCVu4bZ8,6277
-opentelemetry/instrumentation/openai/v1/event_handler_wrapper.py,sha256=kXOuDAt7If23EhWpH2r6L0eUVFvVWQBYrWGu3qJNKR0,2779
-opentelemetry/instrumentation/openai/version.py,sha256=DwXc1CSXuMVWYoH7D0uXZo6zdiqQEvGMIXRuPrODlkk,24
-opentelemetry_instrumentation_openai-0.33.12.dist-info/METADATA,sha256=JUgQp20k68mmsCmubIG6GB2Fu9ixBuPFvBhNYBZAt6E,2307
-opentelemetry_instrumentation_openai-0.33.12.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-opentelemetry_instrumentation_openai-0.33.12.dist-info/entry_points.txt,sha256=vTBfiX5yXji5YHikuJHEOoBZ1TFdPQ1EI4ctd2pZSeE,93
-opentelemetry_instrumentation_openai-0.33.12.dist-info/RECORD,,