Salud y readiness

Referencia de las sondas /health, /readyz y /version, con las formas de respuesta y la cobertura por servicio.

Esta página describe el contrato del puerto de health que usan las releases que lo adoptan. Las releases anteriores pueden usar otras rutas, puertos y cuerpos de respuesta. Consulta la cobertura por servicio.

​

Los endpoints de las sondas

Endpoint	Puerto	Propósito
/health	Health	Liveness. Devuelve el texto healthy o unhealthy; una falla en la verificación Live devuelve HTTP 503.
/readyz	Health	Readiness. Devuelve las verificaciones y la versión del servicio en JSON.
/version	Principal	Devuelve la versión del servicio.
/health	Principal	Devuelve una respuesta exitosa constante.
/metrics	Health	Expone métricas de health para Prometheus.

Configura HEALTH_PORT para habilitar el listener de health. Si no tiene valor, el listener no inicia. Los charts y ejemplos configuran 8099; la biblioteca no elige un puerto. Mantén el puerto de health interno y fuera de Ingress y balanceadores de carga públicos. Los puertos principales de las API no cambian.

Algunos servicios multi-tenant exponen /readyz/tenant/:id en el puerto de health. Esta verificación bajo demanda no requiere autenticación y no cambia la readiness del pod.

​

El cuerpo de la respuesta de /readyz

El siguiente cuerpo se aplica a las releases que usan el contrato compartido de health actual. Las verificaciones registradas varían según el servicio. Una verificación no configurada no tiene entrada.

{
  "status": "healthy",
  "checks": {
    "postgres": { "status": "up", "gating": false, "latency_ms": 2 }
  },
  "version": "1.2.3"
}

Campo	Significado
status	Resultado general: healthy, degraded o unhealthy.
checks	Verificaciones registradas y sus resultados.
checks.<dep>.status	Resultado de la verificación: up, down o degraded.
checks.<dep>.gating	Indica si la verificación condiciona la readiness.
checks.<dep>.latency_ms	Latencia de la sonda en milisegundos, cuando se mide.
checks.<dep>.error	Clase de error estable de un conjunto cerrado, cuando está presente; nunca el mensaje de error sin procesar de la dependencia.
version	Versión del servicio en ejecución.

La readiness devuelve HTTP 503 hasta que cada verificación Startup pase por primera vez. Después, una falla de dependencia compartida informa degraded con HTTP 200. La liveness puede devolver 503 por una falla en la verificación Live.

Las métricas compartidas de health son health_ready y health_check_status{check,mode,status}. Están separadas de la telemetría OTLP.

​

Cobertura por servicio

Consulta la versión del producto antes de cambiar las sondas. La disponibilidad en una release no significa que tu despliegue ya la use.

Producto / servicio	Release	Cobertura del puerto de health
Midaz	v4.4.1	Usa las sondas en el puerto principal que aparecen abajo.
Tracer	Actual	Usa el puerto de health. De las sondas, el puerto principal conserva solo /health y /version. La readiness devuelve 503 hasta que se acepta una licencia.
Matcher	v6.3.0	Usa el puerto de health.
Reporter	v4.9.0	Usa el puerto de health. La readiness devuelve 503 hasta que se acepta una licencia. El puerto de la API solo se abre después de eso.
Lender	v4.2.0	Usa el puerto de health. De las sondas, el puerto principal conserva solo /health y /version. La readiness devuelve 503 hasta que se acepta una licencia.
Streaming Hub	v3.4.0	Usa el puerto de health. De las sondas, el puerto principal conserva solo /health y /version, y también sirve /runtime. La readiness devuelve 503 hasta que se acepta una licencia.
Access Manager	v3.20.0	Usa el puerto de health. La readiness devuelve 503 hasta que se acepta una licencia.
Pix (Directo, vía JD)	v1.6.1	Usa el puerto de health.
Pix (Indirecto, vía BTG)	v1.15.0	Usa el puerto de health. La readiness devuelve 503 hasta que se acepta una licencia.
Pix Lerian	v1.3.0	Usa el puerto de health en cada componente. El puerto principal también responde /readyz bajo el prefijo de ruta.
TED Lerian	Actual	Usa el puerto de health. De las sondas, el puerto principal conserva solo /health y /version.
Consignado	v4.5.0	Usa el puerto de health. De las sondas, el puerto principal conserva solo /health y /version. /readyz reporta la verificación streaming, pero un broker caído no devuelve 503. La readiness devuelve 503 hasta que se acepta una licencia.
Boleto y pagos de facturas (vía BTG)	v1.3.0	Usa el puerto de health. La readiness devuelve 503 hasta que se acepta una licencia.
Plugin SISBAJUD	v1.3.0	Usa el puerto de health. De las sondas, el puerto principal conserva solo /health y /version. La readiness devuelve 503 hasta que pasan las verificaciones de arranque, PostgreSQL y licencia. Con la Mensageria en el transporte webhook, también espera el listener de webhook.

La tabla siguiente lista las sondas en el puerto principal de los servicios que no usan el puerto de health, y cada servicio conserva su propio contrato.

Producto / servicio	Puerto principal	Liveness	Readiness	Notas
Midaz ledger	3002	/health	/readyz	También /version. Sin /metrics (OTLP push).
Console	8081	/api/admin/health/alive	/api/admin/health/readyz	Desviación: las sondas están en /api/admin/health/. La readiness devuelve 503 hasta que se acepta una licencia. MongoDB se reporta y no bloquea la readiness.
TED (vía JD)	8080	/health, /health/live	/readyz, /health/ready	Desviación: además expone /health/live y /health/ready. API de administración de systemplane.
CCS	4030	/health	/readyz	/metrics, /version.
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.
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	—
Flowker	4021	/health	/readyz	/version. El worker responde /health, /readyz y /version en 4022.
JD Courier	8080	/health	/readyz	/version. API de administración de systemplane cuando está habilitada.
BC Correios	8080	/health	/readyz	/version.
SCR	3003	/health	/readyz	/version. API de administración de systemplane.
SRC	3006	/health	/readyz	/version. API de administración de systemplane.

Puertos son valores predeterminados y se pueden sobrescribir por despliegue. Consulta Puertos de red predeterminados.