Observabilidad
EntityFlow expone trazado, informe de errores, registros estructurados y una pista de auditoría — todo controlado por variables de entorno y desactivado de forma predeterminada, sin sobrecarga alguna hasta que lo actives.
Trazado
EntityFlow emite trazas de OpenTelemetry cuando EF_OTEL_ENABLED=true (desactivado de forma predeterminada — no hay sobrecarga cuando está desactivado). Apúntalo a tu colector con EF_OTEL_EXPORTER_OTLP_ENDPOINT y nombra el servicio con EF_OTEL_SERVICE_NAME (predeterminado ef-server).
Los spans cubren:
- solicitudes HTTP (tRPC y REST),
- consultas de base de datos,
- trabajos de proyección, generación de código y validación.
Errores
Establece EF_SENTRY_DSN para habilitar el informe de errores de Sentry. Cuando el DSN no está definido, Sentry queda completamente inactivo.
Registros
Los registros son JSON estructurado mediante pino. Controla el nivel de detalle con EF_LOG_LEVEL:
| Nivel | |
|---|---|
fatal error warn info debug trace silent | info es el valor predeterminado. |
Auditoría
Un registro de auditoría de solo anexado registra los eventos del ciclo de vida de las cuentas y las acciones de los administradores. Esta es una función empresarial (consulta Licencias) y se muestra en la página Registro de auditoría de EntityFlow Hub.
Ejemplo
Habilita el trazado y el informe de errores a la vez:
export EF_OTEL_ENABLED=true
export EF_OTEL_EXPORTER_OTLP_ENDPOINT="http://otel-collector:4318"
export EF_OTEL_SERVICE_NAME="ef-server"
export EF_SENTRY_DSN="https://examplePublicKey@o0.ingest.sentry.io/0"
export EF_LOG_LEVEL="info"
Consulta la referencia de configuración para ver la lista completa de variables de observabilidad.