Packages

codex_sdk

0.4.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
30 Versions
6 Dependencies
Dependants
Files
Activity
codex_sdk docs 20251129 telemetry telemetry_and_observability.md
Raw

docs/20251129/telemetry/telemetry_and_observability.md 

# Telemetry and observability considerations for the Elixir SDK



What changed upstream:

- Feedback metadata now includes source information; thread/turn events carry richer identifiers (thread_id, turn_id).

- OTEL/observability hooks were expanded (including mTLS support) and more detailed exec/compaction events are emitted.

- Token-usage updates and diff streams provide finer-grained timing/usage signals during a turn.



SDK impact:

- If forwarding telemetry, propagate the new identifiers and metadata so downstream systems can correlate events.

- Ensure OTEL exporters or logs accept the enriched exec/compaction telemetry without field loss.

- Consider exposing token-usage updates to SDK users for metering/monitoring.

- Thread telemetry should now attach `thread_id`, `turn_id`, and any upstream `metadata.source` to both emitted telemetry and OTEL span attributes, and emit progress hooks for token-usage, diff, and compaction updates.

- OTLP exporters must support optional mTLS configuration; wire `CODEX_OTLP_CERTFILE`, `CODEX_OTLP_KEYFILE`, and `CODEX_OTLP_CACERTFILE` into the exporter when present.



Action items:

- Update telemetry schemas and tests to include new fields (source info, thread_id/turn_id).

- Verify OTEL configuration in the SDK can enable mTLS and the expanded spans/metrics.

- Add documentation/examples for consuming token-usage/diff telemetry from the SDK.