Health and readiness - Lerian

This page covers the operational HTTP probes /health, /readyz, and /version. Orchestrators such as Kubernetes use them to decide when a service is alive, when it can receive traffic, and which build it runs. Paths, ports, and response bodies differ per service. See the per-service coverage table below.

The probe endpoints

Endpoint	Method	Purpose
`/health`	GET	Liveness. Confirms the process is up.
`/readyz`	GET	Readiness. Confirms the service can receive traffic.
`/version`	GET	Version. Returns the service version.

The `/readyz` response body

/readyz returns a JSON document describing overall readiness and each dependency check.

{
  "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"
}

Field	Meaning
`status`	Overall readiness.
`checks`	One entry per dependency (Postgres, MongoDB, Redis, RabbitMQ, systemplane, and others).
`checks.<dep>.status`	Per-dependency result: `up`, `down`, `degraded`, `skipped`, or `n/a`.
`checks.<dep>.latency_ms`	Round-trip probe latency in milliseconds, when measured.
`checks.<dep>.tls`	Whether the connection to that dependency uses TLS.
`checks.<dep>.breaker_state`	Circuit-breaker state, when a breaker fronts the dependency.
`checks.<dep>.error` / `.reason`	Failure detail or the reason a check was skipped.
`version`	Running service version.
`deployment_mode`	The active `DEPLOYMENT_MODE`.

Which checks turn the response into HTTP 503, and whether a degraded check does, differs per service.

Per-service coverage

The table lists default ports and the path deviations.

Product / service	Main port	Liveness	Readiness	Notes
Midaz ledger	3002	`/health`	`/readyz`	Also `/version`. No `/metrics` (OTLP push).
Reporter (API)	4005	`/health`	`/readyz`	`/version`.
Reporter (worker)	4006	`/health`	`/readyz`	`/version`. Dedicated worker health server.
Lender	8080	`/health`	`/readyz`	`/version`. Webhook listeners expose `/readyz` only. Systemplane admin API.
Access Manager	4000 (auth), 4001 (identity)	`/health`	`/readyz`	Two servers, each with its own probes and `/version`. `/readyz` also returns `revision` and `buildTime`.
Console	8081	`/api/admin/health/alive`	`/api/admin/health/readyz`	Deviation: probes live under `/api/admin/health/`.
Streaming Hub	8080	`/healthz`	`/readyz`	Deviation: liveness is `/healthz`. Also `/version`, `/metrics`, `/runtime`. The `/readyz` body has `state`, `version`, `ingestAllowed`, and `probes`.
Pix (Direct, via JD)	8080	`/health`	`/readyz`	`/metrics`, `/version`. Systemplane admin API.
Pix (Indirect, via BTG)	4014	`/health`	`/readyz`	Multi-component (API plus workers).
Pix Lerian	Varies (dedicated component)	Varies	Varies	Systemplane runs as a separate deployable component. See Pix Lerian environment variables.
TED (via JD)	4027	`/health`, `/health/live`	`/readyz`, `/health/ready`	Deviation: additionally exposes `/health/live` and `/health/ready`. Systemplane admin API.
Boleto and bill payments (via BTG)	8080	`/health`	`/readyz`	Multi-component.
CCS	4030	`/health`	`/readyz`	`/metrics`, `/version`. Systemplane admin API.
STA	4028	`/health`	`/readyz`	`/metrics`, `/version`. Systemplane admin API.
SISBAJUD Mensageria	4031	`/health`	`/readyz`	`/version`. Systemplane admin API. The execution API listens on its own TLS port, 4032.
SISBAJUD executor	Set `SERVER_ADDRESS` to `:4029`	`/health`	`/readyz`	`/version`. Port 4029 is the port the image exposes. Systemplane admin API. The webhook listener uses its own port, 9082.
SLC	4111	`/health`	`/readyz`	`/metrics`, `/version`. Systemplane admin API.
SPI	8080	`/health`	`/readyz`	Systemplane admin API.
SPB	3000	`/health`	`/readyz`	Systemplane admin API.
SILOC	9820	`/health`	`/readyz`	—
Consignado	8080	`/health`	`/readyz`	`/metrics`, `/version`. Systemplane admin API.
BC Correios	9090	`/health`	`/readyz`	`/version`.
SRC	3006	`/health`	`/readyz`	`/version`. Systemplane admin API.

Ports are compose/.env.example defaults and can be overridden per deployment. See Default network ports. Varies marks a service whose default port depends on deployment configuration.