nvidia-nat-opentelemetry 1.3.0a20250904__py3-none-any.whl → 1.3.0a20250909__py3-none-any.whl

nat/plugins/opentelemetry/__init__.py

@@ -12,3 +12,13 @@
 # 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.
+
+from nat.plugins.opentelemetry.otel_span_exporter import OtelSpanExporter
+from nat.plugins.opentelemetry.otlp_span_adapter_exporter import OTLPSpanAdapterExporter
+from nat.plugins.opentelemetry.otlp_span_redaction_adapter_exporter import OTLPSpanHeaderRedactionAdapterExporter
+
+__all__ = [
+    "OTLPSpanHeaderRedactionAdapterExporter",
+    "OTLPSpanAdapterExporter",
+    "OtelSpanExporter",
+]

nat/plugins/opentelemetry/otlp_span_redaction_adapter_exporter.py

@@ -0,0 +1,144 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+import logging
+from collections.abc import Callable
+
+from nat.builder.context import ContextState
+from nat.observability.mixin.tagging_config_mixin import PrivacyLevel
+from nat.observability.processor.header_redaction_processor import HeaderRedactionProcessor
+from nat.observability.processor.span_tagging_processor import SpanTaggingProcessor
+from nat.plugins.opentelemetry.otlp_span_adapter_exporter import OTLPSpanAdapterExporter
+
+logger = logging.getLogger(__name__)
+
+
+class OTLPSpanHeaderRedactionAdapterExporter(OTLPSpanAdapterExporter):
+    """An OpenTelemetry OTLP span exporter with built-in redaction and privacy tagging.
+
+    This class extends OTLPSpanAdapterExporter to provide automatic span redaction
+    and privacy tagging capabilities. It automatically adds header-based redaction
+    and span tagging processors to the processing pipeline.
+
+    Key Features:
+    - Header-based span redaction with configurable callback logic
+    - Privacy level tagging for compliance and governance
+    - Complete span processing pipeline (IntermediateStep → Span → Redaction → Tagging → OtelSpan → Batching → Export)
+    - Batching support for efficient transmission
+    - OTLP HTTP protocol for maximum compatibility
+    - Configurable authentication via headers
+    - Resource attribute management
+    - Error handling and retry logic
+
+    The redaction processor allows conditional redaction based on authentication headers,
+    while the tagging processor adds privacy-level metadata to spans for downstream
+    processing and compliance tracking.
+
+    This exporter is commonly used with services like:
+    - OpenTelemetry Collector
+    - DataDog (OTLP endpoint)
+    - Jaeger (OTLP endpoint)
+    - Grafana Tempo
+    - Custom OTLP-compatible backends
+
+    Example:
+        def should_redact(auth_key: str) -> bool:
+            return auth_key in ["sensitive_user", "test_user"]
+
+        exporter = OTLPSpanRedactionAdapterExporter(
+            endpoint="https://api.service.com/v1/traces",
+            headers={"Authorization": "Bearer your-token"},
+            redaction_attributes=["user.email", "request.body"],
+            redaction_header="x-user-id",
+            redaction_callback=should_redact,
+            redaction_value="REDACTED",
+            privacy_tag_key="privacy.level",
+            privacy_tag_value=PrivacyLevel.HIGH,
+            batch_size=50,
+            flush_interval=10.0
+        )
+    """
+
+    def __init__(
+            self,
+            *,
+            # OtelSpanExporter args
+            context_state: ContextState | None = None,
+            batch_size: int = 100,
+            flush_interval: float = 5.0,
+            max_queue_size: int = 1000,
+            drop_on_overflow: bool = False,
+            shutdown_timeout: float = 10.0,
+            resource_attributes: dict[str, str] | None = None,
+            # Redaction args
+            redaction_attributes: list[str] | None = None,
+            redaction_header: str | None = None,
+            redaction_callback: Callable[[str], bool] | None = None,
+            redaction_enabled: bool = False,
+            force_redaction: bool = False,
+            redaction_value: str = "[REDACTED]",
+            privacy_tag_key: str | None = None,
+            privacy_tag_value: PrivacyLevel | None = None,
+            # OTLPSpanExporterMixin args
+            endpoint: str,
+            headers: dict[str, str] | None = None,
+            **otlp_kwargs):
+        """Initialize the OTLP span exporter with redaction and tagging capabilities.
+
+        Args:
+            context_state: The context state for the exporter.
+            batch_size: Number of spans to batch before exporting.
+            flush_interval: Time in seconds between automatic batch flushes.
+            max_queue_size: Maximum number of spans to queue.
+            drop_on_overflow: Whether to drop spans when queue is full.
+            shutdown_timeout: Maximum time to wait for export completion during shutdown.
+            resource_attributes: Additional resource attributes for spans.
+            redaction_attributes: List of span attribute keys to redact when conditions are met.
+            redaction_header: Header key to check for authentication/user identification.
+            redaction_callback: Function to determine if spans should be redacted based on header value.
+            redaction_enabled: Whether the redaction processor is enabled.
+            force_redaction: If True, always redact regardless of header checks.
+            redaction_value: Value to replace redacted attributes with.
+            privacy_tag_key: Key name for the privacy level tag to add to spans.
+            privacy_tag_value: Privacy level value to assign to spans.
+            endpoint: The endpoint for the OTLP service.
+            headers: The headers for the OTLP service.
+            **otlp_kwargs: Additional keyword arguments for the OTLP service.
+        """
+        super().__init__(context_state=context_state,
+                         batch_size=batch_size,
+                         flush_interval=flush_interval,
+                         max_queue_size=max_queue_size,
+                         drop_on_overflow=drop_on_overflow,
+                         shutdown_timeout=shutdown_timeout,
+                         resource_attributes=resource_attributes,
+                         endpoint=endpoint,
+                         headers=headers,
+                         **otlp_kwargs)
+
+        # Insert redaction and tagging processors to the front of the processing pipeline
+        self.add_processor(HeaderRedactionProcessor(attributes=redaction_attributes,
+                                                    header=redaction_header,
+                                                    callback=redaction_callback,
+                                                    enabled=redaction_enabled,
+                                                    force_redact=force_redaction,
+                                                    redaction_value=redaction_value),
+                           name="header_redaction",
+                           position=0)
+
+        self.add_processor(SpanTaggingProcessor(tag_key=privacy_tag_key,
+                                                tag_value=privacy_tag_value.value if privacy_tag_value else None),
+                           name="span_privacy_tagging",
+                           position=1)

nat/plugins/opentelemetry/register.py

@@ -42,7 +42,7 @@ async def langfuse_telemetry_exporter(config: LangfuseTelemetryExporter, builder
 
     import base64
 
-    from nat.plugins.opentelemetry.otlp_span_adapter_exporter import OTLPSpanAdapterExporter
+    from nat.plugins.opentelemetry import OTLPSpanAdapterExporter
 
     secret_key = config.secret_key or os.environ.get("LANGFUSE_SECRET_KEY")
     public_key = config.public_key or os.environ.get("LANGFUSE_PUBLIC_KEY")
@@ -78,7 +78,7 @@ class LangsmithTelemetryExporter(BatchConfigMixin, CollectorConfigMixin, Telemet
 async def langsmith_telemetry_exporter(config: LangsmithTelemetryExporter, builder: Builder):
     """Create a Langsmith telemetry exporter."""
 
-    from nat.plugins.opentelemetry.otlp_span_adapter_exporter import OTLPSpanAdapterExporter
+    from nat.plugins.opentelemetry import OTLPSpanAdapterExporter
 
     api_key = config.api_key or os.environ.get("LANGSMITH_API_KEY")
     if not api_key:
@@ -108,8 +108,8 @@ class OtelCollectorTelemetryExporter(BatchConfigMixin,
 async def otel_telemetry_exporter(config: OtelCollectorTelemetryExporter, builder: Builder):
     """Create an OpenTelemetry telemetry exporter."""
 
+    from nat.plugins.opentelemetry import OTLPSpanAdapterExporter
     from nat.plugins.opentelemetry.otel_span_exporter import get_opentelemetry_sdk_version
-    from nat.plugins.opentelemetry.otlp_span_adapter_exporter import OTLPSpanAdapterExporter
 
     # Default resource attributes
     default_resource_attributes = {
@@ -143,7 +143,7 @@ class PatronusTelemetryExporter(BatchConfigMixin, CollectorConfigMixin, Telemetr
 async def patronus_telemetry_exporter(config: PatronusTelemetryExporter, builder: Builder):
     """Create a Patronus telemetry exporter."""
 
-    from nat.plugins.opentelemetry.otlp_span_adapter_exporter import OTLPSpanAdapterExporter
+    from nat.plugins.opentelemetry import OTLPSpanAdapterExporter
 
     api_key = config.api_key or os.environ.get("PATRONUS_API_KEY")
     if not api_key:
@@ -175,7 +175,7 @@ class GalileoTelemetryExporter(BatchConfigMixin, CollectorConfigMixin, Telemetry
 async def galileo_telemetry_exporter(config: GalileoTelemetryExporter, builder: Builder):
     """Create a Galileo telemetry exporter."""
 
-    from nat.plugins.opentelemetry.otlp_span_adapter_exporter import OTLPSpanAdapterExporter
+    from nat.plugins.opentelemetry import OTLPSpanAdapterExporter
 
     headers = {
         "Galileo-API-Key": config.api_key,

{nvidia_nat_opentelemetry-1.3.0a20250904.dist-info → nvidia_nat_opentelemetry-1.3.0a20250909.dist-info}/METADATA

@@ -1,12 +1,15 @@
 Metadata-Version: 2.4
 Name: nvidia-nat-opentelemetry
-Version: 1.3.0a20250904
+Version: 1.3.0a20250909
 Summary: Subpackage for OpenTelemetry integration in NeMo Agent toolkit
 Keywords: ai,observability,opentelemetry
 Classifier: Programming Language :: Python
-Requires-Python: <3.13,>=3.11
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <3.14,>=3.11
 Description-Content-Type: text/markdown
-Requires-Dist: nvidia-nat==v1.3.0a20250904
+Requires-Dist: nvidia-nat==v1.3.0a20250909
 Requires-Dist: opentelemetry-api~=1.2
 Requires-Dist: opentelemetry-exporter-otlp~=1.3
 Requires-Dist: opentelemetry-sdk~=1.3

{nvidia_nat_opentelemetry-1.3.0a20250904.dist-info → nvidia_nat_opentelemetry-1.3.0a20250909.dist-info}/RECORD

@@ -1,14 +1,15 @@
 nat/meta/pypi.md,sha256=_o1o1BLPY1pvjCkklWxlm7LlIDMPCk-2Rho85NUuN8U,1109
-nat/plugins/opentelemetry/__init__.py,sha256=Xs1JQ16L9btwreh4pdGKwskffAw1YFO48jKrU4ib_7c,685
+nat/plugins/opentelemetry/__init__.py,sha256=j-YKuxwSIzGziyDyunw8s_W7WiFiqKLdFjw-utwHPFk,1079
 nat/plugins/opentelemetry/otel_span.py,sha256=v5Bzy4Cq51Sph5fKErZjt_UPfPXsVJx2qllj7c5afe4,16511
 nat/plugins/opentelemetry/otel_span_exporter.py,sha256=YO7JsQgi8Cf2OQBJ_s78HwJjrWx9SdqMvPen3Pa2_bI,6533
 nat/plugins/opentelemetry/otlp_span_adapter_exporter.py,sha256=C5MaZOB_ZijAbRZpRUtjpBsH0-FHeon81l5xAFlUKos,3945
-nat/plugins/opentelemetry/register.py,sha256=VnRHLcUIRYSW-IVm3A5BTnosoLW7M3TIdezuQoi6zYQ,9205
+nat/plugins/opentelemetry/otlp_span_redaction_adapter_exporter.py,sha256=rxbTcPCYPoLinseVId4jllVP9E5NHD2vgcsy4-NsE9E,7086
+nat/plugins/opentelemetry/register.py,sha256=IWPDQBIhHB7OcykOlCQ5RlMrVWjWQvoJwlgy6QCjir8,9070
 nat/plugins/opentelemetry/span_converter.py,sha256=Gz3KvRNQeEBBlpaPO8YRAJkw4fmzV7m9bT6dGX0IV2E,8846
 nat/plugins/opentelemetry/mixin/__init__.py,sha256=Xs1JQ16L9btwreh4pdGKwskffAw1YFO48jKrU4ib_7c,685
 nat/plugins/opentelemetry/mixin/otlp_span_exporter_mixin.py,sha256=stTer5KT6l2RA93_pexoU8WqhQLCnYbjyOhIMbDEwWk,2807
-nvidia_nat_opentelemetry-1.3.0a20250904.dist-info/METADATA,sha256=e7m8LljRwU5mLHYvHh_TGW5PODOVhLJHERG9uXasZEk,1580
-nvidia_nat_opentelemetry-1.3.0a20250904.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nvidia_nat_opentelemetry-1.3.0a20250904.dist-info/entry_points.txt,sha256=gmEKhCafyibUJLGxbn8luTK0UTgIvV2vAtr4uZ8M85I,72
-nvidia_nat_opentelemetry-1.3.0a20250904.dist-info/top_level.txt,sha256=8-CJ2cP6-f0ZReXe5Hzqp-5pvzzHz-5Ds5H2bGqh1-U,4
-nvidia_nat_opentelemetry-1.3.0a20250904.dist-info/RECORD,,
+nvidia_nat_opentelemetry-1.3.0a20250909.dist-info/METADATA,sha256=YoYxliOOfJsomMgjVwGJz-Rk2dqHPE6Mc5VDDo4_p-E,1733
+nvidia_nat_opentelemetry-1.3.0a20250909.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nvidia_nat_opentelemetry-1.3.0a20250909.dist-info/entry_points.txt,sha256=gmEKhCafyibUJLGxbn8luTK0UTgIvV2vAtr4uZ8M85I,72
+nvidia_nat_opentelemetry-1.3.0a20250909.dist-info/top_level.txt,sha256=8-CJ2cP6-f0ZReXe5Hzqp-5pvzzHz-5Ds5H2bGqh1-U,4
+nvidia_nat_opentelemetry-1.3.0a20250909.dist-info/RECORD,,