> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Health e readiness

> Consulte as probes /health, /readyz e /version, com os formatos de resposta e a cobertura por serviço.

Esta página cobre as probes HTTP operacionais `/health`, `/readyz` e `/version`. Orquestradores como o Kubernetes as usam para decidir quando um serviço está ativo, quando pode receber tráfego e qual build ele executa. Caminhos, portas e corpos de resposta diferem por serviço. Veja a [tabela de cobertura por serviço](#per-service-coverage) abaixo.

## Os endpoints de probe

| Endpoint | Método | Finalidade |
| - | - | - |
| `/health` | GET | **Liveness.** Confirma que o processo está ativo. |
| `/readyz` | GET | **Readiness.** Confirma que o serviço pode receber tráfego. |
| `/version` | GET | **Versão.** Retorna a versão do serviço. |

## O corpo da resposta de `/readyz`

`/readyz` retorna um documento JSON que descreve a readiness geral e cada verificação de dependência.

```json theme={null}
{
  "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 geral. |
| `checks` | Uma entrada por dependência (Postgres, MongoDB, Redis, RabbitMQ, systemplane e outras). |
| `checks.<dep>.status` | Resultado por dependência: `up`, `down`, `degraded`, `skipped` ou `n/a`. |
| `checks.<dep>.latency_ms` | Latência de ida e volta da probe, em milissegundos, quando medida. |
| `checks.<dep>.tls` | Indica se a conexão com essa dependência usa TLS. |
| `checks.<dep>.breaker_state` | Estado do circuit breaker, quando um breaker está na frente da dependência. |
| `checks.<dep>.error` / `.reason` | Detalhe da falha ou o motivo pelo qual uma verificação foi pulada. |
| `version` | Versão em execução do serviço. |
| `deployment_mode` | O [`DEPLOYMENT_MODE`](https://docs.lerian.studio/pt/reference/byoc-configuration#deployment-mode-and-tls) ativo. |

Quais verificações transformam a resposta em HTTP `503`, e se uma verificação `degraded` também transforma, difere por serviço.

## Cobertura por serviço

A tabela lista as portas padrão e os desvios de path.

| Produto / serviço | Porta principal | Liveness | Readiness | Notas |
| - | - | - | - | - |
| Midaz ledger | 3002 | `/health` | `/readyz` | Também `/version`. Sem `/metrics` (push OTLP). |
| Reporter (API) | 4005 | `/health` | `/readyz` | `/version`. |
| Reporter (worker) | 4006 | `/health` | `/readyz` | `/version`. Servidor de health dedicado do worker. |
| Lender | 8080 | `/health` | `/readyz` | `/version`. Os listeners de webhook expõem apenas `/readyz`. API administrativa do systemplane. |
| Access Manager | 4000 (auth), 4001 (identity) | `/health` | `/readyz` | Dois servidores, cada um com suas próprias probes e `/version`. O `/readyz` também retorna `revision` e `buildTime`. |
| Console | 8081 | `/api/admin/health/alive` | `/api/admin/health/readyz` | **Desvio:** as probes ficam em `/api/admin/health/`. |
| Streaming Hub | 8080 | `/healthz` | `/readyz` | **Desvio:** o liveness é `/healthz`. Também `/version`, `/metrics`, `/runtime`. O corpo do `/readyz` tem `state`, `version`, `ingestAllowed` e `probes`. |
| Pix (Direto, via JD) | 8080 | `/health` | `/readyz` | `/metrics`, `/version`. API administrativa do systemplane. |
| Pix (Indireto, via BTG) | 4014 | `/health` | `/readyz` | Multicomponente (API mais workers). |
| Pix Lerian | Varia (componente dedicado) | Varia | Varia | O systemplane roda como um componente separado, com deploy próprio. Veja [variáveis de ambiente do Pix Lerian](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-environment-variables.md). |
| TED (via JD) | 4027 | `/health`, `/health/live` | `/readyz`, `/health/ready` | **Desvio:** também expõe `/health/live` e `/health/ready`. API administrativa do systemplane. |
| Boleto e pagamento de contas (via BTG) | 8080 | `/health` | `/readyz` | Multicomponente. |
| CCS | 4030 | `/health` | `/readyz` | `/metrics`, `/version`. API administrativa do systemplane. |
| STA | 4028 | `/health` | `/readyz` | `/metrics`, `/version`. API administrativa do systemplane. |
| SISBAJUD Mensageria | 4031 | `/health` | `/readyz` | `/version`. API administrativa do systemplane. A API de execução escuta na sua própria porta TLS, 4032. |
| SISBAJUD executor | Defina `SERVER_ADDRESS` como `:4029` | `/health` | `/readyz` | `/version`. A porta 4029 é a porta que a imagem expõe. API administrativa do systemplane. O listener de webhook usa a sua própria porta, 9082. |
| SLC | 4111 | `/health` | `/readyz` | `/metrics`, `/version`. API administrativa do systemplane. |
| SPI | 8080 | `/health` | `/readyz` | API administrativa do systemplane. |
| SPB | 3000 | `/health` | `/readyz` | API administrativa do systemplane. |
| SILOC | 9820 | `/health` | `/readyz` | — |
| Consignado | 8080 | `/health` | `/readyz` | `/metrics`, `/version`. API administrativa do systemplane. |
| BC Correios | 9090 | `/health` | `/readyz` | `/version`. |
| SRC | 3006 | `/health` | `/readyz` | `/version`. API administrativa do systemplane. |

> [!NOTE]
>
> **Portas** são os padrões do compose/`.env.example` e podem ser sobrescritas por deploy. Consulte [Portas de rede padrão](https://docs.lerian.studio/pt/reference/default-network-ports.md). Varia (`Varies`) marca um serviço cuja porta padrão depende da configuração de deploy.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.