mirror of
https://github.com/openai/codex.git
synced 2026-11-19 22:30:42 +00:00
## What changed - Allow system `requirements.toml` and MDM requirements to set `otel.headers_helper` and `otel.headers_helper_refresh_interval_ms`, and expose both fields through the requirements API. - Require an absolute executable path and run managed helpers directly from their installation directory. Reject helper settings from cloud requirements. - Restrict managed helper headers to OTLP HTTP exporters with nonempty endpoints configured in the same requirements layer. Replacing the helper or an exporter revokes the previous binding. - Document deployment and rollback requirements, including client compatibility and pausing affected exports until a failed helper recovers. ## Testing Add coverage for exporter layer boundaries, cloud policy rejection, relative path rejection, managed helper execution and recovery, missing executable diagnostics, and requirements API output. GitOrigin-RevId: 271058010c2e3090eb97cb357b70be4dc41b43db
149 lines
4.7 KiB
Rust
149 lines
4.7 KiB
Rust
use std::collections::BTreeMap;
|
|
use std::collections::HashMap;
|
|
use std::fmt;
|
|
use std::path::PathBuf;
|
|
use std::time::Duration;
|
|
|
|
use codex_utils_absolute_path::AbsolutePathBuf;
|
|
use serde::Deserialize;
|
|
use serde::Serialize;
|
|
|
|
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(),
|
|
}
|
|
}
|
|
|
|
/// Validates configured span attributes before they are attached to exported spans.
|
|
pub fn validate_span_attributes(attributes: &HashMap<String, String>) -> std::io::Result<()> {
|
|
if attributes.keys().any(String::is_empty) {
|
|
return Err(std::io::Error::new(
|
|
std::io::ErrorKind::InvalidInput,
|
|
"configured span attribute key must not be empty",
|
|
));
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct OtelSettings {
|
|
/// Optional credential helper shared by explicitly configured OTLP HTTP exporters.
|
|
pub headers_helper: Option<OtelHeadersHelper>,
|
|
pub http_client_factory: codex_http_client::HttpClientFactory,
|
|
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,
|
|
pub span_attributes: HashMap<String, String>,
|
|
pub tracestate: BTreeMap<String, BTreeMap<String, String>>,
|
|
}
|
|
|
|
/// A shared command for explicit OTLP HTTP exporters; never used by built-in analytics.
|
|
/// The command prints a JSON object of strings.
|
|
/// Its headers override static headers. A failed run suspends exports until recovery.
|
|
#[derive(Clone)]
|
|
pub struct OtelHeadersHelper {
|
|
pub command: String,
|
|
/// A managed executable runs directly from its parent directory. User commands run from Codex home.
|
|
pub managed: bool,
|
|
pub refresh_interval: Duration,
|
|
/// Signals whose exporter is authorized to receive this helper's headers.
|
|
pub apply_to_logs: bool,
|
|
pub apply_to_traces: bool,
|
|
pub apply_to_metrics: bool,
|
|
}
|
|
|
|
impl fmt::Debug for OtelHeadersHelper {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
f.debug_struct("OtelHeadersHelper")
|
|
.field("command", &"[REDACTED]")
|
|
.field("refresh_interval", &self.refresh_interval)
|
|
.finish()
|
|
}
|
|
}
|
|
|
|
/// Resolved Statsig metrics settings that another process can use to recreate
|
|
/// the built-in metrics exporter configuration without receiving generic
|
|
/// exporter credentials in-process.
|
|
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
|
|
pub struct StatsigMetricsSettings {
|
|
pub environment: String,
|
|
}
|
|
|
|
#[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
|
|
));
|
|
}
|
|
}
|