openlit 1.34.29__py3-none-any.whl → 1.34.31__py3-none-any.whl

openlit/instrumentation/premai/__init__.py

@@ -5,12 +5,11 @@ import importlib.metadata
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from wrapt import wrap_function_wrapper
 
-from openlit.instrumentation.premai.premai import (
-    chat, embedding
-)
+from openlit.instrumentation.premai.premai import chat, embedding
 
 _instruments = ("premai >= 0.3.79",)
 
+
 class PremAIInstrumentor(BaseInstrumentor):
     """
     An instrumentor for Prem AI's client library.
@@ -33,16 +32,32 @@ class PremAIInstrumentor(BaseInstrumentor):
         wrap_function_wrapper(
             "premai.api",
             "ChatCompletionsModule.create",
-            chat(version, environment, application_name,
-                  tracer, pricing_info, capture_message_content, metrics, disable_metrics),
+            chat(
+                version,
+                environment,
+                application_name,
+                tracer,
+                pricing_info,
+                capture_message_content,
+                metrics,
+                disable_metrics,
+            ),
         )
 
         # sync embedding
         wrap_function_wrapper(
             "premai.api",
             "EmbeddingsModule.create",
-            embedding(version, environment, application_name,
-                  tracer, pricing_info, capture_message_content, metrics, disable_metrics),
+            embedding(
+                version,
+                environment,
+                application_name,
+                tracer,
+                pricing_info,
+                capture_message_content,
+                metrics,
+                disable_metrics,
+            ),
         )
 
     def _uninstrument(self, **kwargs):

openlit/instrumentation/premai/premai.py

@@ -4,20 +4,26 @@ Module for monitoring PremAI API calls.
 
 import time
 from opentelemetry.trace import SpanKind
-from openlit.__helpers import (
-    handle_exception,
-    set_server_address_and_port
-)
+from openlit.__helpers import handle_exception, set_server_address_and_port
 from openlit.instrumentation.premai.utils import (
     process_chat_response,
     process_chunk,
     process_streaming_chat_response,
-    process_embedding_response
+    process_embedding_response,
 )
 from openlit.semcov import SemanticConvention
 
-def chat(version, environment, application_name,
-    tracer, pricing_info, capture_message_content, metrics, disable_metrics):
+
+def chat(
+    version,
+    environment,
+    application_name,
+    tracer,
+    pricing_info,
+    capture_message_content,
+    metrics,
+    disable_metrics,
+):
     """
     Generates a telemetry wrapper for GenAI function call
     """
@@ -28,15 +34,15 @@ def chat(version, environment, application_name,
         """
 
         def __init__(
-                self,
-                wrapped,
-                span,
-                span_name,
-                kwargs,
-                server_address,
-                server_port,
-                **args,
-            ):
+            self,
+            wrapped,
+            span,
+            span_name,
+            kwargs,
+            server_address,
+            server_port,
+            **args,
+        ):
             self.__wrapped__ = wrapped
             self._span = span
             self._span_name = span_name
@@ -75,7 +81,9 @@ def chat(version, environment, application_name,
 
             finally:
                 try:
-                    with tracer.start_as_current_span(self._span_name, kind=SpanKind.CLIENT) as self._span:
+                    with tracer.start_as_current_span(
+                        self._span_name, kind=SpanKind.CLIENT
+                    ) as self._span:
                         process_streaming_chat_response(
                             self,
                             pricing_info=pricing_info,
@@ -84,7 +92,7 @@ def chat(version, environment, application_name,
                             metrics=metrics,
                             capture_message_content=capture_message_content,
                             disable_metrics=disable_metrics,
-                            version=version
+                            version=version,
                         )
 
                 except Exception as e:
@@ -98,7 +106,9 @@ def chat(version, environment, application_name,
         # Check if streaming is enabled for the API call
         streaming = kwargs.get("stream", False)
 
-        server_address, server_port = set_server_address_and_port(instance, "app.premai.io", 443)
+        server_address, server_port = set_server_address_and_port(
+            instance, "app.premai.io", 443
+        )
         request_model = kwargs.get("model", "gpt-4o-mini")
 
         span_name = f"{SemanticConvention.GEN_AI_OPERATION_TYPE_CHAT} {request_model}"
@@ -107,7 +117,9 @@ def chat(version, environment, application_name,
             # 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, span_name, kwargs, server_address, server_port)
+            return TracedSyncStream(
+                awaited_wrapped, span, span_name, kwargs, server_address, server_port
+            )
 
         # Handling for non-streaming responses
         else:
@@ -130,7 +142,7 @@ def chat(version, environment, application_name,
                         capture_message_content=capture_message_content,
                         disable_metrics=disable_metrics,
                         version=version,
-                        **kwargs
+                        **kwargs,
                     )
 
                 except Exception as e:
@@ -140,8 +152,17 @@ def chat(version, environment, application_name,
 
     return wrapper
 
-def embedding(version, environment, application_name,
-    tracer, pricing_info, capture_message_content, metrics, disable_metrics):
+
+def embedding(
+    version,
+    environment,
+    application_name,
+    tracer,
+    pricing_info,
+    capture_message_content,
+    metrics,
+    disable_metrics,
+):
     """
     Generates a telemetry wrapper for GenAI function call
     """
@@ -151,10 +172,14 @@ def embedding(version, environment, application_name,
         Wraps the GenAI function call.
         """
 
-        server_address, server_port = set_server_address_and_port(instance, "app.premai.io", 443)
+        server_address, server_port = set_server_address_and_port(
+            instance, "app.premai.io", 443
+        )
         request_model = kwargs.get("model", "text-embedding-ada-002")
 
-        span_name = f"{SemanticConvention.GEN_AI_OPERATION_TYPE_EMBEDDING} {request_model}"
+        span_name = (
+            f"{SemanticConvention.GEN_AI_OPERATION_TYPE_EMBEDDING} {request_model}"
+        )
 
         with tracer.start_as_current_span(span_name, kind=SpanKind.CLIENT) as span:
             start_time = time.time()
@@ -175,7 +200,7 @@ def embedding(version, environment, application_name,
                     capture_message_content=capture_message_content,
                     disable_metrics=disable_metrics,
                     version=version,
-                    **kwargs
+                    **kwargs,
                 )
 
             except Exception as e:

openlit/instrumentation/premai/utils.py

@@ -1,6 +1,7 @@
 """
 PremAI OpenTelemetry instrumentation utility functions
 """
+
 import time
 
 from opentelemetry.trace import Status, StatusCode
@@ -18,6 +19,7 @@ from openlit.__helpers import (
 )
 from openlit.semcov import SemanticConvention
 
+
 def format_content(messages):
     """
     Process a list of messages to extract content.
@@ -30,8 +32,9 @@ def format_content(messages):
 
         if isinstance(content, list):
             content_str = ", ".join(
-                f'{item["type"]}: {item["text"] if "text" in item else item["image_url"]}'
-                if "type" in item else f'text: {item["text"]}'
+                f"{item['type']}: {item['text'] if 'text' in item else item['image_url']}"
+                if "type" in item
+                else f"text: {item['text']}"
                 for item in content
             )
             formatted_messages.append(f"{role}: {content_str}")
@@ -40,6 +43,7 @@ def format_content(messages):
 
     return "\n".join(formatted_messages)
 
+
 def process_chunk(scope, chunk):
     """
     Process a chunk of response data and update state.
@@ -67,8 +71,18 @@ def process_chunk(scope, chunk):
         scope._response_model = chunked.get("model")
         scope._end_time = time.time()
 
-def common_chat_logic(scope, pricing_info, environment, application_name, metrics,
-    capture_message_content, disable_metrics, version, is_stream):
+
+def common_chat_logic(
+    scope,
+    pricing_info,
+    environment,
+    application_name,
+    metrics,
+    capture_message_content,
+    disable_metrics,
+    version,
+    is_stream,
+):
     """
     Process chat request and generate Telemetry
     """
@@ -90,40 +104,91 @@ def common_chat_logic(scope, pricing_info, environment, application_name, metric
     cost = get_chat_model_cost(request_model, pricing_info, input_tokens, output_tokens)
 
     # Common Span Attributes
-    common_span_attributes(scope,
-        SemanticConvention.GEN_AI_OPERATION_TYPE_CHAT,SemanticConvention.GEN_AI_SYSTEM_PREMAI,
-        scope._server_address, scope._server_port, request_model, scope._response_model,
-        environment, application_name, is_stream, scope._tbt, scope._ttft, version)
+    common_span_attributes(
+        scope,
+        SemanticConvention.GEN_AI_OPERATION_TYPE_CHAT,
+        SemanticConvention.GEN_AI_SYSTEM_PREMAI,
+        scope._server_address,
+        scope._server_port,
+        request_model,
+        scope._response_model,
+        environment,
+        application_name,
+        is_stream,
+        scope._tbt,
+        scope._ttft,
+        version,
+    )
 
     # Span Attributes for Response parameters
-    scope._span.set_attribute(SemanticConvention.GEN_AI_RESPONSE_FINISH_REASON, [scope._finish_reason])
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_SEED, scope._kwargs.get("seed", ""))
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_FREQUENCY_PENALTY, scope._kwargs.get("frequency_penalty", 0.0))
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_MAX_TOKENS, scope._kwargs.get("max_tokens", -1))
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_PRESENCE_PENALTY, scope._kwargs.get("presence_penalty", 0.0))
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_STOP_SEQUENCES, scope._kwargs.get("stop", []))
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_TEMPERATURE, scope._kwargs.get("temperature", 1.0))
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_TOP_P, scope._kwargs.get("top_p", 1.0))
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_USER, scope._kwargs.get("user", ""))
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_RESPONSE_FINISH_REASON, [scope._finish_reason]
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_SEED, scope._kwargs.get("seed", "")
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_FREQUENCY_PENALTY,
+        scope._kwargs.get("frequency_penalty", 0.0),
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_MAX_TOKENS,
+        scope._kwargs.get("max_tokens", -1),
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_PRESENCE_PENALTY,
+        scope._kwargs.get("presence_penalty", 0.0),
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_STOP_SEQUENCES, scope._kwargs.get("stop", [])
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_TEMPERATURE,
+        scope._kwargs.get("temperature", 1.0),
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_TOP_P, scope._kwargs.get("top_p", 1.0)
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_USER, scope._kwargs.get("user", "")
+    )
     scope._span.set_attribute(SemanticConvention.GEN_AI_RESPONSE_ID, scope._response_id)
-    scope._span.set_attribute(SemanticConvention.GEN_AI_OUTPUT_TYPE, "text" if isinstance(scope._llmresponse, str) else "json")
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_OUTPUT_TYPE,
+        "text" if isinstance(scope._llmresponse, str) else "json",
+    )
 
     # Span Attributes for Cost and Tokens
-    scope._span.set_attribute(SemanticConvention.GEN_AI_USAGE_INPUT_TOKENS, input_tokens)
-    scope._span.set_attribute(SemanticConvention.GEN_AI_USAGE_OUTPUT_TOKENS, output_tokens)
-    scope._span.set_attribute(SemanticConvention.GEN_AI_CLIENT_TOKEN_USAGE, input_tokens + output_tokens)
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_USAGE_INPUT_TOKENS, input_tokens
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_USAGE_OUTPUT_TOKENS, output_tokens
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_CLIENT_TOKEN_USAGE, input_tokens + output_tokens
+    )
     scope._span.set_attribute(SemanticConvention.GEN_AI_USAGE_COST, cost)
 
     # Span Attributes for Tools
     if scope._tools:
-        scope._span.set_attribute(SemanticConvention.GEN_AI_TOOL_NAME, scope._tools.get("function","")).get("name","")
-        scope._span.set_attribute(SemanticConvention.GEN_AI_TOOL_CALL_ID, str(scope._tools.get("id","")))
-        scope._span.set_attribute(SemanticConvention.GEN_AI_TOOL_ARGS, str(scope._tools.get("function","").get("arguments","")))
+        scope._span.set_attribute(
+            SemanticConvention.GEN_AI_TOOL_NAME, scope._tools.get("function", "")
+        ).get("name", "")
+        scope._span.set_attribute(
+            SemanticConvention.GEN_AI_TOOL_CALL_ID, str(scope._tools.get("id", ""))
+        )
+        scope._span.set_attribute(
+            SemanticConvention.GEN_AI_TOOL_ARGS,
+            str(scope._tools.get("function", "").get("arguments", "")),
+        )
 
     # Span Attributes for Content
     if capture_message_content:
         scope._span.set_attribute(SemanticConvention.GEN_AI_CONTENT_PROMPT, prompt)
-        scope._span.set_attribute(SemanticConvention.GEN_AI_CONTENT_COMPLETION, scope._llmresponse)
+        scope._span.set_attribute(
+            SemanticConvention.GEN_AI_CONTENT_COMPLETION, scope._llmresponse
+        )
 
         # To be removed one the change to span_attributes (from span events) is complete
         scope._span.add_event(
@@ -143,13 +208,36 @@ def common_chat_logic(scope, pricing_info, environment, application_name, metric
 
     # Metrics
     if not disable_metrics:
-        record_completion_metrics(metrics, SemanticConvention.GEN_AI_OPERATION_TYPE_CHAT, SemanticConvention.GEN_AI_SYSTEM_PREMAI,
-            scope._server_address, scope._server_port, request_model, scope._response_model, environment,
-            application_name, scope._start_time, scope._end_time, input_tokens, output_tokens,
-            cost, scope._tbt, scope._ttft)
+        record_completion_metrics(
+            metrics,
+            SemanticConvention.GEN_AI_OPERATION_TYPE_CHAT,
+            SemanticConvention.GEN_AI_SYSTEM_PREMAI,
+            scope._server_address,
+            scope._server_port,
+            request_model,
+            scope._response_model,
+            environment,
+            application_name,
+            scope._start_time,
+            scope._end_time,
+            input_tokens,
+            output_tokens,
+            cost,
+            scope._tbt,
+            scope._ttft,
+        )
+
 
-def common_embedding_logic(scope, pricing_info, environment, application_name, metrics,
-    capture_message_content, disable_metrics, version):
+def common_embedding_logic(
+    scope,
+    pricing_info,
+    environment,
+    application_name,
+    metrics,
+    capture_message_content,
+    disable_metrics,
+    version,
+):
     """
     Process embedding request and generate Telemetry
     """
@@ -159,16 +247,36 @@ def common_embedding_logic(scope, pricing_info, environment, application_name, m
     cost = get_embed_model_cost(request_model, pricing_info, scope._input_tokens)
 
     # Common Span Attributes
-    common_span_attributes(scope,
-        SemanticConvention.GEN_AI_OPERATION_TYPE_EMBEDDING, SemanticConvention.GEN_AI_SYSTEM_PREMAI,
-        scope._server_address, scope._server_port, request_model, scope._response_model,
-        environment, application_name, False, scope._tbt, scope._ttft, version)
+    common_span_attributes(
+        scope,
+        SemanticConvention.GEN_AI_OPERATION_TYPE_EMBEDDING,
+        SemanticConvention.GEN_AI_SYSTEM_PREMAI,
+        scope._server_address,
+        scope._server_port,
+        request_model,
+        scope._response_model,
+        environment,
+        application_name,
+        False,
+        scope._tbt,
+        scope._ttft,
+        version,
+    )
 
     # Embedding-specific span attributes
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_ENCODING_FORMATS, [scope._kwargs.get("encoding_format", "float")])
-    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_USER, scope._kwargs.get("user", ""))
-    scope._span.set_attribute(SemanticConvention.GEN_AI_USAGE_INPUT_TOKENS, scope._input_tokens)
-    scope._span.set_attribute(SemanticConvention.GEN_AI_CLIENT_TOKEN_USAGE, scope._input_tokens)
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_ENCODING_FORMATS,
+        [scope._kwargs.get("encoding_format", "float")],
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_REQUEST_USER, scope._kwargs.get("user", "")
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_USAGE_INPUT_TOKENS, scope._input_tokens
+    )
+    scope._span.set_attribute(
+        SemanticConvention.GEN_AI_CLIENT_TOKEN_USAGE, scope._input_tokens
+    )
     scope._span.set_attribute(SemanticConvention.GEN_AI_USAGE_COST, cost)
 
     # Span Attributes for Content
@@ -176,7 +284,9 @@ def common_embedding_logic(scope, pricing_info, environment, application_name, m
         scope._span.add_event(
             name=SemanticConvention.GEN_AI_CONTENT_PROMPT_EVENT,
             attributes={
-                SemanticConvention.GEN_AI_CONTENT_PROMPT: str(scope._kwargs.get("input", "")),
+                SemanticConvention.GEN_AI_CONTENT_PROMPT: str(
+                    scope._kwargs.get("input", "")
+                ),
             },
         )
 
@@ -184,21 +294,65 @@ def common_embedding_logic(scope, pricing_info, environment, application_name, m
 
     # Metrics
     if not disable_metrics:
-        record_embedding_metrics(metrics, SemanticConvention.GEN_AI_OPERATION_TYPE_EMBEDDING, SemanticConvention.GEN_AI_SYSTEM_PREMAI,
-            scope._server_address, scope._server_port, request_model, scope._response_model, environment,
-            application_name, scope._start_time, scope._end_time, scope._input_tokens, cost)
+        record_embedding_metrics(
+            metrics,
+            SemanticConvention.GEN_AI_OPERATION_TYPE_EMBEDDING,
+            SemanticConvention.GEN_AI_SYSTEM_PREMAI,
+            scope._server_address,
+            scope._server_port,
+            request_model,
+            scope._response_model,
+            environment,
+            application_name,
+            scope._start_time,
+            scope._end_time,
+            scope._input_tokens,
+            cost,
+        )
 
-def process_streaming_chat_response(scope, pricing_info, environment, application_name, metrics,
-    capture_message_content=False, disable_metrics=False, version=""):
+
+def process_streaming_chat_response(
+    scope,
+    pricing_info,
+    environment,
+    application_name,
+    metrics,
+    capture_message_content=False,
+    disable_metrics=False,
+    version="",
+):
     """
     Process chat request and generate Telemetry
     """
-    common_chat_logic(scope, pricing_info, environment, application_name, metrics,
-        capture_message_content, disable_metrics, version, is_stream=True)
-
-def process_chat_response(response, request_model, pricing_info, server_port, server_address,
-    environment, application_name, metrics, start_time, span, capture_message_content=False,
-    disable_metrics=False, version="1.0.0", **kwargs):
+    common_chat_logic(
+        scope,
+        pricing_info,
+        environment,
+        application_name,
+        metrics,
+        capture_message_content,
+        disable_metrics,
+        version,
+        is_stream=True,
+    )
+
+
+def process_chat_response(
+    response,
+    request_model,
+    pricing_info,
+    server_port,
+    server_address,
+    environment,
+    application_name,
+    metrics,
+    start_time,
+    span,
+    capture_message_content=False,
+    disable_metrics=False,
+    version="1.0.0",
+    **kwargs,
+):
     """
     Process chat request and generate Telemetry
     """
@@ -209,7 +363,9 @@ def process_chat_response(response, request_model, pricing_info, server_port, se
     scope._start_time = start_time
     scope._end_time = time.time()
     scope._span = span
-    scope._llmresponse = str(response_dict.get("choices")[0].get("message").get("content"))
+    scope._llmresponse = str(
+        response_dict.get("choices")[0].get("message").get("content")
+    )
     scope._response_id = response_dict.get("additional_properties", {}).get("id")
     scope._response_model = response_dict.get("model")
     scope._input_tokens = response_dict.get("usage").get("prompt_tokens")
@@ -225,14 +381,37 @@ def process_chat_response(response, request_model, pricing_info, server_port, se
     else:
         scope._tools = None
 
-    common_chat_logic(scope, pricing_info, environment, application_name, metrics,
-        capture_message_content, disable_metrics, version, is_stream=False)
+    common_chat_logic(
+        scope,
+        pricing_info,
+        environment,
+        application_name,
+        metrics,
+        capture_message_content,
+        disable_metrics,
+        version,
+        is_stream=False,
+    )
 
     return response
 
-def process_embedding_response(response, request_model, pricing_info, server_port, server_address,
-    environment, application_name, metrics, start_time, span, capture_message_content=False,
-    disable_metrics=False, version="1.0.0", **kwargs):
+
+def process_embedding_response(
+    response,
+    request_model,
+    pricing_info,
+    server_port,
+    server_address,
+    environment,
+    application_name,
+    metrics,
+    start_time,
+    span,
+    capture_message_content=False,
+    disable_metrics=False,
+    version="1.0.0",
+    **kwargs,
+):
     """
     Process embedding request and generate Telemetry
     """
@@ -250,7 +429,15 @@ def process_embedding_response(response, request_model, pricing_info, server_por
     scope._server_address, scope._server_port = server_address, server_port
     scope._kwargs = kwargs
 
-    common_embedding_logic(scope, pricing_info, environment, application_name, metrics,
-        capture_message_content, disable_metrics, version)
+    common_embedding_logic(
+        scope,
+        pricing_info,
+        environment,
+        application_name,
+        metrics,
+        capture_message_content,
+        disable_metrics,
+        version,
+    )
 
     return response