openlit 1.34.7__py3-none-any.whl → 1.34.10__py3-none-any.whl

openlit/instrumentation/gpt4all/utils.py

@@ -0,0 +1,281 @@
+"""
+GPT4All OpenTelemetry instrumentation utility functions
+"""
+import time
+
+from opentelemetry.sdk.resources import SERVICE_NAME, TELEMETRY_SDK_NAME, DEPLOYMENT_ENVIRONMENT
+from opentelemetry.trace import Status, StatusCode
+
+from openlit.__helpers import (
+    calculate_ttft,
+    calculate_tbt,
+    general_tokens,
+    create_metrics_attributes,
+    get_chat_model_cost,
+    get_embed_model_cost,
+)
+from openlit.semcov import SemanticConvention
+
+def format_content(prompt):
+    """
+    Process a prompt to extract content.
+    """
+    return str(prompt) if prompt else ""
+
+def process_chunk(scope, chunk):
+    """
+    Process a chunk of response data and update state.
+    """
+
+    end_time = time.time()
+    # Record the timestamp for the current chunk
+    scope._timestamps.append(end_time)
+
+    if len(scope._timestamps) == 1:
+        # Calculate time to first chunk
+        scope._ttft = calculate_ttft(scope._timestamps, scope._start_time)
+
+    scope._llmresponse += chunk
+    scope._end_time = time.time()
+
+def common_span_attributes(scope, gen_ai_operation, gen_ai_system, server_address, server_port,
+    request_model, response_model, environment, application_name, is_stream, tbt, ttft, version):
+    """
+    Set common span attributes for both generate and embed operations.
+    """
+
+    scope._span.set_attribute(TELEMETRY_SDK_NAME, "openlit")
+    scope._span.set_attribute(SemanticConvention.GEN_AI_OPERATION, gen_ai_operation)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_SYSTEM, gen_ai_system)
+    scope._span.set_attribute(SemanticConvention.SERVER_ADDRESS, server_address)
+    scope._span.set_attribute(SemanticConvention.SERVER_PORT, server_port)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_MODEL, request_model)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_RESPONSE_MODEL, response_model)
+    scope._span.set_attribute(DEPLOYMENT_ENVIRONMENT, environment)
+    scope._span.set_attribute(SERVICE_NAME, application_name)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_IS_STREAM, is_stream)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_SERVER_TBT, tbt)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_SERVER_TTFT, ttft)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_SDK_VERSION, version)
+
+def record_completion_metrics(metrics, gen_ai_operation, gen_ai_system, server_address, server_port,
+    request_model, response_model, environment, application_name, start_time, end_time,
+    input_tokens, output_tokens, cost, tbt=None, ttft=None):
+    """
+    Record completion-specific metrics for the operation.
+    """
+
+    attributes = create_metrics_attributes(
+        operation=gen_ai_operation,
+        system=gen_ai_system,
+        server_address=server_address,
+        server_port=server_port,
+        request_model=request_model,
+        response_model=response_model,
+        service_name=application_name,
+        deployment_environment=environment,
+    )
+    metrics["genai_client_operation_duration"].record(end_time - start_time, attributes)
+    metrics["genai_requests"].add(1, attributes)
+    metrics["genai_prompt_tokens"].add(input_tokens, attributes)
+    metrics["genai_completion_tokens"].add(output_tokens, attributes)
+    metrics["genai_client_usage_tokens"].record(input_tokens + output_tokens, attributes)
+    metrics["genai_cost"].record(cost, attributes)
+    if tbt is not None:
+        metrics["genai_server_tbt"].record(tbt, attributes)
+    if ttft is not None:
+        metrics["genai_server_ttft"].record(ttft, attributes)
+
+def record_embedding_metrics(metrics, gen_ai_operation, gen_ai_system, server_address, server_port,
+    request_model, response_model, environment, application_name, start_time, end_time,
+    input_tokens, cost):
+    """
+    Record embedding-specific metrics for the operation.
+    """
+
+    attributes = create_metrics_attributes(
+        operation=gen_ai_operation,
+        system=gen_ai_system,
+        server_address=server_address,
+        server_port=server_port,
+        request_model=request_model,
+        response_model=response_model,
+        service_name=application_name,
+        deployment_environment=environment,
+    )
+    metrics["genai_client_usage_tokens"].record(input_tokens, attributes)
+    metrics["genai_client_operation_duration"].record(end_time - start_time, attributes)
+    metrics["genai_requests"].add(1, attributes)
+    metrics["genai_prompt_tokens"].add(input_tokens, attributes)
+    metrics["genai_cost"].record(cost, attributes)
+
+def common_t2s_logic(scope, pricing_info, environment, application_name, metrics,
+    capture_message_content, disable_metrics, version, is_stream):
+    """
+    Process generate request and generate Telemetry
+    """
+
+    if len(scope._timestamps) > 1:
+        scope._tbt = calculate_tbt(scope._timestamps)
+
+    prompt = format_content(scope._kwargs.get("prompt") or (scope._args[0] if scope._args else "") or "")
+    request_model = scope._request_model
+
+    # Calculate tokens using input prompt and aggregated response
+    input_tokens = general_tokens(prompt)
+    output_tokens = general_tokens(scope._llmresponse)
+
+    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_GPT4ALL,
+        scope._server_address, scope._server_port, request_model, request_model,
+        environment, application_name, is_stream, scope._tbt, scope._ttft, version)
+
+    # Span Attributes for Request parameters
+    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_FREQUENCY_PENALTY, scope._kwargs.get("repeat_penalty", 1.18))
+    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_MAX_TOKENS, scope._kwargs.get("max_tokens", 200))
+    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_TEMPERATURE, scope._kwargs.get("temp", 0.7))
+    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_TOP_P, scope._kwargs.get("top_p", 0.4))
+    scope._span.set_attribute(SemanticConvention.GEN_AI_REQUEST_TOP_K, scope._kwargs.get("top_k", 40))
+    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_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","")))
+
+    # 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)
+
+        # To be removed one the change to span_attributes (from span events) is complete
+        scope._span.add_event(
+            name=SemanticConvention.GEN_AI_CONTENT_PROMPT_EVENT,
+            attributes={
+                SemanticConvention.GEN_AI_CONTENT_PROMPT: prompt,
+            },
+        )
+        scope._span.add_event(
+            name=SemanticConvention.GEN_AI_CONTENT_COMPLETION_EVENT,
+            attributes={
+                SemanticConvention.GEN_AI_CONTENT_COMPLETION: scope._llmresponse,
+            },
+        )
+
+    scope._span.set_status(Status(StatusCode.OK))
+
+    # Metrics
+    if not disable_metrics:
+        record_completion_metrics(metrics, SemanticConvention.GEN_AI_OPERATION_TYPE_CHAT, SemanticConvention.GEN_AI_SYSTEM_GPT4ALL,
+            scope._server_address, scope._server_port, request_model, request_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):
+    """
+    Process embedding request and generate Telemetry
+    """
+
+    prompt = format_content(scope._kwargs.get("text") or "")
+    request_model = scope._request_model
+
+    input_tokens = general_tokens(prompt)
+
+    cost = get_embed_model_cost(request_model, pricing_info, input_tokens)
+
+    # Common Span Attributes
+    common_span_attributes(scope,
+        SemanticConvention.GEN_AI_OPERATION_TYPE_EMBEDDING, SemanticConvention.GEN_AI_SYSTEM_GPT4ALL,
+        scope._server_address, scope._server_port, request_model, request_model,
+        environment, application_name, False, scope._tbt, scope._ttft, version)
+
+    # Embedding-specific span attributes
+    scope._span.set_attribute(SemanticConvention.GEN_AI_USAGE_INPUT_TOKENS, input_tokens)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_CLIENT_TOKEN_USAGE, input_tokens)
+    scope._span.set_attribute(SemanticConvention.GEN_AI_USAGE_COST, cost)
+
+    # Span Attributes for Content
+    if capture_message_content:
+        scope._span.add_event(
+            name=SemanticConvention.GEN_AI_CONTENT_PROMPT_EVENT,
+            attributes={
+                SemanticConvention.GEN_AI_CONTENT_PROMPT: str(scope._kwargs.get("input", "")),
+            },
+        )
+
+    scope._span.set_status(Status(StatusCode.OK))
+
+    # Metrics
+    if not disable_metrics:
+        record_embedding_metrics(metrics, SemanticConvention.GEN_AI_OPERATION_TYPE_EMBEDDING, SemanticConvention.GEN_AI_SYSTEM_GPT4ALL,
+            scope._server_address, scope._server_port, request_model, request_model, environment,
+            application_name, scope._start_time, scope._end_time, input_tokens, cost)
+
+def process_streaming_generate_response(scope, pricing_info, environment, application_name, metrics,
+    capture_message_content=False, disable_metrics=False, version=""):
+    """
+    Process generate request and generate Telemetry
+    """
+    common_t2s_logic(scope, pricing_info, environment, application_name, metrics,
+        capture_message_content, disable_metrics, version, is_stream=True)
+
+def process_generate_response(response, request_model, pricing_info, server_port, server_address,
+    environment, application_name, metrics, start_time, span, args, kwargs, capture_message_content=False,
+    disable_metrics=False, version="1.0.0"):
+    """
+    Process generate request and generate Telemetry
+    """
+
+    scope = type("GenericScope", (), {})()
+
+    scope._start_time = start_time
+    scope._end_time = time.time()
+    scope._span = span
+    scope._llmresponse = str(response)
+    scope._request_model = request_model
+    scope._timestamps = []
+    scope._ttft, scope._tbt = scope._end_time - scope._start_time, 0
+    scope._server_address, scope._server_port = server_address, server_port
+    scope._kwargs = kwargs
+    scope._args = args
+    scope._tools = None
+
+    common_t2s_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):
+    """
+    Process embedding request and generate Telemetry
+    """
+
+    scope = type("GenericScope", (), {})()
+
+    scope._start_time = start_time
+    scope._end_time = time.time()
+    scope._span = span
+    scope._request_model = request_model
+    scope._timestamps = []
+    scope._ttft, scope._tbt = scope._end_time - scope._start_time, 0
+    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)
+
+    return response

openlit/instrumentation/ollama/__init__.py

@@ -41,7 +41,7 @@ def _dispatch_async(async_chat_wrap, async_emb_wrap):
 
 class OllamaInstrumentor(BaseInstrumentor):
     """
-    An instrumentor for Ollama's client library.
+    An instrumentor for Ollama client library.
     """
 
     def instrumentation_dependencies(self) -> Collection[str]:
@@ -51,7 +51,6 @@ class OllamaInstrumentor(BaseInstrumentor):
         application_name = kwargs.get("application_name", "default_application")
         environment = kwargs.get("environment", "default_environment")
         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)
@@ -61,22 +60,22 @@ class OllamaInstrumentor(BaseInstrumentor):
         # Build wrapper factories for chat and embeddings
         sync_chat_wrap = chat(
             version, environment, application_name,
-            tracer, event_provider, pricing_info,
+            tracer, pricing_info,
             capture_message_content, metrics, disable_metrics
         )
         sync_emb_wrap = embeddings(
             version, environment, application_name,
-            tracer, event_provider, pricing_info,
+            tracer, pricing_info,
             capture_message_content, metrics, disable_metrics
         )
         async_chat_wrap = async_chat(
             version, environment, application_name,
-            tracer, event_provider, pricing_info,
+            tracer, pricing_info,
             capture_message_content, metrics, disable_metrics
         )
         async_emb_wrap = async_embeddings(
             version, environment, application_name,
-            tracer, event_provider, pricing_info,
+            tracer, pricing_info,
             capture_message_content, metrics, disable_metrics
         )
 

openlit/instrumentation/ollama/async_ollama.py

@@ -2,7 +2,6 @@
 Module for monitoring Ollama API calls.
 """
 
-import logging
 import time
 from opentelemetry.trace import SpanKind
 from openlit.__helpers import (
@@ -17,12 +16,10 @@ from openlit.instrumentation.ollama.utils import (
 )
 from openlit.semcov import SemanticConvention
 
-logger = logging.getLogger(__name__)
-
 def async_chat(version, environment, application_name,
-            tracer, event_provider, pricing_info, capture_message_content, metrics, disable_metrics):
+            tracer, pricing_info, capture_message_content, metrics, disable_metrics):
     """
-    Generates a telemetry wrapper for GenAI function call
+    Generates a telemetry wrapper for Ollama async chat function call
     """
 
     class TracedAsyncStream:
@@ -38,7 +35,7 @@ def async_chat(version, environment, application_name,
                 kwargs,
                 server_address,
                 server_port,
-                **args,
+                args,
             ):
             self.__wrapped__ = wrapped
             self._span = span
@@ -48,11 +45,11 @@ def async_chat(version, environment, application_name,
             self._tool_calls = []
             self._input_tokens = 0
             self._output_tokens = 0
-            self._response_role = ''
+            self._response_role = ""
             self._span_name = span_name
             self._args = args
             self._kwargs = kwargs
-            self._start_time = time.time()
+            self._start_time = time.monotonic()
             self._end_time = None
             self._timestamps = []
             self._ttft = 0
@@ -81,56 +78,101 @@ def async_chat(version, environment, application_name,
                 return chunk
             except StopAsyncIteration:
                 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,
                             environment=environment,
                             application_name=application_name,
                             metrics=metrics,
-                            event_provider=event_provider,
                             capture_message_content=capture_message_content,
                             disable_metrics=disable_metrics,
                             version=version
                         )
                 except Exception as e:
                     handle_exception(self._span, e)
-                    logger.error("Error in trace creation: %s", e)
+
                 raise
 
     async def wrapper(wrapped, instance, args, kwargs):
         """
-        Wraps the GenAI function call.
+        Wraps the Ollama async chat function call.
         """
 
         streaming = kwargs.get("stream", False)
 
         server_address, server_port = set_server_address_and_port(instance, "127.0.0.1", 11434)
-        json_body = kwargs.get("json", {}) or {}
-        request_model = json_body.get("model") or kwargs.get("model")
+        request_model = kwargs.get("model")
 
         span_name = f"{SemanticConvention.GEN_AI_OPERATION_TYPE_CHAT} {request_model}"
 
-        # pylint: disable=no-else-return
         if streaming:
             awaited_wrapped = await wrapped(*args, **kwargs)
             span = tracer.start_span(span_name, kind=SpanKind.CLIENT)
-            return TracedAsyncStream(awaited_wrapped, span, span_name, kwargs, server_address, server_port)
+            return TracedAsyncStream(awaited_wrapped, span, span_name, kwargs, server_address, server_port, args)
 
         else:
-            with tracer.start_as_current_span(span_name, kind= SpanKind.CLIENT) as span:
-                start_time = time.time()
+            with tracer.start_as_current_span(span_name, kind=SpanKind.CLIENT) as span:
+                start_time = time.monotonic()
+
+                try:
+                    response = await wrapped(*args, **kwargs)
+
+                    response = process_chat_response(
+                        response=response,
+                        gen_ai_endpoint="ollama.chat",
+                        pricing_info=pricing_info,
+                        server_port=server_port,
+                        server_address=server_address,
+                        environment=environment,
+                        application_name=application_name,
+                        metrics=metrics,
+                        start_time=start_time,
+                        span=span,
+                        capture_message_content=capture_message_content,
+                        disable_metrics=disable_metrics,
+                        version=version,
+                        **kwargs
+                    )
+
+                except Exception as e:
+                    handle_exception(span, e)
+
+            return response
+
+    return wrapper
+
+def async_embeddings(version, environment, application_name,
+              tracer, pricing_info, capture_message_content, metrics, disable_metrics):
+    """
+    Generates a telemetry wrapper for Ollama async embeddings function call
+    """
+
+    async def wrapper(wrapped, instance, args, kwargs):
+        """
+        Wraps the Ollama async embeddings function call.
+        """
+
+        server_address, server_port = set_server_address_and_port(instance, "127.0.0.1", 11434)
+        request_model = kwargs.get("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.monotonic()
+
+            try:
                 response = await wrapped(*args, **kwargs)
-                response = process_chat_response(
+
+                response = process_embedding_response(
                     response=response,
-                    request_model=request_model,
+                    gen_ai_endpoint="ollama.embeddings",
                     pricing_info=pricing_info,
                     server_port=server_port,
                     server_address=server_address,
                     environment=environment,
                     application_name=application_name,
                     metrics=metrics,
-                    event_provider=event_provider,
                     start_time=start_time,
                     span=span,
                     capture_message_content=capture_message_content,
@@ -139,47 +181,8 @@ def async_chat(version, environment, application_name,
                     **kwargs
                 )
 
-            return response
-
-    return wrapper
-
-def async_embeddings(version, environment, application_name,
-              tracer, event_provider, pricing_info, capture_message_content, metrics, disable_metrics):
-    """
-    Generates a telemetry wrapper for GenAI function call
-    """
-
-    async def wrapper(wrapped, instance, args, kwargs):
-        """
-        Wraps the GenAI function call.
-        """
-
-        server_address, server_port = set_server_address_and_port(instance, '127.0.0.1', 11434)
-        json_body = kwargs.get('json', {}) or {}
-        request_model = json_body.get('model') or kwargs.get('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()
-            response = await wrapped(*args, **kwargs)
-            response = process_embedding_response(
-                response=response,
-                request_model=request_model,
-                pricing_info=pricing_info,
-                server_port=server_port,
-                server_address=server_address,
-                environment=environment,
-                application_name=application_name,
-                metrics=metrics,
-                event_provider=event_provider,
-                start_time=start_time,
-                span=span,
-                capture_message_content=capture_message_content,
-                disable_metrics=disable_metrics,
-                version=version,
-                **kwargs
-            )
+            except Exception as e:
+                handle_exception(span, e)
 
         return response