2025-09-23 07:25:46 -07:00
|
|
|
|
#![cfg(not(target_os = "windows"))]
|
|
|
|
|
|
|
|
|
|
|
|
use std::os::unix::fs::PermissionsExt;
|
|
|
|
|
|
|
|
|
|
|
|
use codex_core::protocol::EventMsg;
|
|
|
|
|
|
use codex_core::protocol::Op;
|
2025-10-20 13:34:44 -07:00
|
|
|
|
use codex_protocol::user_input::UserInput;
|
2025-10-15 09:56:59 +01:00
|
|
|
|
use core_test_support::fs_wait;
|
2025-09-23 07:25:46 -07:00
|
|
|
|
use core_test_support::responses;
|
2025-09-25 13:11:14 -07:00
|
|
|
|
use core_test_support::skip_if_no_network;
|
2025-09-23 07:25:46 -07:00
|
|
|
|
use core_test_support::test_codex::TestCodex;
|
|
|
|
|
|
use core_test_support::test_codex::test_codex;
|
|
|
|
|
|
use core_test_support::wait_for_event;
|
|
|
|
|
|
use tempfile::TempDir;
|
|
|
|
|
|
use wiremock::matchers::any;
|
|
|
|
|
|
|
|
|
|
|
|
use responses::ev_assistant_message;
|
|
|
|
|
|
use responses::ev_completed;
|
|
|
|
|
|
use responses::sse;
|
|
|
|
|
|
use responses::start_mock_server;
|
2025-10-15 09:56:59 +01:00
|
|
|
|
use std::time::Duration;
|
2025-09-23 07:25:46 -07:00
|
|
|
|
|
|
|
|
|
|
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
|
|
|
|
|
async fn summarize_context_three_requests_and_instructions() -> anyhow::Result<()> {
|
2025-09-25 13:11:14 -07:00
|
|
|
|
skip_if_no_network!(Ok(()));
|
2025-09-23 07:25:46 -07:00
|
|
|
|
|
|
|
|
|
|
let server = start_mock_server().await;
|
|
|
|
|
|
|
|
|
|
|
|
let sse1 = sse(vec![ev_assistant_message("m1", "Done"), ev_completed("r1")]);
|
|
|
|
|
|
|
OpenTelemetry events (#2103)
### 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>
2025-09-29 19:30:55 +01:00
|
|
|
|
responses::mount_sse_once_match(&server, any(), sse1).await;
|
2025-09-23 07:25:46 -07:00
|
|
|
|
|
|
|
|
|
|
let notify_dir = TempDir::new()?;
|
|
|
|
|
|
// write a script to the notify that touches a file next to it
|
|
|
|
|
|
let notify_script = notify_dir.path().join("notify.sh");
|
|
|
|
|
|
std::fs::write(
|
|
|
|
|
|
¬ify_script,
|
|
|
|
|
|
r#"#!/bin/bash
|
|
|
|
|
|
set -e
|
|
|
|
|
|
echo -n "${@: -1}" > $(dirname "${0}")/notify.txt"#,
|
|
|
|
|
|
)?;
|
|
|
|
|
|
std::fs::set_permissions(¬ify_script, std::fs::Permissions::from_mode(0o755))?;
|
|
|
|
|
|
|
|
|
|
|
|
let notify_file = notify_dir.path().join("notify.txt");
|
|
|
|
|
|
let notify_script_str = notify_script.to_str().unwrap().to_string();
|
|
|
|
|
|
|
|
|
|
|
|
let TestCodex { codex, .. } = test_codex()
|
|
|
|
|
|
.with_config(move |cfg| cfg.notify = Some(vec![notify_script_str]))
|
|
|
|
|
|
.build(&server)
|
|
|
|
|
|
.await?;
|
|
|
|
|
|
|
|
|
|
|
|
// 1) Normal user input – should hit server once.
|
|
|
|
|
|
codex
|
|
|
|
|
|
.submit(Op::UserInput {
|
2025-10-20 13:34:44 -07:00
|
|
|
|
items: vec![UserInput::Text {
|
2025-09-23 07:25:46 -07:00
|
|
|
|
text: "hello world".into(),
|
|
|
|
|
|
}],
|
|
|
|
|
|
})
|
|
|
|
|
|
.await?;
|
|
|
|
|
|
wait_for_event(&codex, |ev| matches!(ev, EventMsg::TaskComplete(_))).await;
|
|
|
|
|
|
|
|
|
|
|
|
// We fork the notify script, so we need to wait for it to write to the file.
|
2025-10-15 09:56:59 +01:00
|
|
|
|
fs_wait::wait_for_path_exists(¬ify_file, Duration::from_secs(5)).await?;
|
2025-09-23 07:25:46 -07:00
|
|
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
|
|
}
|