ioa-observe-sdk 1.0.3__tar.gz → 1.0.5__tar.gz

{ioa_observe_sdk-1.0.3 → ioa_observe_sdk-1.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ioa-observe-sdk
-Version: 1.0.3
+Version: 1.0.5
 Summary: IOA Observability SDK
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -90,6 +90,7 @@ IOA observability SDK for your multi-agentic application.
 ## Table of Contents
 
 - [Installation](#installation)
+- [Schema](#schema)
 - [Dev](#dev)
 - [Testing](#testing)
 - [Getting Started](#getting-started)
@@ -109,6 +110,13 @@ Alternatively, to download the SDK from git, you could also use the following co
 uv add "git+https://github.com/agntcy/observe"
 ```
 
+## Schema
+
+The AGNTCY observability schema is an extension of the OTel LLM Semantic Conventions for Generative AI systems.
+This schema is designed to provide comprehensive observability for Multi-Agent Systems (MAS).
+
+Link: [AGNTCY Observability Schema](https://github.com/agntcy/observe/blob/main/schema/)
+
 ## Dev
 
 To get started with development, start a Clickhouse DB and an OTel collector container locally using docker-compose like so:
@@ -152,7 +160,7 @@ To run the unit tests, ensure you have the `OPENAI_API_KEY` set in your environm
 OPENAI_API_KEY=<KEY> make test
 ```
 
-## Getting Started
+## 🚀 Getting Started
 
 For getting started with the SDK, please refer to the [Getting Started](https://github.com/agntcy/observe/blob/main/GETTING-STARTED.md)
  file. It contains detailed instructions on how to set up and use the SDK effectively.

{ioa_observe_sdk-1.0.3 → ioa_observe_sdk-1.0.5}/README.md

@@ -5,6 +5,7 @@ IOA observability SDK for your multi-agentic application.
 ## Table of Contents
 
 - [Installation](#installation)
+- [Schema](#schema)
 - [Dev](#dev)
 - [Testing](#testing)
 - [Getting Started](#getting-started)
@@ -24,6 +25,13 @@ Alternatively, to download the SDK from git, you could also use the following co
 uv add "git+https://github.com/agntcy/observe"
 ```
 
+## Schema
+
+The AGNTCY observability schema is an extension of the OTel LLM Semantic Conventions for Generative AI systems.
+This schema is designed to provide comprehensive observability for Multi-Agent Systems (MAS).
+
+Link: [AGNTCY Observability Schema](https://github.com/agntcy/observe/blob/main/schema/)
+
 ## Dev
 
 To get started with development, start a Clickhouse DB and an OTel collector container locally using docker-compose like so:
@@ -67,7 +75,7 @@ To run the unit tests, ensure you have the `OPENAI_API_KEY` set in your environm
 OPENAI_API_KEY=<KEY> make test
 ```
 
-## Getting Started
+## 🚀 Getting Started
 
 For getting started with the SDK, please refer to the [Getting Started](https://github.com/agntcy/observe/blob/main/GETTING-STARTED.md)
  file. It contains detailed instructions on how to set up and use the SDK effectively.

ioa_observe_sdk-1.0.5/ioa_observe/sdk/tracing/context_utils.py

@@ -0,0 +1,82 @@
+from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
+from opentelemetry.baggage.propagation import W3CBaggagePropagator
+from opentelemetry import baggage
+
+from ioa_observe.sdk import TracerWrapper
+from ioa_observe.sdk.client import kv_store
+from ioa_observe.sdk.tracing import set_execution_id, get_current_traceparent
+from opentelemetry import context as otel_context
+
+"""
+Usage Example:
+
+
+Sender:
+Before sending a message, call get_current_context_headers() and attach the returned headers to your message.
+Receiver:
+After receiving a message, extract headers and call set_context_from_headers(headers) before processing.
+"""
+
+
+def get_current_context_headers():
+    """
+    Extracts the current trace context, baggage, and execution_id into headers.
+    """
+    _global_tracer = TracerWrapper().get_tracer()
+    with _global_tracer.start_as_current_span("get_current_context_headers"):
+        carrier = {}
+        # Use the current OpenTelemetry context for injection
+        current_ctx = otel_context.get_current()
+        TraceContextTextMapPropagator().inject(carrier, context=current_ctx)
+        W3CBaggagePropagator().inject(carrier, context=current_ctx)
+        traceparent = carrier.get("traceparent")
+        execution_id = None
+        if traceparent:
+            execution_id = kv_store.get(f"execution.{traceparent}")
+            if execution_id:
+                carrier["execution_id"] = execution_id
+        return carrier
+
+
+def set_context_from_headers(headers):
+    """
+    Restores the trace context, baggage, and execution_id from headers.
+    """
+    # Extract trace context and baggage
+    _global_tracer = TracerWrapper().get_tracer()
+    with _global_tracer.start_as_current_span("set_context_from_headers"):
+        ctx = TraceContextTextMapPropagator().extract(carrier=headers)
+        ctx = W3CBaggagePropagator().extract(carrier=headers, context=ctx)
+        # Restore execution_id if present
+        if headers is not None:
+            if "traceparent" in headers:
+                traceparent = headers.get("traceparent")
+            if "executionID" in headers:
+                execution_id = headers.get("executionID")
+        if traceparent and execution_id and execution_id != "None":
+            set_execution_id(execution_id, traceparent=traceparent)
+            kv_store.set(f"execution.{traceparent}", execution_id)
+        return ctx
+
+
+def set_baggage_item(key, value):
+    baggage.set_baggage(key, value)
+
+
+def get_baggage_item(key):
+    return baggage.get_baggage(key)
+
+
+def get_current_execution_id():
+    traceparent = get_current_traceparent()
+    if traceparent:
+        return kv_store.get(f"execution.{traceparent}")
+    return None
+
+
+def set_execution_id_from_headers(headers):
+    traceparent = headers.get("traceparent")
+    execution_id = headers.get("execution_id")
+    if traceparent and execution_id:
+        set_execution_id(execution_id, traceparent=traceparent)
+        kv_store.set(f"execution.{traceparent}", execution_id)

{ioa_observe_sdk-1.0.3 → ioa_observe_sdk-1.0.5}/ioa_observe/sdk/tracing/tracing.py

@@ -404,14 +404,30 @@ def set_workflow_name(workflow_name: str) -> None:
 
 def session_start():
     """
-    Marks the start of a session by setting the workflow name and execution ID.
-    This is typically called at the beginning of a workflow execution.
+    Can be used as a context manager or a normal function.
+    As a context manager, yields session metadata.
+    As a normal function, just sets up the session.
     """
-    # Set execution ID if not already set
-    # execution_id = get_value("execution.id")
-    # if not execution_id:
     execution_id = TracerWrapper.app_name + "_" + str(uuid.uuid4())
     set_execution_id(execution_id)
+    metadata = {
+        "executionID": get_value("execution.id") or execution_id,
+        "traceparent": get_current_traceparent(),
+    }
+    import inspect
+
+    frame = inspect.currentframe().f_back
+    if frame and "__enter__" in frame.f_code.co_names:
+        # Used as a context manager
+        from contextlib import contextmanager
+
+        @contextmanager
+        def _cm():
+            yield metadata
+
+        return _cm()
+    # Used as a normal function
+    return None
 
 
 def set_execution_id(execution_id: str, traceparent: str = None) -> None:
@@ -435,8 +451,6 @@ def set_execution_id(execution_id: str, traceparent: str = None) -> None:
 
     # If traceparent is provided (e.g., from incoming message), use it
     if traceparent:
-        print(f"Using provided traceparent: {traceparent}")
-
         # Store execution ID with provided traceparent
         kv_key = f"execution.{traceparent}"
         if kv_store.get(kv_key) is None:
@@ -455,18 +469,14 @@ def set_execution_id(execution_id: str, traceparent: str = None) -> None:
         carrier = {}
         TraceContextTextMapPropagator().inject(carrier)
         extracted_traceparent = carrier.get("traceparent")
-        print(f"Extracted from active span: {extracted_traceparent}")
     else:
         # Only create new span if absolutely necessary (no existing context)
-        print("No active span or existing context, creating new trace context")
         tracer = trace.get_tracer(__name__)
         with tracer.start_as_current_span("set_execution_id"):
             carrier = {}
             TraceContextTextMapPropagator().inject(carrier)
             extracted_traceparent = carrier.get("traceparent")
 
-    print("Final traceparent:", extracted_traceparent)
-
     # Store execution ID with traceparent as key
     if extracted_traceparent:
         kv_key = f"execution.{extracted_traceparent}"

{ioa_observe_sdk-1.0.3 → ioa_observe_sdk-1.0.5}/ioa_observe_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ioa-observe-sdk
-Version: 1.0.3
+Version: 1.0.5
 Summary: IOA Observability SDK
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -90,6 +90,7 @@ IOA observability SDK for your multi-agentic application.
 ## Table of Contents
 
 - [Installation](#installation)
+- [Schema](#schema)
 - [Dev](#dev)
 - [Testing](#testing)
 - [Getting Started](#getting-started)
@@ -109,6 +110,13 @@ Alternatively, to download the SDK from git, you could also use the following co
 uv add "git+https://github.com/agntcy/observe"
 ```
 
+## Schema
+
+The AGNTCY observability schema is an extension of the OTel LLM Semantic Conventions for Generative AI systems.
+This schema is designed to provide comprehensive observability for Multi-Agent Systems (MAS).
+
+Link: [AGNTCY Observability Schema](https://github.com/agntcy/observe/blob/main/schema/)
+
 ## Dev
 
 To get started with development, start a Clickhouse DB and an OTel collector container locally using docker-compose like so:
@@ -152,7 +160,7 @@ To run the unit tests, ensure you have the `OPENAI_API_KEY` set in your environm
 OPENAI_API_KEY=<KEY> make test
 ```
 
-## Getting Started
+## 🚀 Getting Started
 
 For getting started with the SDK, please refer to the [Getting Started](https://github.com/agntcy/observe/blob/main/GETTING-STARTED.md)
  file. It contains detailed instructions on how to set up and use the SDK effectively.

{ioa_observe_sdk-1.0.3 → ioa_observe_sdk-1.0.5}/ioa_observe_sdk.egg-info/SOURCES.txt

@@ -32,6 +32,7 @@ ioa_observe/sdk/metrics/agents/tracker.py
 ioa_observe/sdk/tracing/__init__.py
 ioa_observe/sdk/tracing/content_allow_list.py
 ioa_observe/sdk/tracing/context_manager.py
+ioa_observe/sdk/tracing/context_utils.py
 ioa_observe/sdk/tracing/manual.py
 ioa_observe/sdk/tracing/tracing.py
 ioa_observe/sdk/utils/__init__.py

{ioa_observe_sdk-1.0.3 → ioa_observe_sdk-1.0.5}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ioa-observe-sdk"
-version = "1.0.3"
+version = "1.0.5"
 description = "IOA Observability SDK"
 readme = "README.md"
 requires-python = ">=3.10"