openlit 1.6.0__tar.gz → 1.8.0__tar.gz

{openlit-1.6.0 → openlit-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openlit
-Version: 1.6.0
+Version: 1.8.0
 Summary: OpenTelemetry-native Auto instrumentation library for monitoring LLM Applications, facilitating the integration of observability into your GenAI-driven projects
 Home-page: https://github.com/openlit/openlit/tree/main/openlit/python
 Keywords: OpenTelemetry,otel,otlp,llm,tracing,openai,anthropic,claude,cohere,llm monitoring,observability,monitoring,gpt,Generative AI,chatGPT
@@ -64,6 +64,7 @@ This project adheres to the [Semantic Conventions](https://github.com/open-telem
 - [✅ ChromaDB](https://docs.openlit.io/latest/integrations/chromadb)
 - [✅ Pinecone](https://docs.openlit.io/latest/integrations/pinecone)
 - [✅ Qdrant](https://docs.openlit.io/latest/integrations/qdrant)
+- [✅ Milvus](https://docs.openlit.io/latest/integrations/milvus)
 
 ### Frameworks
 - [✅ Langchain](https://docs.openlit.io/latest/integrations/langchain)
@@ -164,6 +165,7 @@ Below is a detailed overview of the configuration options available, allowing yo
 | `trace_content`         | Enables tracing of content for deeper insights.                                               | `True`         |    No    |
 | `disabled_instrumentors`| List of instrumentors to disable. Choices: `["openai", "anthropic", "langchain", "cohere", "mistral", "transformers", "chroma", "pinecone"]`. | `None` |    No    |
 | `disable_metrics`       | If set, disables the collection of metrics.                                                   | `False`        |    No    |
+| `pricing_json`          | URL or file path of the pricing JSON file.                                             | `https://github.com/openlit/openlit/blob/main/assets/pricing.json`        |    No    |
 
 ## 🌱 Contributing
 
@@ -182,5 +184,5 @@ Connect with the OpenLIT community and maintainers for support, discussions, and
 - 🌟 If you like it, Leave a star on our [GitHub](https://github.com/openlit/openlit/)
 - 🌍 Join our [Slack](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ) Community for live interactions and questions.
 - 🐞 Report bugs on our [GitHub Issues](https://github.com/openlit/openlit/issues) to help us improve OpenLIT.
-- 𝕏 Follow us on [X](https://twitter.com/openlit) for the latest updates and news.
+- 𝕏 Follow us on [X](https://x.com/openlit_io) for the latest updates and news.
 

{openlit-1.6.0 → openlit-1.8.0}/README.md

@@ -39,6 +39,7 @@ This project adheres to the [Semantic Conventions](https://github.com/open-telem
 - [✅ ChromaDB](https://docs.openlit.io/latest/integrations/chromadb)
 - [✅ Pinecone](https://docs.openlit.io/latest/integrations/pinecone)
 - [✅ Qdrant](https://docs.openlit.io/latest/integrations/qdrant)
+- [✅ Milvus](https://docs.openlit.io/latest/integrations/milvus)
 
 ### Frameworks
 - [✅ Langchain](https://docs.openlit.io/latest/integrations/langchain)
@@ -139,6 +140,7 @@ Below is a detailed overview of the configuration options available, allowing yo
 | `trace_content`         | Enables tracing of content for deeper insights.                                               | `True`         |    No    |
 | `disabled_instrumentors`| List of instrumentors to disable. Choices: `["openai", "anthropic", "langchain", "cohere", "mistral", "transformers", "chroma", "pinecone"]`. | `None` |    No    |
 | `disable_metrics`       | If set, disables the collection of metrics.                                                   | `False`        |    No    |
+| `pricing_json`          | URL or file path of the pricing JSON file.                                             | `https://github.com/openlit/openlit/blob/main/assets/pricing.json`        |    No    |
 
 ## 🌱 Contributing
 
@@ -157,4 +159,4 @@ Connect with the OpenLIT community and maintainers for support, discussions, and
 - 🌟 If you like it, Leave a star on our [GitHub](https://github.com/openlit/openlit/)
 - 🌍 Join our [Slack](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ) Community for live interactions and questions.
 - 🐞 Report bugs on our [GitHub Issues](https://github.com/openlit/openlit/issues) to help us improve OpenLIT.
-- 𝕏 Follow us on [X](https://twitter.com/openlit) for the latest updates and news.
+- 𝕏 Follow us on [X](https://x.com/openlit_io) for the latest updates and news.

{openlit-1.6.0 → openlit-1.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openlit"
-version = "1.6.0"
+version = "1.8.0"
 description = "OpenTelemetry-native Auto instrumentation library for monitoring LLM Applications, facilitating the integration of observability into your GenAI-driven projects"
 authors = ["OpenLIT"]
 repository = "https://github.com/openlit/openlit/tree/main/openlit/python"

{openlit-1.6.0 → openlit-1.8.0}/src/openlit/__helpers.py

@@ -2,8 +2,9 @@
 """
 This module has functions to calculate model costs based on tokens and to fetch pricing information.
 """
-
+import json
 import logging
+from urllib.parse import urlparse
 import requests
 import tiktoken
 from opentelemetry.trace import Status, StatusCode
@@ -122,11 +123,35 @@ def get_audio_model_cost(model, pricing_info, prompt):
         cost = 0
     return cost
 
-def fetch_pricing_info():
-    """Fetches pricing information from a specified URL."""
-    pricing_url = "https://raw.githubusercontent.com/openlit/openlit/main/assets/pricing.json"
+def fetch_pricing_info(pricing_json=None):
+    """
+    Fetches pricing information from a specified URL or File Path.
+
+    Args:
+        pricing_json(str): path or url to the pricing json file
+
+    Returns:
+        dict: The pricing json
+    """
+    if pricing_json:
+        is_url = urlparse(pricing_json).scheme != ""
+        if is_url:
+            pricing_url = pricing_json
+        else:
+            try:
+                with open(pricing_json, mode='r', encoding='utf-8') as f:
+                    return json.load(f)
+            except FileNotFoundError:
+                logger.error("Pricing information file not found: %s", pricing_json)
+            except json.JSONDecodeError:
+                logger.error("Error decoding JSON from file: %s", pricing_json)
+            except Exception as file_err:
+                logger.error("Unexpected error occurred while reading file: %s", file_err)
+            return {}
+    else:
+        pricing_url = "https://raw.githubusercontent.com/openlit/openlit/main/assets/pricing.json"
     try:
-         # Set a timeout of 10 seconds for both the connection and the read
+        # Set a timeout of 10 seconds for both the connection and the read
         response = requests.get(pricing_url, timeout=20)
         response.raise_for_status()
         return response.json()

{openlit-1.6.0 → openlit-1.8.0}/src/openlit/__init__.py

@@ -27,6 +27,7 @@ from openlit.instrumentation.haystack import HaystackInstrumentor
 from openlit.instrumentation.chroma import ChromaInstrumentor
 from openlit.instrumentation.pinecone import PineconeInstrumentor
 from openlit.instrumentation.qdrant import QdrantInstrumentor
+from openlit.instrumentation.milvus import MilvusInstrumentor
 from openlit.instrumentation.transformers import TransformersInstrumentor
 
 # Set up logging for error and information messages.
@@ -74,7 +75,8 @@ class OpenlitConfig:
 
     @classmethod
     def update_config(cls, environment, application_name, tracer, otlp_endpoint,
-                      otlp_headers, disable_batch, trace_content, metrics_dict, disable_metrics):
+                      otlp_headers, disable_batch, trace_content, metrics_dict,
+                      disable_metrics, pricing_json):
         """
         Updates the configuration based on provided parameters.
 
@@ -87,10 +89,11 @@ class OpenlitConfig:
             otlp_headers (Dict[str, str]): OTLP headers.
             disable_batch (bool): Disable batch span processing flag.
             trace_content (bool): Enable or disable content tracing.
+            pricing_json(str): path or url to the pricing json file
         """
         cls.environment = environment
         cls.application_name = application_name
-        cls.pricing_info = fetch_pricing_info()
+        cls.pricing_info = fetch_pricing_info(pricing_json)
         cls.tracer = tracer
         cls.metrics_dict = metrics_dict
         cls.otlp_endpoint = otlp_endpoint
@@ -125,7 +128,7 @@ def instrument_if_available(instrumentor_name, instrumentor_instance, config,
 
 def init(environment="default", application_name="default", tracer=None, otlp_endpoint=None,
          otlp_headers=None, disable_batch=False, trace_content=True, disabled_instrumentors=None,
-         meter=None, disable_metrics=False):
+         meter=None, disable_metrics=False, pricing_json=None):
     """
     Initializes the openLIT configuration and setups tracing.
     
@@ -143,6 +146,7 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
         trace_content (bool): Flag to trace content (Optional).
         disabled_instrumentors (List[str]): Optional. List of instrumentor names to disable.
         disable_metrics (bool): Flag to disable metrics (Optional)
+        pricing_json(str): File path or url to the pricing json (Optional)
     """
     disabled_instrumentors = disabled_instrumentors if disabled_instrumentors else []
     # Check for invalid instrumentor names
@@ -162,6 +166,7 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
         "chroma": "chromadb",
         "pinecone": "pinecone",
         "qdrant": "qdrant_client",
+        "milvus": "pymilvus",
         "transformers": "transformers"
     }
 
@@ -197,7 +202,7 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
         # Update global configuration with the provided settings.
         config.update_config(environment, application_name, tracer, otlp_endpoint,
                              otlp_headers, disable_batch, trace_content,
-                             metrics_dict, disable_metrics)
+                             metrics_dict, disable_metrics, pricing_json)
 
         # Map instrumentor names to their instances
         instrumentor_instances = {
@@ -215,6 +220,7 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
             "chroma": ChromaInstrumentor(),
             "pinecone": PineconeInstrumentor(),
             "qdrant": QdrantInstrumentor(),
+            "milvus": MilvusInstrumentor(),
             "transformers": TransformersInstrumentor()
         }
 

openlit-1.8.0/src/openlit/instrumentation/milvus/__init__.py

@@ -0,0 +1,94 @@
+# pylint: disable=useless-return, bad-staticmethod-argument, disable=duplicate-code
+"""Initializer of Auto Instrumentation of Milvus Functions"""
+from typing import Collection
+import importlib.metadata
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from wrapt import wrap_function_wrapper
+
+from openlit.instrumentation.milvus.milvus import general_wrap
+
+_instruments = ("pymilvus >= 2.4.3",)
+
+WRAPPED_METHODS = [
+    {
+        "package": "pymilvus",
+        "object": "MilvusClient.create_collection",
+        "endpoint": "milvus.create_collection",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "pymilvus",
+        "object": "MilvusClient.drop_collection",
+        "endpoint": "milvus.drop_collection",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "pymilvus",
+        "object": "MilvusClient.insert",
+        "endpoint": "milvus.insert",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "pymilvus",
+        "object": "MilvusClient.upsert",
+        "endpoint": "milvus.upsert",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "pymilvus",
+        "object": "MilvusClient.search",
+        "endpoint": "milvus.search",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "pymilvus",
+        "object": "MilvusClient.query",
+        "endpoint": "milvus.query",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "pymilvus",
+        "object": "MilvusClient.get",
+        "endpoint": "milvus.get",
+        "wrapper": general_wrap,
+    },
+    {
+        "package": "pymilvus",
+        "object": "MilvusClient.delete",
+        "endpoint": "milvus.delete",
+        "wrapper": general_wrap,
+    },
+]
+
+class MilvusInstrumentor(BaseInstrumentor):
+    """An instrumentor for Milvus'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("pymilvus")
+
+        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-1.8.0/src/openlit/instrumentation/milvus/milvus.py

@@ -0,0 +1,179 @@
+# pylint: disable=duplicate-code, broad-exception-caught, too-many-statements, unused-argument, possibly-used-before-assignment, too-many-branches
+"""
+Module for monitoring Milvus.
+"""
+
+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_MILVUS)
+
+                if gen_ai_endpoint == "milvus.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", ""))
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_DIMENSION,
+                                       kwargs.get("dimension", ""))
+
+                elif gen_ai_endpoint == "milvus.drop_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 == "milvus.insert":
+                    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("data")))
+                    span.set_attribute(SemanticConvetion.DB_OPERATION_COST,
+                                       response["cost"])
+
+                elif gen_ai_endpoint == "milvus.search":
+                    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("data")))
+
+                elif gen_ai_endpoint in ["milvus.query", "milvus.get"]:
+                    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("output_fields")))
+
+                elif gen_ai_endpoint == "milvus.upsert":
+                    db_operation = SemanticConvetion.DB_OPERATION_ADD
+                    span.set_attribute(SemanticConvetion.DB_OPERATION,
+                                       SemanticConvetion.DB_OPERATION_UPSERT)
+                    span.set_attribute(SemanticConvetion.DB_COLLECTION_NAME,
+                                       kwargs.get("collection_name", ""))
+                    span.set_attribute(SemanticConvetion.DB_VECTOR_COUNT,
+                                       object_count(kwargs.get("data")))
+                    span.set_attribute(SemanticConvetion.DB_OPERATION_COST,
+                                       response["cost"])
+
+                elif gen_ai_endpoint == "milvus.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_FILTER,
+                                       str(kwargs.get("filter", "")))
+
+                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_MILVUS,
+                        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-1.6.0 → openlit-1.8.0}/src/openlit/semcov/__init__.py

@@ -99,6 +99,7 @@ class SemanticConvetion:
     DB_COLLECTION_NAME = "db.collection.name"
     DB_OPERATION = "db.operation"
     DB_OPERATION_STATUS = "db.operation.status"
+    DB_OPERATION_COST = "db.operation.cost"
     DB_OPERATION_CREATE_INDEX = "create_index"
     DB_OPERATION_CREATE_COLLECTION = "create_collection"
     DB_OPERATION_UPDATE_COLLECTION = "update_collection"
@@ -123,7 +124,8 @@ class SemanticConvetion:
     DB_N_RESULTS = "db.n_results"
     DB_DELETE_ALL = "db.delete_all"
     DB_INDEX_NAME = "db.index.name"
-    DB_INDEX_DIMENSION = "db.create_index.dimensions"
+    DB_INDEX_DIMENSION = "db.index.dimension"
+    DB_COLLECTION_DIMENSION = "db.collection.dimension"
     DB_INDEX_METRIC = "db.create_index.metric"
     DB_INDEX_SPEC = "db.create_index.spec"
     DB_NAMESPACE = "db.query.namespace"
@@ -134,3 +136,4 @@ class SemanticConvetion:
     DB_SYSTEM_CHROMA = "chroma"
     DB_SYSTEM_PINECONE = "pinecone"
     DB_SYSTEM_QDRANT = "qdrant"
+    DB_SYSTEM_MILVUS = "milvus"