04c1782e52
### Title ## otel Codex can emit [OpenTelemetry](https://opentelemetry.io/) **log events** that describe each run: outbound API requests, streamed responses, user input, tool-approval decisions, and the result of every tool invocation. Export is **disabled by default** so local runs remain self-contained. Opt in by adding an `[otel]` table and choosing an exporter. ```toml [otel] environment = "staging" # defaults to "dev" exporter = "none" # defaults to "none"; set to otlp-http or otlp-grpc to send events log_user_prompt = false # defaults to false; redact prompt text unless explicitly enabled ``` Codex tags every exported event with `service.name = "codex-cli"`, the CLI version, and an `env` attribute so downstream collectors can distinguish dev/staging/prod traffic. Only telemetry produced inside the `codex_otel` crate—the events listed below—is forwarded to the exporter. ### Event catalog Every event shares a common set of metadata fields: `event.timestamp`, `conversation.id`, `app.version`, `auth_mode` (when available), `user.account_id` (when available), `terminal.type`, `model`, and `slug`. With OTEL enabled Codex emits the following event types (in addition to the metadata above): - `codex.api_request` - `cf_ray` (optional) - `attempt` - `duration_ms` - `http.response.status_code` (optional) - `error.message` (failures) - `codex.sse_event` - `event.kind` - `duration_ms` - `error.message` (failures) - `input_token_count` (completion only) - `output_token_count` (completion only) - `cached_token_count` (completion only, optional) - `reasoning_token_count` (completion only, optional) - `tool_token_count` (completion only) - `codex.user_prompt` - `prompt_length` - `prompt` (redacted unless `log_user_prompt = true`) - `codex.tool_decision` - `tool_name` - `call_id` - `decision` (`approved`, `approved_for_session`, `denied`, or `abort`) - `source` (`config` or `user`) - `codex.tool_result` - `tool_name` - `call_id` - `arguments` - `duration_ms` (execution time for the tool) - `success` (`"true"` or `"false"`) - `output` ### Choosing an exporter Set `otel.exporter` to control where events go: - `none` – leaves instrumentation active but skips exporting. This is the default. - `otlp-http` – posts OTLP log records to an OTLP/HTTP collector. Specify the endpoint, protocol, and headers your collector expects: ```toml [otel] exporter = { otlp-http = { endpoint = "https://otel.example.com/v1/logs", protocol = "binary", headers = { "x-otlp-api-key" = "${OTLP_TOKEN}" } }} ``` - `otlp-grpc` – streams OTLP log records over gRPC. Provide the endpoint and any metadata headers: ```toml [otel] exporter = { otlp-grpc = { endpoint = "https://otel.example.com:4317", headers = { "x-otlp-meta" = "abc123" } }} ``` If the exporter is `none` nothing is written anywhere; otherwise you must run or point to your own collector. All exporters run on a background batch worker that is flushed on shutdown. If you build Codex from source the OTEL crate is still behind an `otel` feature flag; the official prebuilt binaries ship with the feature enabled. When the feature is disabled the telemetry hooks become no-ops so the CLI continues to function without the extra dependencies. --------- Co-authored-by: Anton Panasenko <apanasenko@openai.com>
227 lines
5.4 KiB
TOML
227 lines
5.4 KiB
TOML
[workspace]
|
|
members = [
|
|
"ansi-escape",
|
|
"apply-patch",
|
|
"arg0",
|
|
"cli",
|
|
"common",
|
|
"core",
|
|
"exec",
|
|
"execpolicy",
|
|
"file-search",
|
|
"git-tooling",
|
|
"linux-sandbox",
|
|
"login",
|
|
"mcp-client",
|
|
"mcp-server",
|
|
"mcp-types",
|
|
"ollama",
|
|
"process-hardening",
|
|
"protocol",
|
|
"protocol-ts",
|
|
"rmcp-client",
|
|
"responses-api-proxy",
|
|
"otel",
|
|
"tui",
|
|
"utils/readiness",
|
|
]
|
|
resolver = "2"
|
|
|
|
[workspace.package]
|
|
version = "0.0.0"
|
|
# Track the edition for all workspace crates in one place. Individual
|
|
# crates can still override this value, but keeping it here means new
|
|
# crates created with `cargo new -w ...` automatically inherit the 2024
|
|
# edition.
|
|
edition = "2024"
|
|
|
|
[workspace.dependencies]
|
|
# Internal
|
|
codex-ansi-escape = { path = "ansi-escape" }
|
|
codex-apply-patch = { path = "apply-patch" }
|
|
codex-arg0 = { path = "arg0" }
|
|
codex-chatgpt = { path = "chatgpt" }
|
|
codex-common = { path = "common" }
|
|
codex-core = { path = "core" }
|
|
codex-exec = { path = "exec" }
|
|
codex-file-search = { path = "file-search" }
|
|
codex-git-tooling = { path = "git-tooling" }
|
|
codex-linux-sandbox = { path = "linux-sandbox" }
|
|
codex-login = { path = "login" }
|
|
codex-mcp-client = { path = "mcp-client" }
|
|
codex-mcp-server = { path = "mcp-server" }
|
|
codex-ollama = { path = "ollama" }
|
|
codex-process-hardening = { path = "process-hardening" }
|
|
codex-protocol = { path = "protocol" }
|
|
codex-protocol-ts = { path = "protocol-ts" }
|
|
codex-rmcp-client = { path = "rmcp-client" }
|
|
codex-tui = { path = "tui" }
|
|
codex-otel = { path = "otel" }
|
|
codex-utils-readiness = { path = "utils/readiness" }
|
|
core_test_support = { path = "core/tests/common" }
|
|
mcp-types = { path = "mcp-types" }
|
|
mcp_test_support = { path = "mcp-server/tests/common" }
|
|
|
|
# External
|
|
allocative = "0.3.3"
|
|
ansi-to-tui = "7.0.0"
|
|
anyhow = "1"
|
|
arboard = "3"
|
|
askama = "0.12"
|
|
assert_cmd = "2"
|
|
async-channel = "2.3.1"
|
|
async-stream = "0.3.6"
|
|
async-trait = "0.1.89"
|
|
base64 = "0.22.1"
|
|
bytes = "1.10.1"
|
|
chrono = "0.4.42"
|
|
clap = "4"
|
|
clap_complete = "4"
|
|
color-eyre = "0.6.3"
|
|
crossterm = "0.28.1"
|
|
ctor = "0.5.0"
|
|
derive_more = "2"
|
|
diffy = "0.4.2"
|
|
dirs = "6"
|
|
dotenvy = "0.15.7"
|
|
env-flags = "0.1.1"
|
|
env_logger = "0.11.5"
|
|
escargot = "0.5"
|
|
eventsource-stream = "0.2.3"
|
|
futures = "0.3"
|
|
icu_decimal = "2.0.0"
|
|
icu_locale_core = "2.0.0"
|
|
ignore = "0.4.23"
|
|
image = { version = "^0.25.8", default-features = false }
|
|
indexmap = "2.6.0"
|
|
insta = "1.43.2"
|
|
itertools = "0.14.0"
|
|
landlock = "0.4.1"
|
|
lazy_static = "1"
|
|
libc = "0.2.175"
|
|
log = "0.4"
|
|
maplit = "1.0.2"
|
|
mime_guess = "2.0.5"
|
|
multimap = "0.10.0"
|
|
nucleo-matcher = "0.3.1"
|
|
openssl-sys = "*"
|
|
opentelemetry = "0.30.0"
|
|
opentelemetry_sdk = "0.30.0"
|
|
opentelemetry-otlp = "0.30.0"
|
|
opentelemetry-appender-tracing = "0.30.0"
|
|
opentelemetry-semantic-conventions = "0.30.0"
|
|
os_info = "3.12.0"
|
|
owo-colors = "4.2.0"
|
|
path-absolutize = "3.1.1"
|
|
path-clean = "1.0.1"
|
|
pathdiff = "0.2"
|
|
portable-pty = "0.9.0"
|
|
predicates = "3"
|
|
pretty_assertions = "1.4.1"
|
|
pulldown-cmark = "0.10"
|
|
rand = "0.9"
|
|
ratatui = "0.29.0"
|
|
regex-lite = "0.1.7"
|
|
reqwest = "0.12"
|
|
schemars = "0.8.22"
|
|
seccompiler = "0.5.0"
|
|
serde = "1"
|
|
serde_json = "1"
|
|
serde_with = "3.14"
|
|
sha1 = "0.10.6"
|
|
sha2 = "0.10"
|
|
shlex = "1.3.0"
|
|
similar = "2.7.0"
|
|
starlark = "0.13.0"
|
|
strum = "0.27.2"
|
|
strum_macros = "0.27.2"
|
|
supports-color = "3.0.2"
|
|
sys-locale = "0.3.2"
|
|
tempfile = "3.23.0"
|
|
textwrap = "0.16.2"
|
|
thiserror = "2.0.16"
|
|
time = "0.3"
|
|
tiny_http = "0.12"
|
|
tokio = "1"
|
|
tokio-stream = "0.1.17"
|
|
tokio-test = "0.4"
|
|
tokio-util = "0.7.16"
|
|
toml = "0.9.5"
|
|
toml_edit = "0.23.4"
|
|
tracing = "0.1.41"
|
|
tracing-appender = "0.2.3"
|
|
tracing-subscriber = "0.3.20"
|
|
tracing-test = "0.2.5"
|
|
tree-sitter = "0.25.9"
|
|
tree-sitter-bash = "0.25.0"
|
|
ts-rs = "11"
|
|
tonic = "0.13.1"
|
|
unicode-segmentation = "1.12.0"
|
|
unicode-width = "0.2"
|
|
url = "2"
|
|
urlencoding = "2.1"
|
|
uuid = "1"
|
|
vt100 = "0.16.2"
|
|
walkdir = "2.5.0"
|
|
webbrowser = "1.0"
|
|
which = "6"
|
|
wildmatch = "2.5.0"
|
|
wiremock = "0.6"
|
|
zeroize = "1.8.1"
|
|
|
|
[workspace.lints]
|
|
rust = {}
|
|
|
|
[workspace.lints.clippy]
|
|
expect_used = "deny"
|
|
identity_op = "deny"
|
|
manual_clamp = "deny"
|
|
manual_filter = "deny"
|
|
manual_find = "deny"
|
|
manual_flatten = "deny"
|
|
manual_map = "deny"
|
|
manual_memcpy = "deny"
|
|
manual_non_exhaustive = "deny"
|
|
manual_ok_or = "deny"
|
|
manual_range_contains = "deny"
|
|
manual_retain = "deny"
|
|
manual_strip = "deny"
|
|
manual_try_fold = "deny"
|
|
manual_unwrap_or = "deny"
|
|
needless_borrow = "deny"
|
|
needless_borrowed_reference = "deny"
|
|
needless_collect = "deny"
|
|
needless_late_init = "deny"
|
|
needless_option_as_deref = "deny"
|
|
needless_question_mark = "deny"
|
|
needless_update = "deny"
|
|
redundant_clone = "deny"
|
|
redundant_closure = "deny"
|
|
redundant_closure_for_method_calls = "deny"
|
|
redundant_static_lifetimes = "deny"
|
|
trivially_copy_pass_by_ref = "deny"
|
|
uninlined_format_args = "deny"
|
|
unnecessary_filter_map = "deny"
|
|
unnecessary_lazy_evaluations = "deny"
|
|
unnecessary_sort_by = "deny"
|
|
unnecessary_to_owned = "deny"
|
|
unwrap_used = "deny"
|
|
|
|
# cargo-shear cannot see the platform-specific openssl-sys usage, so we
|
|
# silence the false positive here instead of deleting a real dependency.
|
|
[workspace.metadata.cargo-shear]
|
|
ignored = ["openssl-sys", "codex-utils-readiness"]
|
|
|
|
[profile.release]
|
|
lto = "fat"
|
|
# Because we bundle some of these executables with the TypeScript CLI, we
|
|
# remove everything to make the binary as small as possible.
|
|
strip = "symbols"
|
|
|
|
# See https://github.com/openai/codex/issues/1411 for details.
|
|
codegen-units = 1
|
|
|
|
[patch.crates-io]
|
|
# ratatui = { path = "../../ratatui" }
|
|
ratatui = { git = "https://github.com/nornagon/ratatui", branch = "nornagon-v0.29.0-patch" }
|