Variables de entorno que lee @styx/observability.
scripts/docs/env.schema.tsPágina generada desde
scripts/docs/env.schema.ts. No se edita a mano:bun run docs:genla regenera ybun run docs:checkfalla si difiere.
9 variables.
| Variable | Qué controla | Defecto | Marcas | La leen |
|---|---|---|---|---|
HOSTNAME | Nombre del contenedor/host; la telemetría lo usa como service.instance.id (si falta, un UUID por proceso). | — | — | @styx/observability |
NODE_ENV | production activa las reglas de producción: secretos sólo por _FILE, sin contraseñas en URLs, detalle de validación mínimo y NKey obligatoria. | — | — | @styx/bus, @styx/observability, @styx/service-http, catalog-svc, identity-svc, playback-svc, realtime-svc, sources-svc, web, workers-svc |
OTEL_EXPORTER_OTLP_ENDPOINT | Endpoint OTLP de trazas. Sin él, OpenTelemetry queda desactivado. Los servicios usan el gRPC del colector (4317); el daemon exporta spans y logs por OTLP/HTTP JSON a <endpoint>/v1/traces y /v1/logs y necesita el receptor HTTP (4318), en http:// (dec-0135 D4). | — | — | @styx/observability, media-daemon (daemon) |
OTEL_INGEST_TOKEN | Token con el que los servicios y el daemon se autentican contra el colector OTel. El daemon lo lee de OTEL_INGEST_TOKEN_FILE; en claro lo rechaza. | — | secreto (_FILE) | @styx/observability, catalog-svc, identity-svc, media-daemon (daemon), playback-svc, realtime-svc, sources-svc, web, workers-svc |
OTEL_METRIC_EXPORT_INTERVAL | Intervalo de exportación de métricas OTLP de los servicios, en ms; mínimo 1000 (defecto 15000). | 15000 | — | @styx/observability |
OTEL_SERVICE_NAME | Nombre de servicio en las trazas. | el nombre del servicio (catalog-svc, …) | — | @styx/observability, @styx/service-http, media-daemon (daemon), web |
OTEL_TRACES_SAMPLER_ARG | Ratio de muestreo de trazas (0..1, defecto 1). Un traceparent remoto con sampled=1 no fuerza el 100 %. | — | — | @styx/observability |
STYX_LOG_FORMAT | Formato de los logs: json (una línea JSON por registro con trace_id/span_id, para docker logs) o pretty. Por defecto json con NODE_ENV=production. | — | — | @styx/observability, media-daemon (daemon), web |
TELEMETRY_PSEUDONYM_KEY | Clave HMAC con la que la telemetría pseudonimiza los ids de actor (styx.actor.pseudo_id, dec-0135 §D7). Sin ella, ningún id de actor ni su pseudónimo sale en trazas ni logs. | — | secreto (_FILE) | @styx/observability, catalog-svc, identity-svc, playback-svc, realtime-svc, sources-svc, web, workers-svc |