634650dd25
Add metrics capabilities to Codex. The `README.md` is up to date. This will not be merged with the metrics before this PR of course: https://github.com/openai/codex/pull/8350
87 lines
2.6 KiB
Rust
87 lines
2.6 KiB
Rust
use codex_otel::metrics::MetricsClient;
|
|
use codex_otel::metrics::MetricsConfig;
|
|
use codex_otel::metrics::MetricsError;
|
|
use codex_otel::metrics::Result;
|
|
use opentelemetry_sdk::metrics::InMemoryMetricExporter;
|
|
|
|
fn build_in_memory_client() -> Result<MetricsClient> {
|
|
let exporter = InMemoryMetricExporter::default();
|
|
let config = MetricsConfig::in_memory("test", "codex-cli", env!("CARGO_PKG_VERSION"), exporter);
|
|
MetricsClient::new(config)
|
|
}
|
|
|
|
// Ensures invalid tag components are rejected during config build.
|
|
#[test]
|
|
fn invalid_tag_component_is_rejected() -> Result<()> {
|
|
let err = MetricsConfig::in_memory(
|
|
"test",
|
|
"codex-cli",
|
|
env!("CARGO_PKG_VERSION"),
|
|
InMemoryMetricExporter::default(),
|
|
)
|
|
.with_tag("bad key", "value")
|
|
.unwrap_err();
|
|
assert!(matches!(
|
|
err,
|
|
MetricsError::InvalidTagComponent { label, value }
|
|
if label == "tag key" && value == "bad key"
|
|
));
|
|
Ok(())
|
|
}
|
|
|
|
// Ensures per-metric tag keys are validated.
|
|
#[test]
|
|
fn counter_rejects_invalid_tag_key() -> Result<()> {
|
|
let metrics = build_in_memory_client()?;
|
|
let err = metrics
|
|
.counter("codex.turns", 1, &[("bad key", "value")])
|
|
.unwrap_err();
|
|
assert!(matches!(
|
|
err,
|
|
MetricsError::InvalidTagComponent { label, value }
|
|
if label == "tag key" && value == "bad key"
|
|
));
|
|
metrics.shutdown()?;
|
|
Ok(())
|
|
}
|
|
|
|
// Ensures per-metric tag values are validated.
|
|
#[test]
|
|
fn histogram_rejects_invalid_tag_value() -> Result<()> {
|
|
let metrics = build_in_memory_client()?;
|
|
let err = metrics
|
|
.histogram("codex.request_latency", 3, &[("route", "bad value")])
|
|
.unwrap_err();
|
|
assert!(matches!(
|
|
err,
|
|
MetricsError::InvalidTagComponent { label, value }
|
|
if label == "tag value" && value == "bad value"
|
|
));
|
|
metrics.shutdown()?;
|
|
Ok(())
|
|
}
|
|
|
|
// Ensures invalid metric names are rejected.
|
|
#[test]
|
|
fn counter_rejects_invalid_metric_name() -> Result<()> {
|
|
let metrics = build_in_memory_client()?;
|
|
let err = metrics.counter("bad name", 1, &[]).unwrap_err();
|
|
assert!(matches!(
|
|
err,
|
|
MetricsError::InvalidMetricName { name } if name == "bad name"
|
|
));
|
|
metrics.shutdown()?;
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn counter_rejects_negative_increment() -> Result<()> {
|
|
let metrics = build_in_memory_client()?;
|
|
let err = metrics.counter("codex.turns", -1, &[]).unwrap_err();
|
|
assert!(matches!(
|
|
err,
|
|
MetricsError::NegativeCounterIncrement { name, inc } if name == "codex.turns" && inc == -1
|
|
));
|
|
metrics.shutdown()?;
|
|
Ok(())
|
|
}
|