mirror of
https://github.com/openai/codex.git
synced 2026-05-05 05:42:33 +03:00
## Why `codex-otel` still carried `disable-default-metrics-exporter`, which was the last remaining workspace crate feature. We are removing workspace crate features because they do not fit our current build model well: - our Bazel setup does not honor crate features today, which can let feature-gated issues go unnoticed - they create extra crate build permutations that we want to avoid For this case, the feature was only being used to keep the built-in Statsig metrics exporter off in test and debug-oriented contexts. This repo already treats `debug_assertions` as the practical proxy for that class of behavior, so OTEL should follow the same convention instead of keeping a dedicated crate feature alive. ## What changed - removed `disable-default-metrics-exporter` from `codex-rs/otel/Cargo.toml` - removed the `codex-otel` dev-dependency feature activation from `codex-rs/core/Cargo.toml` - changed `codex-rs/otel/src/config.rs` so the built-in `OtelExporter::Statsig` default resolves to `None` when `debug_assertions` is enabled, with a focused unit test covering that behavior - removed the final feature exceptions from `.github/scripts/verify_cargo_workspace_manifests.py`, so workspace crate features are now hard-banned instead of temporarily allowlisted - expanded the verifier error message to explain the Bazel mismatch and build-permutation cost behind that policy ## How tested - `python3 .github/scripts/verify_cargo_workspace_manifests.py` - `cargo test -p codex-otel` - `cargo test -p codex-core metrics_exporter_defaults_to_statsig_when_missing` - `cargo test -p codex-app-server app_server_default_analytics_` - `just bazel-lock-check`
95 lines
2.7 KiB
Rust
95 lines
2.7 KiB
Rust
use std::collections::HashMap;
|
|
use std::path::PathBuf;
|
|
|
|
use codex_utils_absolute_path::AbsolutePathBuf;
|
|
|
|
pub(crate) const STATSIG_OTLP_HTTP_ENDPOINT: &str = "https://ab.chatgpt.com/otlp/v1/metrics";
|
|
pub(crate) const STATSIG_API_KEY_HEADER: &str = "statsig-api-key";
|
|
pub(crate) const STATSIG_API_KEY: &str = "client-MkRuleRQBd6qakfnDYqJVR9JuXcY57Ljly3vi5JVUIO";
|
|
|
|
pub(crate) fn resolve_exporter(exporter: &OtelExporter) -> OtelExporter {
|
|
match exporter {
|
|
OtelExporter::Statsig => {
|
|
// Keep the built-in Statsig default off in debug builds so
|
|
// incremental local development and test runs do not emit
|
|
// best-effort OTEL traffic unless a test or binary opts into an
|
|
// explicit exporter configuration.
|
|
if cfg!(debug_assertions) {
|
|
return OtelExporter::None;
|
|
}
|
|
|
|
OtelExporter::OtlpHttp {
|
|
endpoint: STATSIG_OTLP_HTTP_ENDPOINT.to_string(),
|
|
headers: HashMap::from([(
|
|
STATSIG_API_KEY_HEADER.to_string(),
|
|
STATSIG_API_KEY.to_string(),
|
|
)]),
|
|
protocol: OtelHttpProtocol::Json,
|
|
tls: None,
|
|
}
|
|
}
|
|
_ => exporter.clone(),
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct OtelSettings {
|
|
pub environment: String,
|
|
pub service_name: String,
|
|
pub service_version: String,
|
|
pub codex_home: PathBuf,
|
|
pub exporter: OtelExporter,
|
|
pub trace_exporter: OtelExporter,
|
|
pub metrics_exporter: OtelExporter,
|
|
pub runtime_metrics: bool,
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub enum OtelHttpProtocol {
|
|
/// HTTP protocol with binary protobuf
|
|
Binary,
|
|
/// HTTP protocol with JSON payload
|
|
Json,
|
|
}
|
|
|
|
#[derive(Clone, Debug, Default)]
|
|
pub struct OtelTlsConfig {
|
|
pub ca_certificate: Option<AbsolutePathBuf>,
|
|
pub client_certificate: Option<AbsolutePathBuf>,
|
|
pub client_private_key: Option<AbsolutePathBuf>,
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub enum OtelExporter {
|
|
None,
|
|
/// Statsig metrics ingestion exporter using Codex-internal defaults.
|
|
///
|
|
/// This is intended for metrics only.
|
|
Statsig,
|
|
OtlpGrpc {
|
|
endpoint: String,
|
|
headers: HashMap<String, String>,
|
|
tls: Option<OtelTlsConfig>,
|
|
},
|
|
OtlpHttp {
|
|
endpoint: String,
|
|
headers: HashMap<String, String>,
|
|
protocol: OtelHttpProtocol,
|
|
tls: Option<OtelTlsConfig>,
|
|
},
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::OtelExporter;
|
|
use super::resolve_exporter;
|
|
|
|
#[test]
|
|
fn statsig_default_metrics_exporter_is_disabled_in_debug_builds() {
|
|
assert!(matches!(
|
|
resolve_exporter(&OtelExporter::Statsig),
|
|
OtelExporter::None
|
|
));
|
|
}
|
|
}
|