openlit 1.1.3__py3-none-any.whl → 1.5.0__py3-none-any.whl

openlit/instrumentation/qdrant/__init__.py

@@ -0,0 +1,155 @@
+# pylint: disable=useless-return, bad-staticmethod-argument, disable=duplicate-code
+"""Initializer of Auto Instrumentation of Qdrant Functions"""
+from typing import Collection
+import importlib.metadata
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from wrapt import wrap_function_wrapper
+
+from openlit.instrumentation.qdrant.qdrant import general_wrap
+
+_instruments = ("qdrant-client >= 1.9.0",)
+
+WRAPPED_METHODS = [
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.create_collection",
+        "endpoint": "qdrant.create_collection",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.delete_collection",
+        "endpoint": "qdrant.delete_collection",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.update_collection",
+        "endpoint": "qdrant.update_collection",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.upload_collection",
+        "endpoint": "qdrant.upload_collection",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.upsert",
+        "endpoint": "qdrant.upsert",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.set_payload",
+        "endpoint": "qdrant.set_payload",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.overwrite_payload",
+        "endpoint": "qdrant.overwrite_payload",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.clear_payload",
+        "endpoint": "qdrant.clear_payload",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.delete_payload",
+        "endpoint": "qdrant.delete_payload",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.upload_points",
+        "endpoint": "qdrant.upload_points",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.update_vectors",
+        "endpoint": "qdrant.update_vectors",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.delete_vectors",
+        "endpoint": "qdrant.delete_vectors",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.delete",
+        "endpoint": "qdrant.delete",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.retrieve",
+        "endpoint": "qdrant.retrieve",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.scroll",
+        "endpoint": "qdrant.scroll",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.search",
+        "endpoint": "qdrant.search",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "qdrant_client",
+        "object": "QdrantClient.search_groups",
+        "endpoint": "qdrant.search_groups",
+        "wrapper": general_wrap,
+    },
+    {
+
+        "package": "qdrant_client",
+        "object": "QdrantClient.recommend",
+        "endpoint": "qdrant.recommend",
+        "wrapper": general_wrap,
+    }
+]
+
+class QdrantInstrumentor(BaseInstrumentor):
+    """An instrumentor for Qdrant's client library."""
+
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
+    def _instrument(self, **kwargs):
+        application_name = kwargs.get("application_name")
+        environment = kwargs.get("environment")
+        tracer = kwargs.get("tracer")
+        metrics = kwargs.get("metrics_dict")
+        pricing_info = kwargs.get("pricing_info")
+        trace_content = kwargs.get("trace_content")
+        disable_metrics = kwargs.get("disable_metrics")
+        version = importlib.metadata.version("qdrant-client")
+
+        for wrapped_method in WRAPPED_METHODS:
+            wrap_package = wrapped_method.get("package")
+            wrap_object = wrapped_method.get("object")
+            gen_ai_endpoint = wrapped_method.get("endpoint")
+            wrapper = wrapped_method.get("wrapper")
+            wrap_function_wrapper(
+                wrap_package,
+                wrap_object,
+                wrapper(gen_ai_endpoint, version, environment, application_name,
+                 tracer, pricing_info, trace_content, metrics, disable_metrics),
+            )
+
+
+    @staticmethod
+    def _uninstrument(self, **kwargs):
+        pass

openlit/instrumentation/qdrant/qdrant.py

@@ -0,0 +1,258 @@
+# pylint: disable=duplicate-code, broad-exception-caught, too-many-statements, unused-argument, possibly-used-before-assignment, too-many-branches
+"""
+Module for monitoring Qdrant.
+"""
+
+import logging
+from opentelemetry.trace import SpanKind, Status, StatusCode
+from opentelemetry.sdk.resources import TELEMETRY_SDK_NAME
+from openlit.__helpers import handle_exception
+from openlit.semcov import SemanticConvetion
+
+# Initialize logger for logging potential issues and operations
+logger = logging.getLogger(__name__)
+
+def object_count(obj):
+    """
+    Counts Length of object if it exists, Else returns None
+    """
+    try:
+        cnt = len(obj)
+    # pylint: disable=bare-except
+    except:
+        cnt = 0
+
+    return cnt
+
+def general_wrap(gen_ai_endpoint, version, environment, application_name,
+                 tracer, pricing_info, trace_content, metrics, disable_metrics):
+    """
+    Creates a wrapper around a function call to trace and log its execution metrics.
+
+    This function wraps any given function to measure its execution time,
+    log its operation, and trace its execution using OpenTelemetry.
+    
+    Parameters:
+    - gen_ai_endpoint (str): A descriptor or name for the endpoint being traced.
+    - version (str): The version of the Langchain application.
+    - environment (str): The deployment environment (e.g., 'production', 'development').
+    - application_name (str): Name of the Langchain application.
+    - tracer (opentelemetry.trace.Tracer): The tracer object used for OpenTelemetry tracing.
+    - pricing_info (dict): Information about the pricing for internal metrics (currently not used).
+    - trace_content (bool): Flag indicating whether to trace the content of the response.
+
+    Returns:
+    - function: A higher-order function that takes a function 'wrapped' and returns
+                a new function that wraps 'wrapped' with additional tracing and logging.
+    """
+
+    def wrapper(wrapped, instance, args, kwargs):
+        """
+        An inner wrapper function that executes the wrapped function, measures execution
+        time, and records trace data using OpenTelemetry.
+
+        Parameters:
+        - wrapped (Callable): The original function that this wrapper will execute.
+        - instance (object): The instance to which the wrapped function belongs. This
+                             is used for instance methods. For static and classmethods,
+                             this may be None.
+        - args (tuple): Positional arguments passed to the wrapped function.
+        - kwargs (dict): Keyword arguments passed to the wrapped function.
+
+        Returns:
+        - The result of the wrapped function call.
+        
+        The wrapper initiates a span with the provided tracer, sets various attributes
+        on the span based on the function's execution and response, and ensures
+        errors are handled and logged appropriately.
+        """
+        with tracer.start_as_current_span(gen_ai_endpoint, kind= SpanKind.CLIENT) as span:
+            response = wrapped(*args, **kwargs)
+
+            try:
+                span.set_attribute(TELEMETRY_SDK_NAME, "openlit")
+                span.set_attribute(SemanticConvetion.GEN_AI_ENDPOINT,
+                                   gen_ai_endpoint)
+                span.set_attribute(SemanticConvetion.GEN_AI_ENVIRONMENT,
+                                   environment)
+                span.set_attribute(SemanticConvetion.GEN_AI_APPLICATION_NAME,
+                                   application_name)
+                span.set_attribute(SemanticConvetion.GEN_AI_TYPE,
+                                   SemanticConvetion.GEN_AI_TYPE_VECTORDB)
+                span.set_attribute(SemanticConvetion.DB_SYSTEM,
+                                   SemanticConvetion.DB_SYSTEM_QDRANT)
+
+                if gen_ai_endpoint == "qdrant.create_collection":
+                    db_operation = SemanticConvetion.DB_OPERATION_CREATE_COLLECTION
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_CREATE_COLLECTION)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+
+                elif gen_ai_endpoint == "qdrant.upload_collection":
+                    db_operation = SemanticConvetion.DB_OPERATION_CREATE_COLLECTION
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_CREATE_COLLECTION)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+
+                elif gen_ai_endpoint == "qdrant.delete_collection":
+                    db_operation = SemanticConvetion.DB_OPERATION_DELETE_COLLECTION
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_DELETE_COLLECTION)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+
+                elif gen_ai_endpoint == "qdrant.update_collection":
+                    db_operation = SemanticConvetion.DB_OPERATION_UPDATE_COLLECTION
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_UPDATE_COLLECTION)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+
+                elif gen_ai_endpoint == "qdrant.set_payload":
+                    db_operation = SemanticConvetion.DB_OPERATION_ADD
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_ADD)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_OPERATION_STATUS,
+                                       response.status)
+                    span.set_attribute(SemanticConvetion.DB_VECTOR_COUNT,
+                                       object_count(kwargs.get("points")))
+                    span.set_attribute(SemanticConvetion.DB_PAYLOAD_COUNT,
+                                       object_count(kwargs.get("payload")))
+
+                elif gen_ai_endpoint == "qdrant.retrieve":
+                    db_operation = SemanticConvetion.DB_OPERATION_QUERY
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_QUERY)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_STATEMENT,
+                                       str(kwargs.get("ids")))
+
+                elif gen_ai_endpoint == "qdrant.scroll":
+                    db_operation = SemanticConvetion.DB_OPERATION_QUERY
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_QUERY)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_STATEMENT,
+                                       str(kwargs.get("scroll_filter")))
+
+                elif gen_ai_endpoint in ["qdrant.search", "qdrant.search_groups"]:
+                    db_operation = SemanticConvetion.DB_OPERATION_QUERY
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_QUERY)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_STATEMENT,
+                                       str(kwargs.get("query_vector")))
+
+                elif gen_ai_endpoint == "qdrant.recommend":
+                    db_operation = SemanticConvetion.DB_OPERATION_QUERY
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_QUERY)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_STATEMENT,
+                                       "positive:" + str(kwargs.get("positive", "")) + 
+                                       " negative:" + str(kwargs.get("negative", "")))
+
+                elif gen_ai_endpoint == "qdrant.upload_points":
+                    db_operation = SemanticConvetion.DB_OPERATION_ADD
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_ADD)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_VECTOR_COUNT,
+                                       object_count(kwargs.get("points")))
+
+                elif gen_ai_endpoint == "qdrant.update_vectors":
+                    db_operation = SemanticConvetion.DB_OPERATION_UPDATE
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_UPDATE)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_OPERATION_STATUS,
+                                       response.status)
+                    span.set_attribute(SemanticConvetion.DB_VECTOR_COUNT,
+                                       object_count(kwargs.get("points")))
+
+                elif gen_ai_endpoint == "qdrant.overwrite_payload":
+                    db_operation = SemanticConvetion.DB_OPERATION_UPDATE
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_UPDATE)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_OPERATION_STATUS,
+                                       response.status)
+                    span.set_attribute(SemanticConvetion.DB_VECTOR_COUNT,
+                                       object_count(kwargs.get("points")))
+                    span.set_attribute(SemanticConvetion.DB_PAYLOAD_COUNT,
+                                       object_count(kwargs.get("payload")))
+
+                elif gen_ai_endpoint == "qdrant.upsert":
+                    db_operation = SemanticConvetion.DB_OPERATION_UPSERT
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_UPSERT)
+                    span.set_attribute(SemanticConvetion.DB_OPERATION_STATUS,
+                                       response.status)
+                    span.set_attribute(SemanticConvetion.DB_VECTOR_COUNT,
+                                       object_count(kwargs.get("points")))
+
+                elif gen_ai_endpoint in ["qdrant.delete_payload", "qdrant.delete_vectors"]:
+                    db_operation = SemanticConvetion.DB_OPERATION_DELETE
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_DELETE)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_OPERATION_STATUS,
+                                       response.status)
+                    span.set_attribute(SemanticConvetion.DB_VECTOR_COUNT,
+                                       object_count(kwargs.get("points")))
+
+                elif gen_ai_endpoint in ["qdrant.clear_payload", "qdrant.delete"]:
+                    db_operation = SemanticConvetion.DB_OPERATION_DELETE
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_DELETE)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_OPERATION_STATUS,
+                                       response.status)
+                    span.set_attribute(SemanticConvetion.DB_VECTOR_COUNT,
+                                       object_count(kwargs.get("points_selector")))
+
+                span.set_status(Status(StatusCode.OK))
+
+                if disable_metrics is False:
+                    attributes = {
+                        TELEMETRY_SDK_NAME:
+                            "openlit",
+                        SemanticConvetion.GEN_AI_APPLICATION_NAME:
+                            application_name,
+                        SemanticConvetion.DB_SYSTEM:
+                            SemanticConvetion.DB_SYSTEM_QDRANT,
+                        SemanticConvetion.GEN_AI_ENVIRONMENT:
+                            environment,
+                        SemanticConvetion.GEN_AI_TYPE:
+                            SemanticConvetion.GEN_AI_TYPE_VECTORDB,
+                        SemanticConvetion.DB_OPERATION:
+                            db_operation
+                    }
+
+                    metrics["db_requests"].add(1, attributes)
+
+                return response
+
+            except Exception as e:
+                handle_exception(span, e)
+                logger.error("Error in trace creation: %s", e)
+
+                # Return original response
+                return response
+
+    return wrapper

openlit/instrumentation/vertexai/__init__.py

@@ -0,0 +1,147 @@
+# pylint: disable=useless-return, bad-staticmethod-argument, disable=duplicate-code
+"""Initializer of Auto Instrumentation of VertexAI Functions"""
+
+from typing import Collection
+import importlib.metadata
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from wrapt import wrap_function_wrapper
+
+from openlit.instrumentation.vertexai.vertexai import (
+    generate_content, predict, predict_streaming,
+    send_message, start_chat, start_chat_streaming,
+    embeddings
+)
+from openlit.instrumentation.vertexai.async_vertexai import (
+    generate_content_async, predict_async,
+    predict_streaming_async,
+    send_message_async,
+    start_chat_async, start_chat_streaming_async,
+    embeddings_async
+)
+
+
+_instruments = ("google-cloud-aiplatform >= 1.38.1",)
+
+class VertexAIInstrumentor(BaseInstrumentor):
+    """
+    An instrumentor for VertexAI's client library.
+    """
+
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
+    def _instrument(self, **kwargs):
+        application_name = kwargs.get("application_name", "default")
+        environment = kwargs.get("environment", "default")
+        tracer = kwargs.get("tracer")
+        metrics = kwargs.get("metrics_dict")
+        pricing_info = kwargs.get("pricing_info", {})
+        trace_content = kwargs.get("trace_content", False)
+        disable_metrics = kwargs.get("disable_metrics")
+        version = importlib.metadata.version("google-cloud-aiplatform")
+
+        #sync
+        wrap_function_wrapper(
+            "vertexai.generative_models",
+            "GenerativeModel.generate_content",
+            generate_content("vertexai.generate_content", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.generative_models",
+            "ChatSession.send_message",
+            send_message("vertexai.send_message", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",  
+            "TextGenerationModel.predict",  
+            predict("vertexai.predict", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "TextGenerationModel.predict_streaming",
+            predict_streaming("vertexai.predict", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "ChatSession.send_message",
+            start_chat("vertexai.send_message", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "ChatSession.send_message_streaming",
+            start_chat_streaming("vertexai.send_message", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "TextEmbeddingModel.get_embeddings",
+            embeddings("vertexai.get_embeddings", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        #async
+        wrap_function_wrapper(
+            "vertexai.generative_models",
+            "GenerativeModel.generate_content_async",
+            generate_content_async("vertexai.generate_content", version, environment,
+                                   application_name, tracer, pricing_info, trace_content,
+                                   metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.generative_models",
+            "ChatSession.send_message_async",
+            send_message_async("vertexai.send_message", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "TextGenerationModel.predict_async",
+            predict_async("vertexai.predict", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "TextGenerationModel.predict_streaming_async",
+            predict_streaming_async("vertexai.predict", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "ChatSession.send_message_async",
+            start_chat_async("vertexai.send_message", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "ChatSession.send_message_streaming_async",
+            start_chat_streaming_async("vertexai.send_message", version, environment,
+                                       application_name, tracer, pricing_info, trace_content,
+                                       metrics, disable_metrics),
+        )
+
+        wrap_function_wrapper(
+            "vertexai.language_models",
+            "TextEmbeddingModel.get_embeddings_async",
+            embeddings_async("vertexai.get_embeddings", version, environment, application_name,
+                     tracer, pricing_info, trace_content, metrics, disable_metrics),
+        )
+
+    def _uninstrument(self, **kwargs):
+        # Proper uninstrumentation logic to revert patched methods
+        pass