Skip to main content

BrowserObservabilityConfigDto

Browser RUM bootstrap configuration returned by GET /api/v1/observability/config.

enabledbooleanrequired

Whether the browser SDK should initialize. False means the SDK bootstrap is a no-op even if the script is loaded.

proxyPathstringrequired

Same-origin path prefix on the Codex server where the browser SDK should POST OTLP batches. The SDK appends /v1/traces and /v1/metrics to this base.

Example: /api/v1/observability/otlp
sampleRationumber<double>required

Parent-based sampling ratio applied client-side. Browsers are noisy; default low.

Example: 0.1
serviceNamestringrequired

service.name resource attribute the browser SDK should set on every span (matches the backend service name unless the operator overrode it specifically for the browser).

Example: codex-web
BrowserObservabilityConfigDto
{
  "enabled": true,
  "proxyPath": "/api/v1/observability/otlp",
  "sampleRatio": 0.1,
  "serviceName": "codex-web"
}