traceAI-temporal 0.1.0__py3-none-any.whl

traceai_temporal/__init__.py

@@ -0,0 +1,14 @@
+"""Thin configuration adapter for Temporal's native replay-safe OpenTelemetry."""
+
+from ._configure import TemporalTracing, configure
+from ._privacy import SafeSpanExporter
+from ._session import WorkflowIdAsSession
+from .version import __version__
+
+__all__ = [
+    "SafeSpanExporter",
+    "TemporalTracing",
+    "WorkflowIdAsSession",
+    "__version__",
+    "configure",
+]

traceai_temporal/_configure.py

@@ -0,0 +1,282 @@
+"""Native Temporal provider setup and bounded, application-owned lifecycle."""
+
+import atexit
+import logging
+import math
+import os
+import threading
+from types import TracebackType
+from urllib.parse import urlsplit
+
+from fi_instrumentation.otel import BatchSpanProcessor
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.http import Compression
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import SpanLimits
+from opentelemetry.sdk.trace.export import SpanExporter
+from temporalio.contrib.opentelemetry import (
+    OpenTelemetryPlugin,
+    ReplaySafeTracerProvider,
+    create_tracer_provider,
+)
+from typing_extensions import Self
+
+from ._privacy import SafeSpanExporter
+from ._session import WorkflowIdAsSession
+
+_CONFIGURE_LOCK = threading.Lock()
+_LOGGER = logging.getLogger(__name__)
+
+
+def _positive(value, name):
+    if isinstance(value, bool) or not math.isfinite(value) or value <= 0:
+        raise ValueError(f"{name} must be finite and positive")
+
+
+class TemporalTracing:
+    """Provider, native plugin, and bounded flush/shutdown.
+
+    Stop the worker before shutdown. A timeout returns False; it does not kill
+    an in-progress exporter. At most one flush and one shutdown task run, and
+    they are daemon threads so a broken exporter cannot hold process exit.
+    OpenTelemetry does not permit replacing a shut-down global provider.
+    """
+
+    def __init__(
+        self,
+        provider: ReplaySafeTracerProvider,
+        plugin: OpenTelemetryPlugin,
+        shutdown_timeout_millis: int,
+    ) -> None:
+        self.provider = provider
+        self.plugin = plugin
+        self._timeout = shutdown_timeout_millis
+        self._lock = threading.Lock()
+        self._flush_thread: threading.Thread | None = None
+        self._flush_result = False
+        self._shutdown_thread: threading.Thread | None = None
+        self._shutdown_result = False
+        self._closed = False
+        self._exit_hook = self.shutdown
+        atexit.register(self._exit_hook)
+
+    @property
+    def closed(self) -> bool:
+        return self._closed
+
+    def force_flush(self, timeout_millis: int = 3000) -> bool:
+        _positive(timeout_millis, "timeout_millis")
+        with self._lock:
+            if self._closed:
+                return False
+            if self._flush_thread is None or not self._flush_thread.is_alive():
+                self._flush_result = False
+
+                def flush():
+                    try:
+                        self._flush_result = bool(
+                            self.provider.force_flush(timeout_millis)
+                        )
+                    except Exception:  # noqa: BLE001 -- lifecycle failures must not escape into the application
+                        self._flush_result = False
+                        # Exception text and stacks may contain credentials/content.
+                        _LOGGER.warning(
+                            "Temporal tracing flush failed; details redacted"
+                        )
+
+                self._flush_thread = threading.Thread(
+                    target=flush, name="traceai-temporal-flush", daemon=True
+                )
+                self._flush_thread.start()
+            thread = self._flush_thread
+        thread.join(timeout_millis / 1000)
+        return not thread.is_alive() and self._flush_result
+
+    def shutdown(self, timeout_millis: int | None = None) -> bool:
+        timeout_millis = self._timeout if timeout_millis is None else timeout_millis
+        _positive(timeout_millis, "timeout_millis")
+        with self._lock:
+            if self._shutdown_thread is None:
+                self._closed = True
+                atexit.unregister(self._exit_hook)
+
+                def stop():
+                    try:
+                        # BatchSpanProcessor.shutdown drains ended spans. Do not end
+                        # open workflow spans here: replay safety belongs to Temporal.
+                        self.provider.shutdown()
+                        self._shutdown_result = True
+                    except Exception:  # noqa: BLE001 -- lifecycle failures must not escape into the application
+                        self._shutdown_result = False
+                        _LOGGER.warning(
+                            "Temporal tracing shutdown failed; details redacted"
+                        )
+
+                self._shutdown_thread = threading.Thread(
+                    target=stop, name="traceai-temporal-shutdown", daemon=True
+                )
+                self._shutdown_thread.start()
+            thread = self._shutdown_thread
+        thread.join(timeout_millis / 1000)
+        return not thread.is_alive() and self._shutdown_result
+
+    def __enter__(self) -> Self:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        self.shutdown()
+
+
+def configure(
+    *,
+    project_name: str | None = None,
+    base_url: str | None = None,
+    api_key: str | None = None,
+    secret_key: str | None = None,
+    capture_content: bool = False,
+    keep_error_text: bool = False,
+    compression: str = "none",
+    exporter: SpanExporter | None = None,
+    export_timeout: float = 3.0,
+    shutdown_timeout_millis: int = 3000,
+    max_queue_size: int = 2048,
+    max_export_batch_size: int = 512,
+    schedule_delay_millis: int = 1000,
+    max_content_length: int = 16384,
+) -> TemporalTracing:
+    """Configure once, before Client.connect(), in the starter and the worker.
+
+    Use handle.plugin on each client; workers inherit it from the client. The
+    native provider is registered globally; an existing global SDK provider is
+    rejected before an exporter is created. No model SDK is instrumented here.
+    Pass this provider to the one traceAI model instrumentor your activity uses.
+    Passing exporter bypasses endpoint/auth configuration and transfers ownership.
+    Do not import this module from workflow code.
+    """
+    project_name = (
+        project_name if project_name is not None else os.getenv("FI_PROJECT_NAME")
+    )
+    if not isinstance(project_name, str) or not project_name.strip():
+        raise ValueError("Set project_name or FI_PROJECT_NAME")
+    if not isinstance(capture_content, bool) or not isinstance(keep_error_text, bool):
+        raise TypeError("capture_content and keep_error_text must be booleans")
+    for value, name in (
+        (export_timeout, "export_timeout"),
+        (shutdown_timeout_millis, "shutdown_timeout_millis"),
+        (schedule_delay_millis, "schedule_delay_millis"),
+        (max_queue_size, "max_queue_size"),
+        (max_export_batch_size, "max_export_batch_size"),
+        (max_content_length, "max_content_length"),
+    ):
+        _positive(value, name)
+    if any(
+        not isinstance(value, int) or isinstance(value, bool)
+        for value in (max_queue_size, max_export_batch_size, max_content_length)
+    ):
+        raise ValueError("Queue, batch, and content limits must be integers")
+    if max_export_batch_size > max_queue_size:
+        raise ValueError("max_export_batch_size must not exceed max_queue_size")
+    if compression not in {"none", "gzip"}:
+        raise ValueError("compression must be 'none' or 'gzip'")
+
+    with _CONFIGURE_LOCK:
+        if not isinstance(trace.get_tracer_provider(), trace.ProxyTracerProvider):
+            raise RuntimeError(  # noqa: TRY004 -- process state conflict, not a bad argument
+                "A global tracer provider already exists; call configure() once, before other instrumentation"
+            )
+        if exporter is None:
+            base_url = (
+                base_url
+                if base_url is not None
+                else os.getenv("FI_BASE_URL", "https://api.futureagi.com")
+            )
+            if not isinstance(base_url, str):
+                raise TypeError("base_url must be a string")
+            parsed = urlsplit(base_url)
+            if (
+                parsed.scheme not in {"https", "http"}
+                or not parsed.hostname
+                or parsed.username
+                or parsed.password
+                or parsed.query
+                or parsed.fragment
+            ):
+                raise ValueError(
+                    "base_url must be an HTTP(S) origin or path, without credentials/query/fragment"
+                )
+            if parsed.scheme == "http" and parsed.hostname not in {
+                "localhost",
+                "127.0.0.1",
+                "::1",
+            }:
+                raise ValueError(
+                    "Remote endpoints require HTTPS; HTTP is allowed only on loopback"
+                )
+            api_key = api_key if api_key is not None else os.getenv("FI_API_KEY")
+            secret_key = (
+                secret_key if secret_key is not None else os.getenv("FI_SECRET_KEY")
+            )
+            if not api_key or not secret_key:
+                raise ValueError(
+                    "Set both FI_API_KEY and FI_SECRET_KEY, or pass api_key and secret_key"
+                )
+            exporter = OTLPSpanExporter(
+                endpoint=base_url.rstrip("/") + "/tracer/v1/traces",
+                headers={"X-Api-Key": api_key, "X-Secret-Key": secret_key},
+                timeout=export_timeout,
+                compression=Compression.Gzip
+                if compression == "gzip"
+                else Compression.NoCompression,
+            )
+        safe = SafeSpanExporter(
+            exporter,
+            capture_content=capture_content,
+            keep_error_text=keep_error_text,
+            max_content_length=max_content_length,
+        )
+        provider = create_tracer_provider(
+            # Resource(), not create(): no environment, host, process, or SDK detectors.
+            resource=Resource(
+                {
+                    "project_name": project_name,
+                    "project_type": "observe",
+                    "semantic_convention": "fi",
+                    "service.name": "temporal",
+                }
+            ),
+            shutdown_on_exit=False,
+            span_limits=SpanLimits(
+                max_attributes=128,
+                max_events=64,
+                max_links=64,
+                max_attribute_length=max(16384, max_content_length),
+            ),
+        )
+        provider.add_span_processor(WorkflowIdAsSession())
+        provider.add_span_processor(
+            BatchSpanProcessor(
+                safe,
+                max_queue_size=max_queue_size,
+                max_export_batch_size=max_export_batch_size,
+                schedule_delay_millis=schedule_delay_millis,
+            )
+        )
+        handle = TemporalTracing(
+            provider,
+            OpenTelemetryPlugin(add_temporal_spans=True),
+            shutdown_timeout_millis,
+        )
+        trace.set_tracer_provider(provider)
+        if trace.get_tracer_provider() is not provider:
+            # An unrelated library may race our lock; never return an unusable handle.
+            handle.shutdown()
+            raise RuntimeError(
+                "Another library installed the global provider during Temporal configuration"
+            )
+        return handle

traceai_temporal/_privacy.py

@@ -0,0 +1,298 @@
+"""Destination-local, fail-closed filtering of completed native spans."""
+
+import logging
+import re
+from collections.abc import Sequence
+
+from fi_instrumentation import TraceConfig
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import Event, ReadableSpan
+from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult
+from opentelemetry.sdk.util.instrumentation import InstrumentationScope
+from opentelemetry.trace import Link, SpanContext, Status, StatusCode
+
+_LOGGER = logging.getLogger(__name__)
+
+# An allowlist, not a prefix denylist: newly added upstream fields stay private.
+_METADATA = frozenset(
+    {
+        "temporalWorkflowID",
+        "temporalRunID",
+        "temporalActivityID",
+        "temporalActivityType",
+        "session.id",
+        "user.id",
+        "gen_ai.conversation.id",
+        "gen_ai.span.kind",
+        "gen_ai.operation.name",
+        "gen_ai.provider.name",
+        "gen_ai.system",
+        "gen_ai.request.model",
+        "gen_ai.response.model",
+        "gen_ai.response.id",
+        "gen_ai.tool.name",
+        "gen_ai.tool.type",
+        "gen_ai.tool.call.id",
+        "gen_ai.usage.input_tokens",
+        "gen_ai.usage.output_tokens",
+        "gen_ai.usage.total_tokens",
+        "gen_ai.usage.cache_read_tokens",
+        "gen_ai.usage.cache_write_tokens",
+        "gen_ai.usage.input_tokens.cache_read",
+        "gen_ai.usage.input_tokens.cache_write",
+        "gen_ai.usage.input_tokens.cache_input",
+        "gen_ai.usage.input_tokens.audio",
+        "gen_ai.usage.output_tokens.audio",
+        "gen_ai.usage.output_tokens.reasoning",
+        "llm.provider",
+        "llm.system",
+        "tool.name",
+        "tool.id",
+        "tool.type",
+        "exception.type",
+        "error.type",
+    }
+)
+_ALIASES = {
+    "fi.span.kind": "gen_ai.span.kind",
+    "openinference.span.kind": "gen_ai.span.kind",
+    "llm.model_name": "gen_ai.request.model",
+    "llm.invocation_parameters": "gen_ai.request.parameters",
+    "llm.token_count.prompt": "gen_ai.usage.input_tokens",
+    "llm.token_count.completion": "gen_ai.usage.output_tokens",
+    "llm.token_count.total": "gen_ai.usage.total_tokens",
+}
+_CONTENT = frozenset(
+    {
+        "input.value",
+        "output.value",
+        "input.mime_type",
+        "output.mime_type",
+        "gen_ai.input.messages",
+        "gen_ai.output.messages",
+        "gen_ai.system_instructions",
+        "gen_ai.tool.call.arguments",
+        "gen_ai.tool.call.result",
+        "gen_ai.request.parameters",
+        "raw.input",
+        "raw.output",
+        "gen_ai.prompts",
+    }
+)
+_MESSAGE_FIELD = re.compile(
+    r"(?:gen_ai\.(?:input|output)\.messages|llm\.(?:input|output)_messages)"
+    r"\.\d+\.message\.(?:role|content|name|tool_call_id|"
+    r"contents\.\d+\.message_content\.text|"
+    r"tool_calls\.\d+\.tool_call\.(?:id|function\.name|function\.arguments))\Z"
+)
+
+_RESOURCE = frozenset(
+    {"project_name", "project_type", "service.name", "semantic_convention"}
+)
+_ERROR_TYPE = re.compile(r"[A-Za-z_][A-Za-z0-9_.]{0,255}\Z")
+_KINDS = frozenset(
+    {
+        "llm",
+        "tool",
+        "chain",
+        "agent",
+        "retriever",
+        "embedding",
+        "reranker",
+        "guardrail",
+        "evaluator",
+    }
+)
+
+
+def _context(context):
+    if context is None:
+        return None
+    # TraceState is arbitrary vendor data; it is unnecessary for exported parentage.
+    return SpanContext(
+        context.trace_id, context.span_id, context.is_remote, context.trace_flags
+    )
+
+
+class SafeSpanExporter(SpanExporter):
+    """Sanitize only this destination; never mutate spans seen by other exporters.
+
+    Content requires capture_content. Exception messages additionally require
+    keep_error_text; exception stacks and arbitrary events are never exported.
+    Span/scope names and metadata IDs must not contain private application data.
+    The wrapped exporter is owned by this wrapper and shut down with it.
+    """
+
+    def __init__(
+        self,
+        exporter: SpanExporter,
+        *,
+        capture_content: bool = False,
+        keep_error_text: bool = False,
+        max_content_length: int = 16384,
+    ) -> None:
+        if not isinstance(capture_content, bool) or not isinstance(
+            keep_error_text, bool
+        ):
+            raise TypeError("capture_content and keep_error_text must be booleans")
+        if not isinstance(max_content_length, int) or isinstance(
+            max_content_length, bool
+        ):
+            raise TypeError("max_content_length must be an integer")
+        if max_content_length < 1:
+            raise ValueError("max_content_length must be positive")
+        self._exporter = exporter
+        self._capture_content = capture_content
+        self._config = TraceConfig()
+        self._keep_error_text = (
+            capture_content and keep_error_text and not self._config.hide_error_details
+        )
+        self._max_content_length = max_content_length
+
+    def _attributes(self, attributes):
+        original = dict(attributes or {})
+        for source, target in _ALIASES.items():
+            if source in original:
+                original.setdefault(target, original[source])
+                del original[source]
+        result = {}
+        for key, value in original.items():
+            if key in {"exception.type", "error.type"}:
+                result[key] = (
+                    value
+                    if isinstance(value, str) and _ERROR_TYPE.fullmatch(value)
+                    else "Error"
+                )
+            elif key == "gen_ai.span.kind":
+                if isinstance(value, str) and value.lower() in _KINDS:
+                    result[key] = value.lower()
+            elif key.startswith("gen_ai.usage.") and key in _METADATA:
+                if (
+                    isinstance(value, int)
+                    and not isinstance(value, bool)
+                    and value >= 0
+                ):
+                    result[key] = value
+            elif key in _METADATA:
+                if isinstance(value, (str, int, float, bool)):
+                    result[key] = value
+            elif self._keep_error_text and key in {
+                "exception.message",
+                "error.message",
+            }:
+                if isinstance(value, str):
+                    result[key] = value[: self._max_content_length]
+            elif self._capture_content and (
+                key in _CONTENT or _MESSAGE_FIELD.fullmatch(key)
+            ):
+                # Aggregate strings may contain message text/images that core's
+                # field-level mask cannot inspect. Hide them conservatively.
+                input_hidden = any(
+                    (
+                        self._config.hide_inputs,
+                        self._config.hide_input_messages,
+                        self._config.hide_input_text,
+                        self._config.hide_input_images,
+                    )
+                )
+                output_hidden = any(
+                    (
+                        self._config.hide_outputs,
+                        self._config.hide_output_messages,
+                        self._config.hide_output_text,
+                    )
+                )
+                is_input = key.startswith(
+                    ("input.", "raw.input", "gen_ai.input.", "llm.input_messages")
+                ) or key in {
+                    "gen_ai.system_instructions",
+                    "gen_ai.prompts",
+                    "gen_ai.tool.call.arguments",
+                }
+                is_output = (
+                    key.startswith(
+                        (
+                            "output.",
+                            "raw.output",
+                            "gen_ai.output.",
+                            "llm.output_messages",
+                        )
+                    )
+                    or key == "gen_ai.tool.call.result"
+                )
+                if (is_input and input_hidden) or (is_output and output_hidden):
+                    continue
+                if key == "gen_ai.request.parameters" and (
+                    input_hidden
+                    or output_hidden
+                    or self._config.hide_llm_invocation_parameters
+                ):
+                    continue
+                masked = self._config.mask(key, value)
+                if masked is not None:
+                    if isinstance(masked, str):
+                        result[key] = masked[: self._max_content_length]
+                    elif isinstance(masked, (int, float, bool)):
+                        result[key] = masked
+        return result
+
+    def _scrub(self, span: ReadableSpan) -> ReadableSpan:
+        status = Status(span.status.status_code)
+        if span.status.status_code == StatusCode.ERROR:
+            status = Status(
+                StatusCode.ERROR,
+                (
+                    span.status.description[: self._max_content_length]
+                    if self._keep_error_text and span.status.description
+                    else "error"
+                ),
+            )
+        events = []
+        for event in span.events:
+            if event.name != "exception":
+                continue
+            attrs = event.attributes or {}
+            safe = self._attributes(
+                {k: v for k, v in attrs.items() if k == "exception.type"}
+            )
+            message = attrs.get("exception.message")
+            if self._keep_error_text and isinstance(message, str):
+                safe["exception.message"] = message[: self._max_content_length]
+            events.append(Event("exception", safe, event.timestamp))
+        scope = span.instrumentation_scope
+        return ReadableSpan(
+            name=span.name,
+            context=_context(span.context),
+            parent=_context(span.parent),
+            resource=Resource(
+                {k: v for k, v in span.resource.attributes.items() if k in _RESOURCE}
+            ),
+            attributes=self._attributes(span.attributes),
+            events=events,
+            links=[Link(_context(link.context)) for link in span.links],
+            kind=span.kind,
+            status=status,
+            start_time=span.start_time,
+            end_time=span.end_time,
+            instrumentation_scope=InstrumentationScope(scope.name, scope.version)
+            if scope
+            else None,
+        )
+
+    def export(self, spans: Sequence[ReadableSpan]) -> SpanExportResult:
+        try:
+            safe = [self._scrub(span) for span in spans]
+            return self._exporter.export(safe)
+        except Exception:  # noqa: BLE001 -- fail closed for both filter and exporter failures
+            # Neither a filtering error nor an exporter exception may send the originals
+            # or log exception text that can contain a request body/credentials.
+            _LOGGER.warning(
+                "Temporal span filtering or export failed; batch dropped, details redacted"
+            )
+            return SpanExportResult.FAILURE
+
+    def force_flush(self, timeout_millis: int = 30000) -> bool:
+        return self._exporter.force_flush(timeout_millis)
+
+    def shutdown(self) -> None:
+        self._exporter.shutdown()

traceai_temporal/_session.py

@@ -0,0 +1,58 @@
+"""Session propagation without inventing workflow spans or IDs."""
+
+import logging
+
+from opentelemetry import context, trace
+from opentelemetry.context import Context
+from opentelemetry.sdk.trace import Span, SpanProcessor
+from temporalio import activity, workflow
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class WorkflowIdAsSession(SpanProcessor):
+    """Use the native workflow ID unless the application supplies a session.
+
+    Activity runtime context also covers SDK versions that omit workflow IDs on
+    RunActivity. Only local parent/context user IDs propagate: no new baggage or
+    workflow headers are added, and identities never cross a workflow boundary
+    implicitly.
+    """
+
+    def force_flush(self, timeout_millis: int = 30000) -> bool:
+        # OTel 1.39's default SpanProcessor method returns None, which aborts
+        # the provider's flush before it reaches the actual batch processor.
+        return True
+
+    def on_start(self, span: Span, parent_context: Context | None = None) -> None:
+        try:
+            attrs = span.attributes or {}
+            parent = (
+                getattr(trace.get_current_span(parent_context), "attributes", None)
+                or {}
+            )
+            if not attrs.get("session.id"):
+                session = context.get_value("session.id", parent_context)
+                if not session:
+                    # Native workflow boundaries keep their own identity rather
+                    # than inheriting a caller's session implicitly.
+                    session = attrs.get("temporalWorkflowID")
+                if not session:
+                    session = parent.get("session.id")
+                if not session and activity.in_activity():
+                    session = activity.info().workflow_id
+                if not session and workflow.in_workflow():
+                    session = workflow.info().workflow_id
+                if isinstance(session, str) and session:
+                    span.set_attribute("session.id", session)
+            if not attrs.get("user.id"):
+                user = context.get_value("user.id", parent_context) or parent.get(
+                    "user.id"
+                )
+                if isinstance(user, str) and user:
+                    span.set_attribute("user.id", user)
+        except Exception:  # noqa: BLE001 -- telemetry hooks must not break workflows
+            # Do not log exception text/stacks: they may include application content.
+            _LOGGER.warning(
+                "Temporal session mapping failed; span kept, details redacted"
+            )

traceai_temporal/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"  # x-release-please-version

traceai_temporal-0.1.0.dist-info/METADATA

@@ -0,0 +1,191 @@
+Metadata-Version: 2.5
+Name: traceAI-temporal
+Version: 0.1.0
+Summary: Future AGI configuration for Temporal's native replay-safe OpenTelemetry tracing
+Project-URL: Repository, https://github.com/future-agi/traceAI/tree/dev/python/frameworks/temporal
+Project-URL: Documentation, https://docs.futureagi.com/docs/integrations/frameworks/temporal
+Author-email: Future AGI <no-reply@futureagi.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: <3.14,>=3.10
+Requires-Dist: fi-instrumentation-otel<2,>=1.2.2
+Requires-Dist: opentelemetry-exporter-otlp-proto-http<2,>=1.39
+Requires-Dist: opentelemetry-sdk<2,>=1.39
+Requires-Dist: temporalio[opentelemetry]<1.36,>=1.34
+Requires-Dist: typing-extensions<5,>=4.5
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2; extra == 'dev'
+Requires-Dist: hatchling<2,>=1.27; extra == 'dev'
+Requires-Dist: mypy<2,>=1.15; extra == 'dev'
+Requires-Dist: pytest<9,>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# traceAI Temporal
+
+Send Temporal's native workflow and activity spans to Future AGI, with model and tool spans nested inside the activities that run them. The package configures Temporal's replay-safe OpenTelemetry provider; it does not replace Temporal's instrumentation or create duplicate workflow spans.
+
+## Install
+
+Use Python 3.10–3.13 and Temporal Python SDK 1.34 or 1.35.
+
+```bash
+pip install "traceAI-temporal==0.1.0"
+```
+
+Temporal marks its OpenTelemetry plugin and replay-safe provider as experimental. This package restricts the SDK range to the supported minor versions.
+
+## Configure
+
+Set the same project in the starter and worker processes. Supply your keys through your deployment's environment or secret manager.
+
+```bash
+export FI_PROJECT_NAME=temporal-orders
+export FI_API_KEY='<your-api-key>'
+export FI_SECRET_KEY='<your-secret-key>'
+# Optional, for a self-hosted deployment:
+# export FI_BASE_URL=https://your-futureagi-host
+```
+
+Call `configure()` once in each process, **before connecting the client**. Do not also call `fi_instrumentation.register()` or install another global tracer provider.
+
+```python
+from temporalio.client import Client
+from traceai_temporal import configure
+
+telemetry = configure()
+client = await Client.connect("localhost:7233", plugins=[telemetry.plugin])
+```
+
+Workers created from this client inherit the native plugin. Do not add it to the worker again. The plugin enables Temporal's workflow and activity spans by default.
+
+## Run a workflow
+
+Start your Temporal cluster or a local [Temporal dev server](https://docs.temporal.io/cli):
+
+```bash
+temporal server start-dev
+```
+
+Keep workflow code deterministic. Save this ordinary workflow as `workflows.py`; it must not import the exporter, this package, or a model SDK.
+
+```python
+from datetime import timedelta
+from temporalio import workflow
+
+
+@workflow.defn
+class OrderWorkflow:
+    @workflow.run
+    async def run(self, quantity: int) -> str:
+        return await workflow.execute_activity(
+            "price_order",
+            quantity,
+            start_to_close_timeout=timedelta(seconds=10),
+        )
+```
+
+Save the worker and starter as `app.py`. This example runs them in one process; separate deployments use the same `configure()` and client setup in each process.
+
+```python
+import asyncio
+import uuid
+from opentelemetry import trace
+from temporalio import activity
+from temporalio.client import Client
+from temporalio.worker import Worker
+from traceai_temporal import configure
+from workflows import OrderWorkflow
+
+
+@activity.defn
+async def price_order(quantity: int) -> str:
+    with trace.get_tracer("orders").start_as_current_span(
+        "calculate-price", attributes={"gen_ai.span.kind": "tool"}
+    ):
+        return f"EUR {quantity * 21}"
+
+
+async def main():
+    telemetry = configure()
+    try:
+        client = await Client.connect("localhost:7233", plugins=[telemetry.plugin])
+        async with Worker(
+            client,
+            task_queue="orders",
+            workflows=[OrderWorkflow],
+            activities=[price_order],
+        ):
+            result = await client.execute_workflow(
+                OrderWorkflow.run,
+                2,
+                id=f"order-{uuid.uuid4().hex}",
+                task_queue="orders",
+            )
+            print(result)
+    finally:
+        # Stop workers first. These methods return False if the time budget expires.
+        if not telemetry.shutdown(timeout_millis=3000):
+            print("Tracing shutdown timed out; the final batch may be lost")
+
+
+asyncio.run(main())
+```
+
+```bash
+python app.py
+```
+
+In Future AGI, open **Observe**, select `temporal-orders`, and open the latest `StartWorkflow:OrderWorkflow` trace. It contains `RunWorkflow`, `StartActivity`, `RunActivity`, and `calculate-price`. The workflow ID is the session ID, including on nested tool/model spans and signal handlers.
+
+## Add model tracing inside activities
+
+Temporal's plugin does not trace model requests. Install the traceAI package for your model SDK and instrument it **once**, using `telemetry.provider`. For example, with `traceAI-openai` installed:
+
+```python
+from traceai_openai import OpenAIInstrumentor
+
+OpenAIInstrumentor().instrument(tracer_provider=telemetry.provider)
+```
+
+Make model calls only inside activities, not replayed workflow code. Provider spans keep their model, token usage, and span kind; the adapter does not copy token totals onto workflow or activity parents. Do not instrument the same model call through two packages.
+
+## Privacy
+
+The default is **metadata only**: workflow/run/activity IDs, span names and timing, status, model/tool identifiers, token counts, and explicit session/user IDs. Unknown attributes, content, arbitrary events, status text, and exception messages are removed before this destination exports. Exception types remain. Exception stack attributes are always removed, including with content enabled. Resource and scope attributes are filtered, and link attributes and trace state are removed.
+
+Use opaque workflow IDs and user IDs. Span names, instrumentation-scope names, and allowed metadata values are not secret scanners; do not put prompts, emails, paths, or credentials in them.
+
+To include supported input/output and message attributes, opt in in both processes as needed:
+
+```python
+telemetry = configure(capture_content=True)
+```
+
+Error text needs a second explicit opt-in, `keep_error_text=True`, together with `capture_content=True`. The core `FI_HIDE_*` settings remain privacy ceilings; `FI_HIDE_ERROR_DETAILS=true` still removes error text. Content values are capped at 16,384 characters by default. The adapter cannot recover content that your instrumentor did not record, and opt-in content can contain sensitive data.
+
+The policy applies to this exporter only. It does not redact Temporal history, application logs, or other exporters you attach. It does not propagate user identity across Temporal's process boundary: attach explicit user IDs in activities if needed. Application-supplied `session.id` takes precedence over the workflow ID.
+
+## Configuration and lifecycle
+
+- `project_name`, `api_key`, `secret_key`, `base_url` override the corresponding `FI_*` environment values. `base_url` is the origin (optionally with a deployment prefix), not the traces URL; the package appends `/tracer/v1/traces`.
+- The destination uses upstream OTLP/HTTP **protobuf** with no compression. Set `compression="gzip"` for Future AGI Cloud or self-hosted v1.56.0 and later. Remote endpoints require HTTPS; plain HTTP is allowed only for loopback collectors.
+- `exporter=` accepts an application-supplied OpenTelemetry `SpanExporter` in place of endpoint/auth settings. It still receives filtered spans and is shut down by the handle.
+- The batch queue holds at most 2,048 spans, with batches of at most 512 and a 1-second schedule. Set `max_queue_size`, `max_export_batch_size`, and `schedule_delay_millis` to tune them. A full queue drops spans rather than blocking an activity.
+- `export_timeout` defaults to 3 seconds per HTTP export. `telemetry.force_flush(timeout_millis=3000)` and `telemetry.shutdown(timeout_millis=3000)` bound the caller's wait and return a boolean. On timeout, an in-flight daemon export can finish later; delivery is not guaranteed. Neither method ends unfinished workflow spans.
+- Normal interpreter exit has a bounded shutdown fallback. Explicitly shut down after stopping the worker. Crashes, forced exits, and container freezes can lose buffered spans. In an async server, use `await asyncio.to_thread(telemetry.shutdown)` to avoid blocking its event loop while waiting.
+- Do not configure again after shutdown: OpenTelemetry does not allow replacing its process-global provider. Construct worker processes after forking, then configure each process.
+
+## Troubleshooting
+
+**The worker rejects the global tracer provider.** Call this package's `configure()` before `Client.connect()`. Do not use the ordinary `register()` provider with Temporal's replay-safe plugin.
+
+**Model spans start separate traces.** Configure the plugin on both clients and pass `telemetry.provider` to the model instrumentor. Keep calls inside activities.
+
+**A workflow fails sandbox validation.** Move tracing setup and model imports into the worker/activity module. The workflow module should import only deterministic workflow dependencies and refer to activities by name.
+
+**No spans appear, or the trace splits across projects.** Check both key headers, the base URL, and that starter and worker use the same `FI_PROJECT_NAME`. Flush short-lived starters before exit. A running workflow's `RunWorkflow` span is exported only when it ends.
+
+## Limits
+
+This integration covers the Python native plugin's workflow/activity hierarchy, activity retries, signal sessions, and history replay. It does not configure Temporal metrics/logs, cluster authentication, or model instrumentation. Native Temporal spans remain runtime spans rather than being relabeled as model calls. Each activity attempt is a distinct span; no attempt number is synthesized. Temporal owns deterministic IDs and replay suppression, not exactly-once delivery to Future AGI. Child workflows, continue-as-new, Nexus, and standalone activities are not additional compatibility guarantees of this package.

traceai_temporal-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+traceai_temporal/__init__.py,sha256=cjUjPt8cciyJrBOlP-ufsD36dD02usnO0XCkTi3H9nk,373
+traceai_temporal/_configure.py,sha256=9CnymS7SiAR9KAJulpI3nQvILy77vESl4kQk9Av57ng,11336
+traceai_temporal/_privacy.py,sha256=GBetp7I6TM3JhFNRX9Wr64agM58VZ-Fb8r2ZMyOixaA,11218
+traceai_temporal/_session.py,sha256=coXhhKahWHLhFqMsiu88JNmJh3SIctp8jk9esyp3kEs,2586
+traceai_temporal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+traceai_temporal/version.py,sha256=IOEzhCbX916JIkvZr03GFY4bl9YqSkfjdqLO4qJ2FOs,50
+traceai_temporal-0.1.0.dist-info/METADATA,sha256=y0XYKrDYFELKzi5NInFv7wi24BROKxRFovVrPu8uO9E,10298
+traceai_temporal-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+traceai_temporal-0.1.0.dist-info/licenses/LICENSE,sha256=MdFVOqVey1yWrQ7QcNxBkeYHdrsTUICh6lhmP3LxOEc,11308
+traceai_temporal-0.1.0.dist-info/licenses/NOTICE,sha256=bv5-n0BXeHzEOxr5NmwLIOSOSbs4QjsJ-023dtOQUSc,337
+traceai_temporal-0.1.0.dist-info/RECORD,,

traceai_temporal-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

traceai_temporal-0.1.0.dist-info/licenses/LICENSE

@@ -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 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 accept 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 2024-2026 Future AGI, Inc.
+
+   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.

traceai_temporal-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1,7 @@
+traceAI
+Copyright (c) 2024-2026 Future AGI, Inc.
+
+This product is part of the Future AGI open-source ecosystem
+(https://github.com/future-agi/future-agi) and is licensed under the Apache
+License, Version 2.0 (the "License"). See the LICENSE file for the full
+license text, or obtain a copy at http://www.apache.org/licenses/LICENSE-2.0.