netra-sdk 0.1.0__py3-none-any.whl

netra/session.py

@@ -0,0 +1,185 @@
+import logging
+import time
+from typing import Any, Dict, Literal, Optional
+
+from opentelemetry import context as context_api
+from opentelemetry import trace
+from opentelemetry.trace import SpanKind, Status, StatusCode
+from opentelemetry.trace.propagation import set_span_in_context
+
+# Configure logging
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+class ATTRIBUTE:
+    LLM_SYSTEM = "llm_system"
+    MODEL = "model"
+    PROMPT = "prompt"
+    NEGATIVE_PROMPT = "negative_prompt"
+    IMAGE_HEIGHT = "image_height"
+    IMAGE_WIDTH = "image_width"
+    TOKENS = "tokens"
+    CREDITS = "credits"
+    COST = "cost"
+    STATUS = "status"
+    DURATION_MS = "duration_ms"
+    ERROR_MESSAGE = "error_message"
+
+
+class Session:
+    """
+    Context manager for tracking observability data for external API calls.
+
+    Usage:
+        with combat.start_session("video_gen_task") as session:
+            session.set_prompt("A cat playing piano").set_image_height("1024")
+
+            # External API call
+            result = external_api.generate_video(...)
+
+            session.set_tokens("20").set_credits("30")
+    """
+
+    def __init__(self, name: str, attributes: Optional[Dict[str, str]] = None, module_name: str = "combat_sdk"):
+        self.name = name
+        self.attributes = attributes or {}
+        self.start_time: Optional[float] = None
+        self.end_time: Optional[float] = None
+        self.status = "pending"
+        self.error_message: Optional[str] = None
+        self.module_name = module_name
+
+        # OpenTelemetry span management
+        self.tracer = trace.get_tracer(module_name)
+        self.span: Optional[trace.Span] = None
+        self.context_token: Optional[Any] = None
+
+    def __enter__(self) -> "Session":
+        """Start the session, begin time tracking, and create OpenTelemetry span."""
+        self.start_time = time.time()
+
+        # Create OpenTelemetry span
+        self.span = self.tracer.start_span(name=self.name, kind=SpanKind.CLIENT, attributes=self.attributes)
+
+        # Set span in context
+        ctx = set_span_in_context(self.span)
+        self.context_token = context_api.attach(ctx)
+
+        logger.info(f"Started session: {self.name}")
+        return self
+
+    def __exit__(self, exc_type: Optional[type], exc_val: Optional[Exception], exc_tb: Any) -> Literal[False]:
+        """End the session, calculate duration, handle errors, and close OpenTelemetry span."""
+        self.end_time = time.time()
+        duration_ms = (self.end_time - self.start_time) * 1000 if self.start_time is not None else None
+
+        # Set duration
+        if duration_ms is not None:
+            self.set_attribute(ATTRIBUTE.DURATION_MS, str(round(duration_ms, 2)))
+
+        # Handle status and errors
+        if exc_type is None and self.status == "pending":
+            self.status = "success"
+            if self.span:
+                self.span.set_status(Status(StatusCode.OK))
+        elif exc_type is not None:
+            self.status = "error"
+            self.error_message = str(exc_val)
+            self.set_attribute(ATTRIBUTE.ERROR_MESSAGE, self.error_message)
+            if self.span:
+                self.span.set_status(Status(StatusCode.ERROR, self.error_message))
+                if exc_val is not None:
+                    self.span.record_exception(exc_val)
+            logger.error(f"Session {self.name} failed: {self.error_message}")
+
+        self.set_attribute(ATTRIBUTE.STATUS, self.status)
+
+        # Update span attributes with final values
+        if self.span:
+            for key, value in self.attributes.items():
+                self.span.set_attribute(key, value)
+
+        # End OpenTelemetry span and detach context
+        if self.span:
+            self.span.end()
+        if self.context_token:
+            context_api.detach(self.context_token)
+
+        logger.info(
+            f"Ended session: {self.name} (Status: {self.status}, Duration: {duration_ms:.2f}ms)"
+            if duration_ms is not None
+            else f"Ended session: {self.name} (Status: {self.status})"
+        )
+
+        # Don't suppress exceptions
+        return False
+
+    def set_attribute(self, key: str, value: str) -> "Session":
+        """Set a single attribute and return self for method chaining."""
+        self.attributes[key] = value
+        # Also set on the span if it exists
+        if self.span:
+            self.span.set_attribute(key, value)
+        return self
+
+    def set_prompt(self, prompt: str) -> "Session":
+        """Set the input prompt."""
+        return self.set_attribute(ATTRIBUTE.PROMPT, prompt)
+
+    def set_negative_prompt(self, negative_prompt: str) -> "Session":
+        """Set the negative prompt."""
+        return self.set_attribute(ATTRIBUTE.NEGATIVE_PROMPT, negative_prompt)
+
+    def set_image_height(self, height: str) -> "Session":
+        """Set the image height."""
+        return self.set_attribute(ATTRIBUTE.IMAGE_HEIGHT, height)
+
+    def set_image_width(self, width: str) -> "Session":
+        """Set the image width."""
+        return self.set_attribute(ATTRIBUTE.IMAGE_WIDTH, width)
+
+    def set_tokens(self, tokens: str) -> "Session":
+        """Set the number of tokens used."""
+        return self.set_attribute(ATTRIBUTE.TOKENS, tokens)
+
+    def set_credits(self, credits: str) -> "Session":
+        """Set the number of credits used."""
+        return self.set_attribute(ATTRIBUTE.CREDITS, credits)
+
+    def set_cost(self, cost: str) -> "Session":
+        """Set the cost of the operation."""
+        return self.set_attribute(ATTRIBUTE.COST, cost)
+
+    def set_model(self, model: str) -> "Session":
+        """Set the model used."""
+        return self.set_attribute(ATTRIBUTE.MODEL, model)
+
+    def set_llm_system(self, system: str) -> "Session":
+        """Set the LLM system used."""
+        return self.set_attribute(ATTRIBUTE.LLM_SYSTEM, system)
+
+    def set_error(self, error_message: str) -> "Session":
+        """Manually set an error message."""
+        self.status = "error"
+        self.error_message = error_message
+        if self.span:
+            self.span.set_status(Status(StatusCode.ERROR, error_message))
+        return self.set_attribute(ATTRIBUTE.ERROR_MESSAGE, error_message)
+
+    def set_success(self) -> "Session":
+        """Manually mark the session as successful."""
+        self.status = "success"
+        if self.span:
+            self.span.set_status(Status(StatusCode.OK))
+        return self
+
+    def add_event(self, name: str, attributes: Optional[Dict[str, str]] = None) -> "Session":
+        """Add an event to the span."""
+        if self.span:
+            self.span.add_event(name, attributes or {})
+        return self
+
+    def get_current_span(self) -> Optional[trace.Span]:
+        """Get the current OpenTelemetry span."""
+        return self.span

netra/session_manager.py

@@ -0,0 +1,96 @@
+"""
+Session management for PromptOps SDK.
+Handles automatic session and user ID management for applications.
+"""
+
+import logging
+from datetime import datetime
+from typing import Any, Dict, Optional, Union
+
+from opentelemetry import baggage
+from opentelemetry import context as otel_context
+from opentelemetry import trace
+
+from .config import Config
+
+logger = logging.getLogger(__name__)
+
+
+class SessionManager:
+    """Manages session and user context for applications."""
+
+    # Class variable to track the current span
+    _current_span: Optional[trace.Span] = None
+
+    @classmethod
+    def set_current_span(cls, span: Optional[trace.Span]) -> None:
+        """
+        Set the current span for the session manager.
+
+        Args:
+            span: The current span to store
+        """
+        cls._current_span = span
+
+    @classmethod
+    def get_current_span(cls) -> Optional[trace.Span]:
+        """
+        Get the current span.
+
+        Returns:
+            The stored current span or None if not set
+        """
+        return cls._current_span
+
+    @staticmethod
+    def set_session_context(session_key: str, value: Union[str, Dict[str, str]]) -> None:
+        """
+        Set session context attributes in the current OpenTelemetry baggage.
+
+        Args:
+            session_key: Key to set in baggage (session_id, user_id, tenant_id, or custom_attributes)
+            value: Value to set for the key
+        """
+        try:
+            ctx = otel_context.get_current()
+            if isinstance(value, str) and value:
+                if session_key == "session_id":
+                    ctx = baggage.set_baggage("session_id", value, ctx)
+                elif session_key == "user_id":
+                    ctx = baggage.set_baggage("user_id", value, ctx)
+                elif session_key == "tenant_id":
+                    ctx = baggage.set_baggage("tenant_id", value, ctx)
+            elif isinstance(value, dict) and value:
+                if session_key == "custom_attributes":
+                    custom_keys = list(value.keys())
+                    ctx = baggage.set_baggage("custom_keys", ",".join(custom_keys), ctx)
+                    for key, val in value.items():
+                        ctx = baggage.set_baggage(f"custom.{key}", str(val), ctx)
+            otel_context.attach(ctx)
+        except Exception as e:
+            logger.exception(f"Failed to set session context for key={session_key}: {e}")
+
+    @staticmethod
+    def set_custom_event(name: str, attributes: Dict[str, Any]) -> None:
+        """
+        Add an event to the current span.
+
+        Args:
+            name: Name of the event (e.g., 'pii_detection', 'error', etc.)
+            attributes: Dictionary of attributes associated with the event
+        """
+        try:
+            current_span = SessionManager.get_current_span()
+            timestamp_ns = int(datetime.now().timestamp() * 1_000_000_000)
+
+            if current_span:
+                # Set the event in the current span.
+                current_span.add_event(name=name, attributes=attributes, timestamp=timestamp_ns)
+            else:
+                # Fallback to creating a new span.
+                ctx = otel_context.get_current()
+                tracer = trace.get_tracer(__name__)
+                with tracer.start_as_current_span(f"{Config.LIBRARY_NAME}.{name}", context=ctx) as span:
+                    span.add_event(name=name, attributes=attributes, timestamp=timestamp_ns)
+        except Exception as e:
+            logger.exception(f"Failed to add custom event: {name} - {e}")

netra/tracer.py

@@ -0,0 +1,99 @@
+"""Netra OpenTelemetry tracer configuration module.
+
+This module handles the initialization and configuration of OpenTelemetry tracing,
+including exporter setup and span processor configuration.
+"""
+
+import logging
+from typing import Any, Dict
+
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.resources import DEPLOYMENT_ENVIRONMENT, SERVICE_NAME, Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import (
+    BatchSpanProcessor,
+    ConsoleSpanExporter,
+    SimpleSpanProcessor,
+)
+
+from netra.config import Config
+
+logger = logging.getLogger(__name__)
+
+
+class Tracer:
+    """
+    Configures Netra's OpenTelemetry tracer with OTLP exporter (or Console exporter as fallback)
+    and appropriate span processor.
+    """
+
+    def __init__(self, cfg: Config) -> None:
+        """Initialize the Netra tracer with the provided configuration.
+
+        Args:
+            cfg: Configuration object with tracer settings
+        """
+        self.cfg = cfg
+        self._setup_tracer()
+
+    def _setup_tracer(self) -> None:
+        """Set up the OpenTelemetry tracer with appropriate exporters and processors.
+
+        Creates a resource with service name and custom attributes,
+        configures the appropriate exporter (OTLP or Console fallback),
+        and sets up either a batch or simple span processor based on configuration.
+        """
+        # Create Resource with service.name + custom attributes
+        resource_attrs: Dict[str, Any] = {
+            SERVICE_NAME: self.cfg.app_name,
+            DEPLOYMENT_ENVIRONMENT: self.cfg.environment,
+        }
+        if self.cfg.resource_attributes:
+            resource_attrs.update(self.cfg.resource_attributes)
+        resource = Resource(attributes=resource_attrs)
+
+        # Build TracerProvider
+        provider = TracerProvider(resource=resource)
+
+        # Configure exporter based on configuration
+        if not self.cfg.otlp_endpoint:
+            logger.warning("OTLP endpoint not provided, falling back to console exporter")
+            exporter = ConsoleSpanExporter()
+        else:
+            exporter = OTLPSpanExporter(
+                endpoint=self._format_endpoint(self.cfg.otlp_endpoint),
+                headers=self.cfg.headers,
+            )
+        # Add span processors for session span processing and data aggregation processing
+        from netra.processors import SessionSpanProcessor, SpanAggregationProcessor
+
+        provider.add_span_processor(SessionSpanProcessor())
+        provider.add_span_processor(SpanAggregationProcessor())
+
+        # Install appropriate span processor
+        if self.cfg.disable_batch:
+            provider.add_span_processor(SimpleSpanProcessor(exporter))
+        else:
+            provider.add_span_processor(BatchSpanProcessor(exporter))
+
+        # Set global tracer provider
+        trace.set_tracer_provider(provider)
+        logger.info(
+            "Netra TracerProvider initialized: endpoint=%s, disable_batch=%s",
+            self.cfg.otlp_endpoint,
+            self.cfg.disable_batch,
+        )
+
+    def _format_endpoint(self, endpoint: str) -> str:
+        """Format the OTLP endpoint URL to ensure it ends with '/v1/traces'.
+
+        Args:
+            endpoint: Base OTLP endpoint URL
+
+        Returns:
+            Properly formatted endpoint URL
+        """
+        if not endpoint.endswith("/v1/traces"):
+            return endpoint.rstrip("/") + "/v1/traces"
+        return endpoint

netra/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

netra_sdk-0.1.0.dist-info/LICENCE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2025 KeyValue Software Systems
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.