opentelemetry-instrumentation-openai 0.24.0__py3-none-any.whl → 0.25.1__py3-none-any.whl

opentelemetry/instrumentation/openai/__init__.py

@@ -1,4 +1,4 @@
-from typing import Collection
+from typing import Callable, Collection
 
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 
@@ -18,11 +18,13 @@ class OpenAIInstrumentor(BaseInstrumentor):
         enrich_assistant: bool = False,
         enrich_token_usage: bool = False,
         exception_logger=None,
+        get_common_metrics_attributes: Callable[[], dict] = lambda: {},
     ):
         super().__init__()
         Config.enrich_assistant = enrich_assistant
         Config.enrich_token_usage = enrich_token_usage
         Config.exception_logger = exception_logger
+        Config.get_common_metrics_attributes = get_common_metrics_attributes
 
     def instrumentation_dependencies(self) -> Collection[str]:
         return _instruments

opentelemetry/instrumentation/openai/shared/__init__.py

@@ -8,6 +8,7 @@ from importlib.metadata import version
 
 from opentelemetry import context as context_api
 
+from opentelemetry.instrumentation.openai.shared.config import Config
 from opentelemetry.semconv.ai import SpanAttributes
 from opentelemetry.instrumentation.openai.utils import (
     dont_throw,
@@ -256,10 +257,13 @@ def _token_type(token_type: str):
     return None
 
 
-def _metric_shared_attributes(
+def metric_shared_attributes(
     response_model: str, operation: str, server_address: str, is_streaming: bool = False
 ):
+    attributes = Config.get_common_metrics_attributes()
+
     return {
+        **attributes,
         SpanAttributes.LLM_SYSTEM: "openai",
         SpanAttributes.LLM_RESPONSE_MODEL: response_model,
         "gen_ai.operation.name": operation,

opentelemetry/instrumentation/openai/shared/chat_wrappers.py

@@ -1,12 +1,17 @@
 import json
 import logging
 import time
+from opentelemetry.instrumentation.openai.shared.config import Config
 from wrapt import ObjectProxy
 
 
 from opentelemetry import context as context_api
 from opentelemetry.metrics import Counter, Histogram
-from opentelemetry.semconv.ai import SpanAttributes, LLMRequestTypeValues
+from opentelemetry.semconv.ai import (
+    SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY,
+    SpanAttributes,
+    LLMRequestTypeValues,
+)
 
 from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
 from opentelemetry.instrumentation.openai.utils import (
@@ -14,7 +19,7 @@ from opentelemetry.instrumentation.openai.utils import (
     dont_throw,
 )
 from opentelemetry.instrumentation.openai.shared import (
-    _metric_shared_attributes,
+    metric_shared_attributes,
     _set_client_attributes,
     _set_request_attributes,
     _set_span_attribute,
@@ -56,7 +61,9 @@ def chat_wrapper(
     args,
     kwargs,
 ):
-    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY) or context_api.get_value(
+        SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY
+    ):
         return wrapped(*args, **kwargs)
 
     # span needs to be opened and closed manually because the response is a generator
@@ -146,7 +153,9 @@ async def achat_wrapper(
     args,
     kwargs,
 ):
-    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY) or context_api.get_value(
+        SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY
+    ):
         return wrapped(*args, **kwargs)
 
     span = tracer.start_span(
@@ -164,7 +173,9 @@ async def achat_wrapper(
         end_time = time.time()
         duration = end_time - start_time if "start_time" in locals() else 0
 
+        common_attributes = Config.get_common_metrics_attributes()
         attributes = {
+            **common_attributes,
             "error.type": e.__class__.__name__,
         }
 
@@ -269,7 +280,7 @@ def _handle_response(
 def _set_chat_metrics(
     instance, token_counter, choice_counter, duration_histogram, response_dict, duration
 ):
-    shared_attributes = _metric_shared_attributes(
+    shared_attributes = metric_shared_attributes(
         response_model=response_dict.get("model") or None,
         operation="chat",
         server_address=_get_openai_base_url(instance),
@@ -546,7 +557,7 @@ class ChatStream(ObjectProxy):
         _accumulate_stream_items(item, self._complete_response)
 
     def _shared_attributes(self):
-        return _metric_shared_attributes(
+        return metric_shared_attributes(
             response_model=self._complete_response.get("model")
             or self._request_kwargs.get("model")
             or None,

opentelemetry/instrumentation/openai/shared/completion_wrappers.py

@@ -2,7 +2,11 @@ import logging
 
 from opentelemetry import context as context_api
 
-from opentelemetry.semconv.ai import SpanAttributes, LLMRequestTypeValues
+from opentelemetry.semconv.ai import (
+    SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY,
+    SpanAttributes,
+    LLMRequestTypeValues,
+)
 
 from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
 from opentelemetry.instrumentation.openai.utils import _with_tracer_wrapper, dont_throw
@@ -33,7 +37,9 @@ logger = logging.getLogger(__name__)
 
 @_with_tracer_wrapper
 def completion_wrapper(tracer, wrapped, instance, args, kwargs):
-    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY) or context_api.get_value(
+        SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY
+    ):
         return wrapped(*args, **kwargs)
 
     # span needs to be opened and closed manually because the response is a generator
@@ -58,7 +64,9 @@ def completion_wrapper(tracer, wrapped, instance, args, kwargs):
 
 @_with_tracer_wrapper
 async def acompletion_wrapper(tracer, wrapped, instance, args, kwargs):
-    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY) or context_api.get_value(
+        SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY
+    ):
         return wrapped(*args, **kwargs)
 
     span = tracer.start_span(

opentelemetry/instrumentation/openai/shared/config.py

@@ -1,4 +1,8 @@
+from typing import Callable
+
+
 class Config:
     enrich_token_usage = False
     enrich_assistant = False
     exception_logger = None
+    get_common_metrics_attributes: Callable[[], dict] = lambda: {}

opentelemetry/instrumentation/openai/shared/embeddings_wrappers.py

@@ -3,7 +3,11 @@ import time
 
 from opentelemetry import context as context_api
 from opentelemetry.metrics import Counter, Histogram
-from opentelemetry.semconv.ai import SpanAttributes, LLMRequestTypeValues
+from opentelemetry.semconv.ai import (
+    SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY,
+    SpanAttributes,
+    LLMRequestTypeValues,
+)
 
 from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
 from opentelemetry.instrumentation.openai.utils import (
@@ -12,7 +16,7 @@ from opentelemetry.instrumentation.openai.utils import (
     _with_embeddings_telemetry_wrapper,
 )
 from opentelemetry.instrumentation.openai.shared import (
-    _metric_shared_attributes,
+    metric_shared_attributes,
     _set_client_attributes,
     _set_request_attributes,
     _set_span_attribute,
@@ -46,7 +50,9 @@ def embeddings_wrapper(
     args,
     kwargs,
 ):
-    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY) or context_api.get_value(
+        SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY
+    ):
         return wrapped(*args, **kwargs)
 
     with tracer.start_as_current_span(
@@ -103,7 +109,9 @@ async def aembeddings_wrapper(
     args,
     kwargs,
 ):
-    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY) or context_api.get_value(
+        SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY
+    ):
         return wrapped(*args, **kwargs)
 
     async with start_as_current_span_async(
@@ -190,7 +198,7 @@ def _set_embeddings_metrics(
     response_dict,
     duration,
 ):
-    shared_attributes = _metric_shared_attributes(
+    shared_attributes = metric_shared_attributes(
         response_model=response_dict.get("model") or None,
         operation="embeddings",
         server_address=_get_openai_base_url(instance),

opentelemetry/instrumentation/openai/shared/image_gen_wrappers.py

@@ -4,7 +4,7 @@ from opentelemetry import context as context_api
 from opentelemetry.instrumentation.openai import is_openai_v1
 from opentelemetry.instrumentation.openai.shared import (
     _get_openai_base_url,
-    _metric_shared_attributes,
+    metric_shared_attributes,
     model_as_dict,
 )
 from opentelemetry.instrumentation.openai.utils import (
@@ -12,6 +12,7 @@ from opentelemetry.instrumentation.openai.utils import (
 )
 from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
 from opentelemetry.metrics import Counter, Histogram
+from opentelemetry.semconv.ai import SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY
 
 
 @_with_image_gen_metric_wrapper
@@ -23,7 +24,9 @@ def image_gen_metrics_wrapper(
     args,
     kwargs,
 ):
-    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+    if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY) or context_api.get_value(
+        SUPPRESS_LANGUAGE_MODEL_INSTRUMENTATION_KEY
+    ):
         return wrapped(*args, **kwargs)
 
     try:
@@ -52,7 +55,7 @@ def image_gen_metrics_wrapper(
         response_dict = response
 
     # not provide response.model in ImagesResponse response, use model in request kwargs
-    shared_attributes = _metric_shared_attributes(
+    shared_attributes = metric_shared_attributes(
         response_model=kwargs.get("model") or None,
         operation="image_gen",
         server_address=_get_openai_base_url(instance),

opentelemetry/instrumentation/openai/version.py

@@ -1 +1 @@
-__version__ = "0.24.0"
+__version__ = "0.25.1"

{opentelemetry_instrumentation_openai-0.24.0.dist-info → opentelemetry_instrumentation_openai-0.25.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opentelemetry-instrumentation-openai
-Version: 0.24.0
+Version: 0.25.1
 Summary: OpenTelemetry OpenAI instrumentation
 Home-page: https://github.com/traceloop/openllmetry/tree/main/packages/opentelemetry-instrumentation-openai
 License: Apache-2.0
@@ -17,7 +17,7 @@ Provides-Extra: instruments
 Requires-Dist: opentelemetry-api (>=1.25.0,<2.0.0)
 Requires-Dist: opentelemetry-instrumentation (>=0.46b0,<0.47)
 Requires-Dist: opentelemetry-semantic-conventions (>=0.46b0,<0.47)
-Requires-Dist: opentelemetry-semantic-conventions-ai (==0.3.3)
+Requires-Dist: opentelemetry-semantic-conventions-ai (==0.3.4)
 Requires-Dist: tiktoken (>=0.6.0,<1)
 Project-URL: Repository, https://github.com/traceloop/openllmetry/tree/main/packages/opentelemetry-instrumentation-openai
 Description-Content-Type: text/markdown

opentelemetry_instrumentation_openai-0.25.1.dist-info/RECORD

@@ -0,0 +1,17 @@
+opentelemetry/instrumentation/openai/__init__.py,sha256=w0gjgORccQ3EsMiK2dzZg6V7J3pa6PcAuDvy1oofQ5A,1503
+opentelemetry/instrumentation/openai/shared/__init__.py,sha256=U6_JB0RXrK6XK2Xhm450RtgHhZT1qMMSDSLtHjc57mY,8224
+opentelemetry/instrumentation/openai/shared/chat_wrappers.py,sha256=Oy4LGQGY4_khL9_wPBHm1DwU8NwleZw7dUAPc61cAXs,25471
+opentelemetry/instrumentation/openai/shared/completion_wrappers.py,sha256=UnygloMuP0udgMAE0ic6NJUVAqJ1CJKT-YjSe_9Ds0g,6834
+opentelemetry/instrumentation/openai/shared/config.py,sha256=_4AkHau8C44uBc6-fNBl9EzCGPBuj9yDIngTuwSW6ZE,199
+opentelemetry/instrumentation/openai/shared/embeddings_wrappers.py,sha256=FvOKk8FzEJV01bUKqH-dwWe0k5DRhhpCG99ah4AUyUQ,6924
+opentelemetry/instrumentation/openai/shared/image_gen_wrappers.py,sha256=GFgBqTiMcJFUmwKwkHDGpsnM3UXw_UJLBSVcxLbbr9Q,2122
+opentelemetry/instrumentation/openai/utils.py,sha256=3ONjsia3xG4rRMOwjU91liOVpZxoRE39CxJ-C5HxIgQ,3464
+opentelemetry/instrumentation/openai/v0/__init__.py,sha256=FYq3xhtaIdvy7mwCPzxaqNNGzfHEi0Q2JFQl51s6yNo,5475
+opentelemetry/instrumentation/openai/v1/__init__.py,sha256=wDO1rjgeZRNVXXA3IJUdqYVXRsvst7_JTtAjBK-m1Gc,7693
+opentelemetry/instrumentation/openai/v1/assistant_wrappers.py,sha256=4BDLcqOfwl0LFUdAjLE_PgRcWsQYKoCM_okWLCU8A9U,6277
+opentelemetry/instrumentation/openai/v1/event_handler_wrapper.py,sha256=SAzYoun2yyOloofyOWtxpm8E2M9TL3Nm8TgKdNyXHuY,2779
+opentelemetry/instrumentation/openai/version.py,sha256=ACu2Z3Q3TFgYpAno_eu9ssJ1QULjNXvjGvyqDSHrQ_o,23
+opentelemetry_instrumentation_openai-0.25.1.dist-info/METADATA,sha256=k9Wos9c9FrnzFQzDB0YGRoGO235q4F8HaZj7fg_An9k,2255
+opentelemetry_instrumentation_openai-0.25.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+opentelemetry_instrumentation_openai-0.25.1.dist-info/entry_points.txt,sha256=vTBfiX5yXji5YHikuJHEOoBZ1TFdPQ1EI4ctd2pZSeE,93
+opentelemetry_instrumentation_openai-0.25.1.dist-info/RECORD,,

opentelemetry_instrumentation_openai-0.24.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-opentelemetry/instrumentation/openai/__init__.py,sha256=xl3Kvqry9glVhu8VtdknfUE9FpXQ7KWAFqtVlpjE-40,1344
-opentelemetry/instrumentation/openai/shared/__init__.py,sha256=vRPcdI_4Tseg7mBYRrDdWzRcnec3vZeC2tPYpLlT2Xc,8076
-opentelemetry/instrumentation/openai/shared/chat_wrappers.py,sha256=kUXkZhCwgZSD9UIuls22nSijrJu_J_esdIXnyPV3Avc,25074
-opentelemetry/instrumentation/openai/shared/completion_wrappers.py,sha256=-JHfgyxic5I3Wr3Uc_L-U7ztDVFcyovtF37tNLtaW3s,6604
-opentelemetry/instrumentation/openai/shared/config.py,sha256=5uekQEnmYo1o6tsTD2IGc-cVmHUo5KmUC4pOVdrFFNk,102
-opentelemetry/instrumentation/openai/shared/embeddings_wrappers.py,sha256=gzKmjwI7xhGUUDiIxwuyvSH-YDCTIaa0dXECpPc_vaY,6696
-opentelemetry/instrumentation/openai/shared/image_gen_wrappers.py,sha256=uREeAWW0xsCsyCDLVMj3LVbHtP5vlm74uVIpZT3YKzc,1959
-opentelemetry/instrumentation/openai/utils.py,sha256=3ONjsia3xG4rRMOwjU91liOVpZxoRE39CxJ-C5HxIgQ,3464
-opentelemetry/instrumentation/openai/v0/__init__.py,sha256=FYq3xhtaIdvy7mwCPzxaqNNGzfHEi0Q2JFQl51s6yNo,5475
-opentelemetry/instrumentation/openai/v1/__init__.py,sha256=wDO1rjgeZRNVXXA3IJUdqYVXRsvst7_JTtAjBK-m1Gc,7693
-opentelemetry/instrumentation/openai/v1/assistant_wrappers.py,sha256=4BDLcqOfwl0LFUdAjLE_PgRcWsQYKoCM_okWLCU8A9U,6277
-opentelemetry/instrumentation/openai/v1/event_handler_wrapper.py,sha256=SAzYoun2yyOloofyOWtxpm8E2M9TL3Nm8TgKdNyXHuY,2779
-opentelemetry/instrumentation/openai/version.py,sha256=DxtMZD542lg_xb6icrE2d5JOY8oUi-v34i2Ar63ddvs,23
-opentelemetry_instrumentation_openai-0.24.0.dist-info/METADATA,sha256=L5fXqUJ0zfCQCdgXyDoWkYt6ISc2njm562DlTmHfgqs,2255
-opentelemetry_instrumentation_openai-0.24.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-opentelemetry_instrumentation_openai-0.24.0.dist-info/entry_points.txt,sha256=vTBfiX5yXji5YHikuJHEOoBZ1TFdPQ1EI4ctd2pZSeE,93
-opentelemetry_instrumentation_openai-0.24.0.dist-info/RECORD,,