netra-sdk 0.1.26__py3-none-any.whl → 0.1.29__py3-none-any.whl

netra/__init__.py

@@ -1,7 +1,12 @@
+import atexit
 import logging
 import threading
 from typing import Any, Dict, Optional, Set
 
+from opentelemetry import context as context_api
+from opentelemetry import trace
+from opentelemetry.trace import SpanKind
+
 from netra.instrumentation.instruments import InstrumentSet, NetraInstruments
 
 from .config import Config
@@ -12,7 +17,10 @@ from .session_manager import SessionManager
 from .span_wrapper import ActionModel, SpanWrapper, UsageModel
 from .tracer import Tracer
 
+# Package-level logger. Attach NullHandler by default so library does not emit logs
+# unless explicitly enabled by the user via debug_mode.
 logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
 
 
 class Netra:
@@ -24,6 +32,8 @@ class Netra:
     _initialized = False
     # Use RLock so the thread that already owns the lock can re-acquire it safely
     _init_lock = threading.RLock()
+    _root_span = None
+    _root_ctx_token = None
 
     @classmethod
     def is_initialized(cls) -> bool:
@@ -42,6 +52,8 @@ class Netra:
         headers: Optional[str] = None,
         disable_batch: Optional[bool] = None,
         trace_content: Optional[bool] = None,
+        debug_mode: Optional[bool] = None,
+        enable_root_span: Optional[bool] = None,
         resource_attributes: Optional[Dict[str, Any]] = None,
         environment: Optional[str] = None,
         instruments: Optional[Set[NetraInstruments]] = None,
@@ -61,10 +73,32 @@ class Netra:
                 headers=headers,
                 disable_batch=disable_batch,
                 trace_content=trace_content,
+                debug_mode=debug_mode,
+                enable_root_span=enable_root_span,
                 resource_attributes=resource_attributes,
                 environment=environment,
             )
 
+            # Configure package logging based on debug mode
+            pkg_logger = logging.getLogger("netra")
+            # Prevent propagating to root to avoid duplicate logs
+            pkg_logger.propagate = False
+            # Clear existing handlers to avoid duplicates across repeated init attempts
+            pkg_logger.handlers.clear()
+            if cfg.debug_mode:
+                pkg_logger.setLevel(logging.DEBUG)
+                handler = logging.StreamHandler()
+                formatter = logging.Formatter(
+                    fmt="%(asctime)s | %(levelname)s | %(name)s | %(message)s",
+                    datefmt="%Y-%m-%d %H:%M:%S",
+                )
+                handler.setFormatter(formatter)
+                pkg_logger.addHandler(handler)
+            else:
+                # Silence SDK logs entirely unless debug is enabled
+                pkg_logger.setLevel(logging.CRITICAL)
+                pkg_logger.addHandler(logging.NullHandler())
+
             # Initialize tracer (OTLP exporter, span processor, resource)
             Tracer(cfg)
 
@@ -81,6 +115,61 @@ class Netra:
             cls._initialized = True
             logger.info("Netra successfully initialized.")
 
+            # Create and attach a long-lived root span if enabled
+            if cfg.enable_root_span:
+                tracer = trace.get_tracer("netra.root.span")
+                root_name = f"{Config.LIBRARY_NAME}.root.span"
+                root_span = tracer.start_span(root_name, kind=SpanKind.INTERNAL)
+                # Add useful attributes
+                if cfg.app_name:
+                    root_span.set_attribute("service.name", cfg.app_name)
+                root_span.set_attribute("netra.environment", cfg.environment)
+                root_span.set_attribute("netra.library.version", Config.LIBRARY_VERSION)
+
+                # Attach span to current context so subsequent spans become its children
+                ctx = trace.set_span_in_context(root_span)
+                token = context_api.attach(ctx)
+
+                # Save for potential shutdown/cleanup and session tracking
+                cls._root_span = root_span
+                cls._root_ctx_token = token
+                try:
+                    SessionManager.set_current_span(root_span)
+                except Exception:
+                    pass
+                logger.info("Netra root span created and attached to context.")
+
+                # Ensure cleanup at process exit
+                atexit.register(cls.shutdown)
+
+    @classmethod
+    def shutdown(cls) -> None:
+        """Optional cleanup to end the root span and detach context."""
+        with cls._init_lock:
+            if cls._root_ctx_token is not None:
+                try:
+                    context_api.detach(cls._root_ctx_token)
+                except Exception:
+                    pass
+                finally:
+                    cls._root_ctx_token = None
+            if cls._root_span is not None:
+                try:
+                    cls._root_span.end()
+                except Exception:
+                    pass
+                finally:
+                    cls._root_span = None
+            # Try to flush and shutdown the tracer provider to ensure export
+            try:
+                provider = trace.get_tracer_provider()
+                if hasattr(provider, "force_flush"):
+                    provider.force_flush()
+                if hasattr(provider, "shutdown"):
+                    provider.shutdown()
+            except Exception:
+                pass
+
     @classmethod
     def set_session_id(cls, session_id: str) -> None:
         """

netra/config.py

@@ -16,6 +16,8 @@ class Config:
       - headers:                 Additional headers (W3C Correlation-Context format)
       - disable_batch:           Whether to disable batch span processor (bool)
       - trace_content:           Whether to capture prompt/completion content (bool)
+      - debug_mode:              Whether to enable SDK logging; default False (bool)
+      - enable_root_span:        Whether to create a process root span; default False (bool)
       - resource_attributes:     Custom resource attributes dict (e.g., {'env': 'prod', 'version': '1.0.0'})
     """
 
@@ -30,6 +32,8 @@ class Config:
         headers: Optional[str] = None,
         disable_batch: Optional[bool] = None,
         trace_content: Optional[bool] = None,
+        debug_mode: Optional[bool] = None,
+        enable_root_span: Optional[bool] = None,
         resource_attributes: Optional[Dict[str, Any]] = None,
         environment: Optional[str] = None,
     ):
@@ -91,12 +95,26 @@ class Config:
         else:
             os.environ["TRACELOOP_TRACE_CONTENT"] = "true"
 
+        # Debug mode: enable SDK logging only when True. Default False.
+        if debug_mode is not None:
+            self.debug_mode = debug_mode
+        else:
+            env_dbg = os.getenv("NETRA_DEBUG")
+            self.debug_mode = True if (env_dbg is not None and env_dbg.lower() in ("1", "true")) else False
+
         # 7. Environment: param override, else env
         if environment is not None:
             self.environment = environment
         else:
             self.environment = os.getenv("NETRA_ENV", "local")
 
+        # Enable a long-lived root span for the process? Default False.
+        if enable_root_span is not None:
+            self.enable_root_span = enable_root_span
+        else:
+            env_root = os.getenv("NETRA_ENABLE_ROOT_SPAN")
+            self.enable_root_span = True if (env_root is not None and env_root.lower() in ("1", "true")) else False
+
         # Resource attributes: param override, else parse JSON from env, else empty dict
         if resource_attributes is not None:
             self.resource_attributes = resource_attributes

netra/decorators.py

@@ -176,3 +176,18 @@ def task(
     if target is not None:
         return decorator(target)
     return decorator
+
+
+def span(
+    target: Union[Callable[P, R], C, None] = None, *, name: Optional[str] = None
+) -> Union[Callable[P, R], C, Callable[[Callable[P, R]], Callable[P, R]]]:
+    def decorator(obj: Union[Callable[P, R], C]) -> Union[Callable[P, R], C]:
+        if inspect.isclass(obj):
+            return _wrap_class_methods(cast(C, obj), "span", name)
+        else:
+            # When obj is a function, it should be type Callable[P, R]
+            return _create_function_wrapper(cast(Callable[P, R], obj), "span", name)
+
+    if target is not None:
+        return decorator(target)
+    return decorator

netra/session_manager.py

@@ -26,6 +26,7 @@ class SessionManager:
     _workflow_stack: List[str] = []
     _task_stack: List[str] = []
     _agent_stack: List[str] = []
+    _span_stack: List[str] = []
 
     @classmethod
     def set_current_span(cls, span: Optional[trace.Span]) -> None:
@@ -53,7 +54,7 @@ class SessionManager:
         Push an entity onto the appropriate entity stack.
 
         Args:
-            entity_type: Type of entity (workflow, task, agent)
+            entity_type: Type of entity (workflow, task, agent, span)
             entity_name: Name of the entity
         """
         if entity_type == "workflow":
@@ -62,6 +63,8 @@ class SessionManager:
             cls._task_stack.append(entity_name)
         elif entity_type == "agent":
             cls._agent_stack.append(entity_name)
+        elif entity_type == "span":
+            cls._span_stack.append(entity_name)
 
     @classmethod
     def pop_entity(cls, entity_type: str) -> Optional[str]:
@@ -69,7 +72,7 @@ class SessionManager:
         Pop the most recent entity from the specified entity stack.
 
         Args:
-            entity_type: Type of entity (workflow, task, agent)
+            entity_type: Type of entity (workflow, task, agent, span)
 
         Returns:
             Entity name or None if stack is empty
@@ -80,6 +83,8 @@ class SessionManager:
             return cls._task_stack.pop()
         elif entity_type == "agent" and cls._agent_stack:
             return cls._agent_stack.pop()
+        elif entity_type == "span" and cls._span_stack:
+            return cls._span_stack.pop()
         return None
 
     @classmethod
@@ -104,6 +109,10 @@ class SessionManager:
         if cls._agent_stack:
             attributes[f"{Config.LIBRARY_NAME}.agent.name"] = cls._agent_stack[-1]
 
+        # Add current span if exists
+        if cls._span_stack:
+            attributes[f"{Config.LIBRARY_NAME}.span.name"] = cls._span_stack[-1]
+
         return attributes
 
     @classmethod
@@ -112,6 +121,7 @@ class SessionManager:
         cls._workflow_stack.clear()
         cls._task_stack.clear()
         cls._agent_stack.clear()
+        cls._span_stack.clear()
 
     @classmethod
     def get_stack_info(cls) -> Dict[str, List[str]]:
@@ -125,6 +135,7 @@ class SessionManager:
             "workflows": cls._workflow_stack.copy(),
             "tasks": cls._task_stack.copy(),
             "agents": cls._agent_stack.copy(),
+            "spans": cls._span_stack.copy(),
         }
 
     @staticmethod

netra/version.py

@@ -1 +1 @@
-__version__ = "0.1.26"
+__version__ = "0.1.29"

{netra_sdk-0.1.26.dist-info → netra_sdk-0.1.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: netra-sdk
-Version: 0.1.26
+Version: 0.1.29
 Summary: A Python SDK for AI application observability that provides OpenTelemetry-based monitoring, tracing, and PII protection for LLM and vector database applications. Enables easy instrumentation, session tracking, and privacy-focused data collection for AI systems in production environments.
 License: Apache-2.0
 Keywords: netra,tracing,observability,sdk,ai,llm,vector,database
@@ -173,7 +173,7 @@ Netra.init(
 Use decorators to automatically trace your functions and classes:
 
 ```python
-from netra.decorators import workflow, agent, task
+from netra.decorators import workflow, agent, task, span
 
 @workflow
 def data_processing_workflow(data):
@@ -191,6 +191,11 @@ def data_validation_task(data):
     """Task for validating input data"""
     return validate_schema(data)
 
+@span
+def data_processing_span(data):
+    """Span for processing data"""
+    return process_data(data)
+
 # Works with async functions too
 @workflow(name="Async Data Pipeline")
 async def async_workflow(data):
@@ -205,6 +210,16 @@ class CustomerSupportAgent:
 
     def escalate_issue(self, issue):
         return self.forward_to_human(issue)
+
+@task
+async def async_task(data):
+    """Task for processing data"""
+    return await process_data_async(data)
+
+@span
+async def async_span(data):
+    """Span for processing data"""
+    return await process_data_async(data)
 ```
 
 ## 🔍 Supported Instrumentations

{netra_sdk-0.1.26.dist-info → netra_sdk-0.1.29.dist-info}/RECORD

@@ -1,10 +1,10 @@
-netra/__init__.py,sha256=kKhZn-h8cMAmTzLFIwvtlWBZ_t0CxnTe_XRunQYA9Xk,5764
+netra/__init__.py,sha256=EIMbq0ycEIolmyk7uGXkmgvydfWArNk-soBIEQijsiY,9612
 netra/anonymizer/__init__.py,sha256=KeGPPZqKVZbtkbirEKYTYhj6aZHlakjdQhD7QHqBRio,133
 netra/anonymizer/anonymizer.py,sha256=IcrYkdwWrFauGWUeAW-0RwrSUM8VSZCFNtoywZhvIqU,3778
 netra/anonymizer/base.py,sha256=ytPxHCUD2OXlEY6fNTuMmwImNdIjgj294I41FIgoXpU,5946
 netra/anonymizer/fp_anonymizer.py,sha256=_6svIYmE0eejdIMkhKBUWCNjGtGimtrGtbLvPSOp8W4,6493
-netra/config.py,sha256=S9GsCvwtakrmryAaV-AhyVB_wAQ6tjwPLLZQemLgXko,5006
-netra/decorators.py,sha256=V_WpZ2IgW2Y7B_WnSXmKUGGhkM5Cra2TwONddmJpPaI,6837
+netra/config.py,sha256=zmTssfUExG8viSMKN9Yfd8i--7S4oUQT8IyvwAI4C2U,5950
+netra/decorators.py,sha256=TqORBs0Xv_CZHOAwrWkpvscMj4FgOJsgo1CRYoG6C7Y,7435
 netra/exceptions/__init__.py,sha256=uDgcBxmC4WhdS7HRYQk_TtJyxH1s1o6wZmcsnSHLAcM,174
 netra/exceptions/injection.py,sha256=ke4eUXRYUFJkMZgdSyPPkPt5PdxToTI6xLEBI0hTWUQ,1332
 netra/exceptions/pii.py,sha256=MT4p_x-zH3VtYudTSxw1Z9qQZADJDspq64WrYqSWlZc,2438
@@ -40,11 +40,11 @@ netra/pii.py,sha256=Rn4SjgTJW_aw9LcbjLuMqF3fKd9b1ndlYt1CaK51Ge0,33125
 netra/processors/__init__.py,sha256=wfnSskRBtMT90hO7LqFJoEW374LgoH_gnTxhynqtByI,109
 netra/processors/session_span_processor.py,sha256=qcsBl-LnILWefsftI8NQhXDGb94OWPc8LvzhVA0JS_c,2432
 netra/scanner.py,sha256=kyDpeZiscCPb6pjuhS-sfsVj-dviBFRepdUWh0sLoEY,11554
-netra/session_manager.py,sha256=EVcnWcSj4NdkH--HmqHx0mmzivQiM4GCyFLu6lwi33M,6252
+netra/session_manager.py,sha256=Ks8A6B9RYe0tV8PeWYuN0M-UMZqa47uquuw6D7C1vCE,6701
 netra/span_wrapper.py,sha256=ec2WLYTRLZ02WSSCYEsMn1PgUGVji9rFyq_CRCV9rog,7388
 netra/tracer.py,sha256=In5QPVLz_6BxrolWpav9EuR9_hirD2UUIlyY75QUaKk,3450
-netra/version.py,sha256=3_QdGLpuk_SDY7k9PpNcHpSTjlPdhadPiEgF82wzkqk,23
-netra_sdk-0.1.26.dist-info/LICENCE,sha256=8B_UoZ-BAl0AqiHAHUETCgd3I2B9yYJ1WEQtVb_qFMA,11359
-netra_sdk-0.1.26.dist-info/METADATA,sha256=nEwz2GIkEzknb3eHQ16FePJnBQTErj3W8U6kpO4GxdY,27817
-netra_sdk-0.1.26.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-netra_sdk-0.1.26.dist-info/RECORD,,
+netra/version.py,sha256=A-lFHZ4YpCrWZ6nw3tlt_yurFJ00mInm3gR6hz51Eww,23
+netra_sdk-0.1.29.dist-info/LICENCE,sha256=8B_UoZ-BAl0AqiHAHUETCgd3I2B9yYJ1WEQtVb_qFMA,11359
+netra_sdk-0.1.29.dist-info/METADATA,sha256=XKGT69ygEEA6hbSinO1heKikakeIngiMqotgwQbFyeQ,28151
+netra_sdk-0.1.29.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+netra_sdk-0.1.29.dist-info/RECORD,,