agent/codex
2
0
Fork 0
mirror of https://github.com/pchuan98/codex.git synced 2026-07-01 00:31:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add websocket telemetry metrics and labels (#10316)

Browse Source 
Summary
- expose websocket telemetry hooks through the responses client so
request durations and event processing can be reported
- record websocket request/event metrics and emit runtime telemetry
events that the history UI now surfaces
- improve tests to cover websocket telemetry reporting and guard runtime
summary updates


<img width="824" height="79" alt="Screenshot 2026-01-31 at 5 28 12 PM"
src="https://github.com/user-attachments/assets/ea9a7965-d8b4-4e3c-a984-ef4fdc44c81d"
/>
This commit is contained in:
Anton Panasenko
2026-01-31 19:16:44 -08:00
committed by GitHub
Unverified
parent aab3705c7e
commit 101d359cd7
14 changed files with 335 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
codex-rs/otel/src/metrics/names.rs
+4
View File
@@ -4,3 +4,7 @@ pub(crate) const API_CALL_COUNT_METRIC: &str = "codex.api_request";
pub(crate) const API_CALL_DURATION_METRIC: &str = "codex.api_request.duration_ms";
pub(crate) const SSE_EVENT_COUNT_METRIC: &str = "codex.sse_event";
pub(crate) const SSE_EVENT_DURATION_METRIC: &str = "codex.sse_event.duration_ms";
pub(crate) const WEBSOCKET_REQUEST_COUNT_METRIC: &str = "codex.websocket.request";
pub(crate) const WEBSOCKET_REQUEST_DURATION_METRIC: &str = "codex.websocket.request.duration_ms";
pub(crate) const WEBSOCKET_EVENT_COUNT_METRIC: &str = "codex.websocket.event";
pub(crate) const WEBSOCKET_EVENT_DURATION_METRIC: &str = "codex.websocket.event.duration_ms";
codex-rs/otel/src/metrics/runtime_metrics.rs
+21 -1
View File
@@ -4,6 +4,10 @@ use crate::metrics::names::SSE_EVENT_COUNT_METRIC;
use crate::metrics::names::SSE_EVENT_DURATION_METRIC;
use crate::metrics::names::TOOL_CALL_COUNT_METRIC;
use crate::metrics::names::TOOL_CALL_DURATION_METRIC;
use crate::metrics::names::WEBSOCKET_EVENT_COUNT_METRIC;
use crate::metrics::names::WEBSOCKET_EVENT_DURATION_METRIC;
use crate::metrics::names::WEBSOCKET_REQUEST_COUNT_METRIC;
use crate::metrics::names::WEBSOCKET_REQUEST_DURATION_METRIC;
use opentelemetry_sdk::metrics::data::AggregatedMetrics;
use opentelemetry_sdk::metrics::data::Metric;
use opentelemetry_sdk::metrics::data::MetricData;
@@ -26,11 +30,17 @@ pub struct RuntimeMetricsSummary {
pub tool_calls: RuntimeMetricTotals,
pub api_calls: RuntimeMetricTotals,
pub streaming_events: RuntimeMetricTotals,
pub websocket_calls: RuntimeMetricTotals,
pub websocket_events: RuntimeMetricTotals,
}
impl RuntimeMetricsSummary {
pub fn is_empty(self) -> bool {
self.tool_calls.is_empty() && self.api_calls.is_empty() && self.streaming_events.is_empty()
self.tool_calls.is_empty()
&& self.api_calls.is_empty()
&& self.streaming_events.is_empty()
&& self.websocket_calls.is_empty()
&& self.websocket_events.is_empty()
}
pub(crate) fn from_snapshot(snapshot: &ResourceMetrics) -> Self {
@@ -46,10 +56,20 @@ impl RuntimeMetricsSummary {
count: sum_counter(snapshot, SSE_EVENT_COUNT_METRIC),
duration_ms: sum_histogram_ms(snapshot, SSE_EVENT_DURATION_METRIC),
};
let websocket_calls = RuntimeMetricTotals {
count: sum_counter(snapshot, WEBSOCKET_REQUEST_COUNT_METRIC),
duration_ms: sum_histogram_ms(snapshot, WEBSOCKET_REQUEST_DURATION_METRIC),
};
let websocket_events = RuntimeMetricTotals {
count: sum_counter(snapshot, WEBSOCKET_EVENT_COUNT_METRIC),
duration_ms: sum_histogram_ms(snapshot, WEBSOCKET_EVENT_DURATION_METRIC),
};
Self {
tool_calls,
api_calls,
streaming_events,
websocket_calls,
websocket_events,
}
}
}
codex-rs/otel/src/traces/otel_manager.rs
+134
View File
@@ -4,9 +4,14 @@ use crate::metrics::names::SSE_EVENT_COUNT_METRIC;
use crate::metrics::names::SSE_EVENT_DURATION_METRIC;
use crate::metrics::names::TOOL_CALL_COUNT_METRIC;
use crate::metrics::names::TOOL_CALL_DURATION_METRIC;
use crate::metrics::names::WEBSOCKET_EVENT_COUNT_METRIC;
use crate::metrics::names::WEBSOCKET_EVENT_DURATION_METRIC;
use crate::metrics::names::WEBSOCKET_REQUEST_COUNT_METRIC;
use crate::metrics::names::WEBSOCKET_REQUEST_DURATION_METRIC;
use crate::otel_provider::traceparent_context_from_env;
use chrono::SecondsFormat;
use chrono::Utc;
use codex_api::ApiError;
use codex_api::ResponseEvent;
use codex_app_server_protocol::AuthMode;
use codex_protocol::ThreadId;
@@ -36,6 +41,7 @@ pub use crate::OtelManager;
pub use crate::ToolDecisionSource;
const SSE_UNKNOWN_KIND: &str = "unknown";
const WEBSOCKET_UNKNOWN_KIND: &str = "unknown";
impl OtelManager {
#[allow(clippy::too_many_arguments)]
@@ -190,6 +196,134 @@ impl OtelManager {
);
}
pub fn record_websocket_request(&self, duration: Duration, error: Option<&str>) {
let success_str = if error.is_none() { "true" } else { "false" };
self.counter(
WEBSOCKET_REQUEST_COUNT_METRIC,
1,
&[("success", success_str)],
);
self.record_duration(
WEBSOCKET_REQUEST_DURATION_METRIC,
duration,
&[("success", success_str)],
);
tracing::event!(
tracing::Level::INFO,
event.name = "codex.websocket_request",
event.timestamp = %timestamp(),
conversation.id = %self.metadata.conversation_id,
app.version = %self.metadata.app_version,
auth_mode = self.metadata.auth_mode,
user.account_id = self.metadata.account_id,
user.email = self.metadata.account_email,
terminal.type = %self.metadata.terminal_type,
model = %self.metadata.model,
slug = %self.metadata.slug,
duration_ms = %duration.as_millis(),
success = success_str,
error.message = error,
);
}
pub fn record_websocket_event(
&self,
result: &Result<
Option<
Result<
tokio_tungstenite::tungstenite::Message,
tokio_tungstenite::tungstenite::Error,
>,
>,
ApiError,
>,
duration: Duration,
) {
let mut kind = None;
let mut error_message = None;
let mut success = true;
match result {
Ok(Some(Ok(message))) => match message {
tokio_tungstenite::tungstenite::Message::Text(text) => {
match serde_json::from_str::<serde_json::Value>(text) {
Ok(value) => {
kind = value
.get("type")
.and_then(|value| value.as_str())
.map(std::string::ToString::to_string);
if kind.as_deref() == Some("response.failed") {
success = false;
error_message = value
.get("response")
.and_then(|value| value.get("error"))
.map(serde_json::Value::to_string)
.or_else(|| Some("response.failed event received".to_string()));
}
}
Err(err) => {
kind = Some("parse_error".to_string());
error_message = Some(err.to_string());
success = false;
}
}
}
tokio_tungstenite::tungstenite::Message::Binary(_) => {
success = false;
error_message = Some("unexpected binary websocket event".to_string());
}
tokio_tungstenite::tungstenite::Message::Ping(_)
| tokio_tungstenite::tungstenite::Message::Pong(_) => {
return;
}
tokio_tungstenite::tungstenite::Message::Close(_) => {
success = false;
error_message =
Some("websocket closed by server before response.completed".to_string());
}
tokio_tungstenite::tungstenite::Message::Frame(_) => {
success = false;
error_message = Some("unexpected websocket frame".to_string());
}
},
Ok(Some(Err(err))) => {
success = false;
error_message = Some(err.to_string());
}
Ok(None) => {
success = false;
error_message = Some("stream closed before response.completed".to_string());
}
Err(err) => {
success = false;
error_message = Some(err.to_string());
}
}
let kind_str = kind.as_deref().unwrap_or(WEBSOCKET_UNKNOWN_KIND);
let success_str = if success { "true" } else { "false" };
let tags = [("kind", kind_str), ("success", success_str)];
self.counter(WEBSOCKET_EVENT_COUNT_METRIC, 1, &tags);
self.record_duration(WEBSOCKET_EVENT_DURATION_METRIC, duration, &tags);
tracing::event!(
tracing::Level::INFO,
event.name = "codex.websocket_event",
event.timestamp = %timestamp(),
event.kind = %kind_str,
conversation.id = %self.metadata.conversation_id,
app.version = %self.metadata.app_version,
auth_mode = self.metadata.auth_mode,
user.account_id = self.metadata.account_id,
user.email = self.metadata.account_email,
terminal.type = %self.metadata.terminal_type,
model = %self.metadata.model,
slug = %self.metadata.slug,
duration_ms = %duration.as_millis(),
success = success_str,
error.message = error_message.as_deref(),
);
}
pub fn log_sse_event<E>(
&self,
response: &Result<Option<Result<StreamEvent, StreamError<E>>>, Elapsed>,