Packages

codex_sdk

0.4.2
0.18.1 0.18.0 0.17.0 0.16.1 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.1 0.10.0 0.9.0 0.8.0 0.7.2 0.7.1 0.7.0 0.6.0 0.5.0 0.4.5 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.0 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.0

Idiomatic Elixir SDK for OpenAI's Codex agent. Provides a complete, production-ready interface with streaming support, comprehensive event handling, and robust testing utilities.

HexDocs

Current section

Files

Jump to
Readme
32 Versions
6 Dependencies
Dependants
Files
Activity
codex_sdk docs 20251202 adrs adr-010-tracing-telemetry-usage.md
Raw

docs/20251202/adrs/adr-010-tracing-telemetry-usage.md 

# ADR-010: Introduce Span-Based Tracing and Usage Aggregation



Status: Proposed



Context

- Python: tracing framework (`src/agents/tracing`) installs default exporter/processors; spans for agents/functions/guardrails/handoffs/MCP; `RunConfig` controls tracing_disabled, trace_include_sensitive_data (env-driven default), workflow/group/trace_id metadata; usage aggregated in `Usage` (`usage.py`) and attached to `RunContextWrapper`.

- Elixir: telemetry events only; no span model or processors; no sensitive-data toggle; usage limited to codex response fields.



Decision

- Add tracing provider with spans and processors; default exporter configurable via env; propagate workflow/group/trace_id metadata and sensitive-data inclusion toggle.

- Attach usage aggregator to run context, accumulating per-request tokens and exposing per-request breakdowns.

- Keep emitting telemetry events but correlate with spans; allow disabling tracing per run.



Consequences

- Benefits: parity with Python observability, easier downstream integration, better cost accounting.

- Risks: added complexity and performance overhead; need to avoid leaking sensitive data when toggle is off; must align with codex telemetry.

- Actions: design span data structures and processor interfaces; implement default processor/exporter; integrate into runner; add tests similar to `tests/test_tracing.py`, `tests/test_agent_tracing.py`, `tests/test_usage.py`, `tests/test_agents_logging.py`, `tests/tracing/test_processor_api_key.py`.