openlit 1.12.0__py3-none-any.whl → 1.13.0__py3-none-any.whl

openlit/__init__.py

@@ -1,17 +1,26 @@
+# pylint: disable=broad-exception-caught
 """
 The __init__.py module for the openLIT package.
 This module sets up the openLIT configuration and instrumentation for various
 large language models (LLMs).
 """
+
 from typing import Dict
 import logging
 from importlib.util import find_spec
+from functools import wraps
+from contextlib import contextmanager
+
 
 # Import internal modules for setting up tracing and fetching pricing info.
+from opentelemetry import trace as t
+from opentelemetry.trace import SpanKind, Status, StatusCode, Span
+from openlit.semcov import SemanticConvetion
 from openlit.otel.tracing import setup_tracing
 from openlit.otel.metrics import setup_meter
 from openlit.__helpers import fetch_pricing_info
 
+
 # Instrumentors for various large language models.
 from openlit.instrumentation.openai import OpenAIInstrumentor
 from openlit.instrumentation.anthropic import AnthropicInstrumentor
@@ -35,13 +44,14 @@ from openlit.instrumentation.transformers import TransformersInstrumentor
 # Set up logging for error and information messages.
 logger = logging.getLogger(__name__)
 
+
 class OpenlitConfig:
     """
     A Singleton Configuration class for openLIT.
-    
+
     This class maintains a single instance of configuration settings including
     environment details, application name, and tracing information throughout the openLIT package.
-    
+
     Attributes:
         environment (str): Deployment environment of the application.
         application_name (str): Name of the application using openLIT.
@@ -52,6 +62,7 @@ class OpenlitConfig:
         disable_batch (bool): Flag to disable batch span processing in tracing.
         trace_content (bool): Flag to enable or disable tracing of content.
     """
+
     _instance = None
 
     def __new__(cls):
@@ -76,9 +87,19 @@ class OpenlitConfig:
         cls.disable_metrics = False
 
     @classmethod
-    def update_config(cls, environment, application_name, tracer, otlp_endpoint,
-                      otlp_headers, disable_batch, trace_content, metrics_dict,
-                      disable_metrics, pricing_json):
+    def update_config(
+        cls,
+        environment,
+        application_name,
+        tracer,
+        otlp_endpoint,
+        otlp_headers,
+        disable_batch,
+        trace_content,
+        metrics_dict,
+        disable_metrics,
+        pricing_json,
+    ):
         """
         Updates the configuration based on provided parameters.
 
@@ -104,8 +125,14 @@ class OpenlitConfig:
         cls.trace_content = trace_content
         cls.disable_metrics = disable_metrics
 
-def instrument_if_available(instrumentor_name, instrumentor_instance, config,
-                            disabled_instrumentors, module_name_map):
+
+def instrument_if_available(
+    instrumentor_name,
+    instrumentor_instance,
+    config,
+    disabled_instrumentors,
+    module_name_map,
+):
     """Instruments the specified instrumentor if its library is available."""
     if instrumentor_name in disabled_instrumentors:
         return
@@ -121,22 +148,33 @@ def instrument_if_available(instrumentor_name, instrumentor_instance, config,
                 pricing_info=config.pricing_info,
                 trace_content=config.trace_content,
                 metrics_dict=config.metrics_dict,
-                disable_metrics=config.disable_metrics
+                disable_metrics=config.disable_metrics,
             )
 
         # pylint: disable=broad-exception-caught
         except Exception as e:
             logger.error("Failed to instrument %s: %s", instrumentor_name, e)
 
-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, pricing_json=None):
+
+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,
+    pricing_json=None,
+):
     """
     Initializes the openLIT configuration and setups tracing.
-    
-    This function sets up the openLIT environment with provided configurations 
+
+    This function sets up the openLIT environment with provided configurations
     and initializes instrumentors for tracing.
-    
+
     Args:
         environment (str): Deployment environment.
         application_name (str): Application name.
@@ -155,8 +193,8 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
 
     module_name_map = {
         "openai": "openai",
-        "anthropic": "anthropic",  
-        "cohere": "cohere",  
+        "anthropic": "anthropic",
+        "cohere": "cohere",
         "mistral": "mistralai",
         "bedrock": "boto3",
         "vertexai": "vertexai",
@@ -171,12 +209,16 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
         "pinecone": "pinecone",
         "qdrant": "qdrant_client",
         "milvus": "pymilvus",
-        "transformers": "transformers"
+        "transformers": "transformers",
     }
 
-    invalid_instrumentors = [name for name in disabled_instrumentors if name not in module_name_map]
+    invalid_instrumentors = [
+        name for name in disabled_instrumentors if name not in module_name_map
+    ]
     for invalid_name in invalid_instrumentors:
-        logger.warning("Invalid instrumentor name detected and ignored: '%s'", invalid_name)
+        logger.warning(
+            "Invalid instrumentor name detected and ignored: '%s'", invalid_name
+        )
 
     try:
         # Retrieve or create the single configuration instance.
@@ -185,9 +227,11 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
         # Setup tracing based on the provided or default configuration.
         tracer = setup_tracing(
             application_name=application_name,
-            environment=environment, tracer=tracer,
-            otlp_endpoint=otlp_endpoint, otlp_headers=otlp_headers,
-            disable_batch=disable_batch
+            environment=environment,
+            tracer=tracer,
+            otlp_endpoint=otlp_endpoint,
+            otlp_headers=otlp_headers,
+            disable_batch=disable_batch,
         )
 
         if not tracer:
@@ -195,18 +239,31 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
             return
 
         # Setup meter and receive metrics_dict instead of meter
-        metrics_dict = setup_meter(application_name=application_name,
-                                   environment=environment, meter=meter,
-                                   otlp_endpoint=otlp_endpoint, otlp_headers=otlp_headers)
+        metrics_dict = setup_meter(
+            application_name=application_name,
+            environment=environment,
+            meter=meter,
+            otlp_endpoint=otlp_endpoint,
+            otlp_headers=otlp_headers,
+        )
 
         if not metrics_dict:
             logger.error("openLIT metrics setup failed. Metrics will not be available.")
             return
 
         # 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, pricing_json)
+        config.update_config(
+            environment,
+            application_name,
+            tracer,
+            otlp_endpoint,
+            otlp_headers,
+            disable_batch,
+            trace_content,
+            metrics_dict,
+            disable_metrics,
+            pricing_json,
+        )
 
         # Map instrumentor names to their instances
         instrumentor_instances = {
@@ -227,14 +284,142 @@ def init(environment="default", application_name="default", tracer=None, otlp_en
             "pinecone": PineconeInstrumentor(),
             "qdrant": QdrantInstrumentor(),
             "milvus": MilvusInstrumentor(),
-            "transformers": TransformersInstrumentor()
+            "transformers": TransformersInstrumentor(),
         }
 
         # Initialize and instrument only the enabled instrumentors
         for name, instrumentor in instrumentor_instances.items():
-            instrument_if_available(name, instrumentor, config,
-                                    disabled_instrumentors, module_name_map)
+            instrument_if_available(
+                name, instrumentor, config, disabled_instrumentors, module_name_map
+            )
 
-    # pylint: disable=broad-exception-caught
     except Exception as e:
         logger.error("Error during openLIT initialization: %s", e)
+
+
+def trace(wrapped):
+    """
+    Generates a telemetry wrapper for messages to collect metrics.
+    """
+
+    @wraps(wrapped)
+    def wrapper(*args, **kwargs):
+        __trace = t.get_tracer_provider()
+        with __trace.get_tracer(__name__).start_as_current_span(
+            name=wrapped.__name__,
+            kind=SpanKind.CLIENT,
+        ) as span:
+            try:
+                response = wrapped(*args, **kwargs)
+                span.set_attribute(
+                    SemanticConvetion.GEN_AI_CONTENT_COMPLETION, response
+                )
+                span.set_status(Status(StatusCode.OK))
+
+            except Exception as e:
+                response = None
+                span.record_exception(e)
+                span.set_status(status=Status(StatusCode.ERROR), description=e)
+                logging.error("Error in %s: %s", wrapped.__name__, e, exc_info=True)
+
+            # Adding function arguments as metadata
+            try:
+                span.set_attribute("function.args", str(args))
+                span.set_attribute("function.kwargs", str(kwargs))
+                span.set_attribute(
+                    SemanticConvetion.GEN_AI_APPLICATION_NAME,
+                    OpenlitConfig.application_name,
+                )
+                span.set_attribute(
+                    SemanticConvetion.GEN_AI_ENVIRONMENT, OpenlitConfig.environment
+                )
+
+            except Exception as meta_exception:
+                logging.error(
+                    "Failed to set metadata for %s: %s",
+                    wrapped.__name__,
+                    meta_exception,
+                    exc_info=True,
+                )
+
+            return response
+
+    return wrapper
+
+
+class TracedSpan:
+    """
+    A wrapper class for an OpenTelemetry span that provides helper methods
+    for setting result and metadata attributes on the span.
+
+    Attributes:
+        _span (Span): The underlying OpenTelemetry span.
+    """
+
+    def __init__(self, span):
+        """
+        Initializes the TracedSpan with the given span.
+
+        Params:
+            span (Span): The OpenTelemetry span to be wrapped.
+        """
+
+        self._span: Span = span
+
+    def set_result(self, result):
+        """
+        Sets the result attribute on the underlying span.
+
+        Params:
+            result: The result to be set as an attribute on the span.
+        """
+
+        self._span.set_attribute(SemanticConvetion.GEN_AI_CONTENT_COMPLETION, result)
+
+    def set_metadata(self, metadata: Dict):
+        """
+        Sets multiple attributes on the underlying span.
+
+        Params:
+            metadata (Dict): A dictionary of attributes to be set on the span.
+        """
+
+        self._span.set_attributes(attributes=metadata)
+
+    def __enter__(self):
+        """
+        Enters the context of the TracedSpan, returning itself.
+
+        Returns:
+            TracedSpan: The instance of TracedSpan.
+        """
+
+        return self
+
+    def __exit__(self, _exc_type, _exc_val, _exc_tb):
+        """
+        Exits the context of the TracedSpan by ending the underlying span.
+        """
+
+        self._span.end()
+
+
+@contextmanager
+def start_trace(name: str):
+    """
+    A context manager that starts a new trace and provides a TracedSpan
+    for usage within the context.
+
+    Params:
+        name (str): The name of the span.
+
+    Yields:
+        TracedSpan: The wrapped span for trace operations.
+    """
+
+    __trace = t.get_tracer_provider()
+    with __trace.get_tracer(__name__).start_as_current_span(
+        name,
+        kind=SpanKind.CLIENT,
+    ) as span:
+        yield TracedSpan(span)

{openlit-1.12.0.dist-info → openlit-1.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openlit
-Version: 1.12.0
+Version: 1.13.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
@@ -36,7 +36,8 @@ OpenTelemetry Auto-Instrumentation for GenAI & LLM Applications</h1>
 [![GitHub Contributors](https://img.shields.io/github/contributors/openlit/openlit)](https://github.com/openlit/openlit/graphs/contributors)
 
 [![Slack](https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=white)](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ)
-[![X](https://img.shields.io/badge/follow-%40OpenLIT-1DA1F2?logo=x&style=social)](https://twitter.com/openlit_io)
+[![Discord](https://img.shields.io/badge/Discord-7289DA?logo=discord&logoColor=white)](https://discord.gg/rjvTm6zd)
+[![X](https://img.shields.io/badge/follow-%40openlit__io-1DA1F2?logo=x&style=social)](https://twitter.com/openlit_io)
 
 ![OpenLIT Connections Banner](https://github.com/openlit/.github/blob/main/profile/assets/github-readme-connections-banner.png?raw=true)
 
@@ -191,7 +192,7 @@ Whether it's big or small, we love contributions 💚. Check out our [Contributi
 
 Unsure where to start? Here are a few ways to get involved:
 
-- Join our [Slack channel](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ) to discuss ideas, share feedback, and connect with both our team and the wider OpenLIT community.
+- Join our [Slack](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ) or [Discord](https://discord.gg/rjvTm6zd) community to discuss ideas, share feedback, and connect with both our team and the wider OpenLIT community.
 
 Your input helps us grow and improve, and we're here to support you every step of the way.
 
@@ -200,7 +201,7 @@ Your input helps us grow and improve, and we're here to support you every step o
 Connect with the OpenLIT community and maintainers for support, discussions, and updates:
 
 - 🌟 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.
+- 🌍 Join our [Slack](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ) or [Discord](https://discord.gg/rjvTm6zd) 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://x.com/openlit_io) for the latest updates and news.
 

{openlit-1.12.0.dist-info → openlit-1.13.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openlit/__helpers.py,sha256=lrn4PBs9owDudiCY2NBoVbAi7AU_HtUpyOj0oqPBsPY,5545
-openlit/__init__.py,sha256=uW32Zg5R6NK3qqy3rfQhUnFi_YfvhnM4TFJSLo6Yr54,10439
+openlit/__init__.py,sha256=ZkXQbO0l2trFv-DqljF5ZLCCBJqjqOMIxmE6Tcafabg,14452
 openlit/instrumentation/anthropic/__init__.py,sha256=oaU53BOPyfUKbEzYvLr1DPymDluurSnwo4Hernf2XdU,1955
 openlit/instrumentation/anthropic/anthropic.py,sha256=CYBui5eEfWdSfFF0xtCQjh1xO-gCVJc_V9Hli0szVZE,16026
 openlit/instrumentation/anthropic/async_anthropic.py,sha256=NW84kTQ3BkUx1zZuMRps_J7zTYkmq5BxOrqSjqWInBs,16068
@@ -47,7 +47,7 @@ openlit/instrumentation/vertexai/vertexai.py,sha256=UvpNKBHPoV9idVMfGigZnmWuEQiy
 openlit/otel/metrics.py,sha256=O7NoaDz0bY19mqpE4-0PcKwEe-B-iJFRgOCaanAuZAc,4291
 openlit/otel/tracing.py,sha256=vL1ifMbARPBpqK--yXYsCM6y5dSu5LFIKqkhZXtYmUc,3712
 openlit/semcov/__init__.py,sha256=fZve0UdvbZCcXBBiYhQhwm6gFe9JPkZznyr8W3wiI68,6681
-openlit-1.12.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openlit-1.12.0.dist-info/METADATA,sha256=4N0gOurCVrWMv_5yMkqFqLxPFwjeACSF6Tutc2WOOxc,13123
-openlit-1.12.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-openlit-1.12.0.dist-info/RECORD,,
+openlit-1.13.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openlit-1.13.0.dist-info/METADATA,sha256=d_S0Eqcq8Oh0i9yPN21bc6yDFpdxhFuZ97Rv8sQByoc,13329
+openlit-1.13.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+openlit-1.13.0.dist-info/RECORD,,