Salud y readiness

Esta página cubre las sondas HTTP operacionales /health, /readyz y /version. Los orquestadores como Kubernetes las usan para decidir cuándo un servicio está vivo, cuándo puede recibir tráfico y qué build ejecuta. Las rutas, los puertos y los cuerpos de respuesta varían según el servicio. Consulta la tabla de cobertura por servicio a continuación.

Los endpoints de las sondas

Endpoint	Método	Propósito
`/health`	GET	Liveness. Confirma que el proceso está activo.
`/readyz`	GET	Readiness. Confirma que el servicio puede recibir tráfico.
`/version`	GET	Versión. Devuelve la versión del servicio.

El cuerpo de la respuesta de `/readyz`

/readyz devuelve un documento JSON que describe la readiness general y cada verificación de dependencia.

{
  "status": "healthy",
  "checks": {
    "postgres": { "status": "up", "latency_ms": 2, "tls": true },
    "redis":    { "status": "skipped", "reason": "not configured" },
    "rabbitmq": { "status": "up", "breaker_state": "closed", "latency_ms": 12 }
  },
  "version": "1.2.3",
  "deployment_mode": "byoc"
}

Campo	Significado
`status`	Readiness general.
`checks`	Una entrada por dependencia (Postgres, MongoDB, Redis, RabbitMQ, systemplane y otras).
`checks.<dep>.status`	Resultado por dependencia: `up`, `down`, `degraded`, `skipped` o `n/a`.
`checks.<dep>.latency_ms`	Latencia de ida y vuelta de la sonda en milisegundos, cuando se mide.
`checks.<dep>.tls`	Si la conexión con esa dependencia usa TLS.
`checks.<dep>.breaker_state`	Estado del circuit breaker, cuando un breaker antecede a la dependencia.
`checks.<dep>.error` / `.reason`	Detalle del fallo o el motivo por el que se omitió una verificación.
`version`	Versión del servicio en ejecución.
`deployment_mode`	El `DEPLOYMENT_MODE` activo.

Qué verificaciones convierten la respuesta en HTTP 503, y si una verificación degraded también lo hace, varía según el servicio.

Cobertura por servicio

La tabla lista los puertos predeterminados y las desviaciones de ruta.

Producto / servicio	Puerto principal	Liveness	Readiness	Notas
Midaz ledger	3002	`/health`	`/readyz`	También `/version`. Sin `/metrics` (OTLP push).
Reporter (API)	4005	`/health`	`/readyz`	`/version`.
Reporter (worker)	4006	`/health`	`/readyz`	`/version`. Servidor de salud dedicado para el worker.
Lender	8080	`/health`	`/readyz`	`/version`. Los listeners de webhook exponen solo `/readyz`. API de administración de systemplane.
Access Manager	4000 (autenticación), 4001 (identidad)	`/health`	`/readyz`	Dos servidores, cada uno con sus propias sondas y `/version`. `/readyz` también devuelve `revision` y `buildTime`.
Console	8081	`/api/admin/health/alive`	`/api/admin/health/readyz`	Desviación: las sondas están en `/api/admin/health/`.
Streaming Hub	8080	`/healthz`	`/readyz`	Desviación: el liveness es `/healthz`. También `/version`, `/metrics`, `/runtime`. El cuerpo de `/readyz` tiene `state`, `version`, `ingestAllowed` y `probes`.
Pix (Directo, vía JD)	8080	`/health`	`/readyz`	`/metrics`, `/version`. API de administración de systemplane.
Pix (Indirecto, vía BTG)	4014	`/health`	`/readyz`	Multicomponente (API más workers).
Pix Lerian	Varía (componente dedicado)	Varía	Varía	Systemplane se ejecuta como un componente desplegable independiente. Consulta variables de entorno de Pix Lerian.
TED (vía JD)	4027	`/health`, `/health/live`	`/readyz`, `/health/ready`	Desviación: además expone `/health/live` y `/health/ready`. API de administración de systemplane.
Boleto y pagos de facturas (vía BTG)	8080	`/health`	`/readyz`	Multicomponente.
CCS	4030	`/health`	`/readyz`	`/metrics`, `/version`. API de administración de systemplane.
STA	4028	`/health`	`/readyz`	`/metrics`, `/version`. API de administración de systemplane.
SISBAJUD Mensageria	4031	`/health`	`/readyz`	`/version`. API de administración de systemplane. La API de ejecución escucha en su propio puerto TLS, 4032.
SISBAJUD executor	Define `SERVER_ADDRESS` como `:4029`	`/health`	`/readyz`	`/version`. El puerto 4029 es el puerto que expone la imagen. API de administración de systemplane. El listener de webhook usa su propio puerto, 9082.
SLC	4111	`/health`	`/readyz`	`/metrics`, `/version`. API de administración de systemplane.
SPI	8080	`/health`	`/readyz`	API de administración de systemplane.
SPB	3000	`/health`	`/readyz`	API de administración de systemplane.
SILOC	9820	`/health`	`/readyz`	—
Consignado	8080	`/health`	`/readyz`	`/metrics`, `/version`. API de administración de systemplane.
BC Correios	9090	`/health`	`/readyz`	`/version`.
SRC	3006	`/health`	`/readyz`	`/version`. API de administración de systemplane.

Puertos son los valores predeterminados de compose/.env.example y se pueden sobrescribir por despliegue. Consulta Puertos de red predeterminados. Varía (Varies) marca un servicio cuyo puerto predeterminado depende de la configuración de despliegue.

Resumen

Fundamentos de integración

Estabilidad y calidad

Diccionario de campos

Streaming de eventos

Salud y readiness

Los endpoints de las sondas

El cuerpo de la respuesta de `/readyz`

Cobertura por servicio

​Los endpoints de las sondas

​El cuerpo de la respuesta de /readyz

​Cobertura por servicio

Los endpoints de las sondas

El cuerpo de la respuesta de `/readyz`

Cobertura por servicio