WuKongIM Docs

健康与就绪

正确使用 /healthz 和 /readyz。

编辑此页报告文档问题
Endpoint成功失败与含义
GET /healthz200 {"status":"ok"}只证明 HTTP 进程可响应
GET /readyz默认 200 {"ready":true},或 Provider 给出的就绪正文Provider 未就绪时返回 503 及其正文

两条路由始终注册且没有内建认证。/healthz 适合作为进程重启探针;只有 /readyz 可用于负载均衡接流量。就绪仍不证明容量、消息端到端送达、备份可恢复或高风险变更安全。

curl --fail http://127.0.0.1:5001/healthz
curl --fail http://127.0.0.1:5001/readyz

恢复维护期间这些入口仍可读取。保留 /readyz 的原始失败正文,不要用 /healthz 的 200 恢复业务流量。

GET/healthz

HTTP 进程能响应时返回 200;不代表集群已就绪。

响应主体

application/json

{  "status": "ok"}
GET/readyz

仅当当前节点可接收产品流量时返回 200;503 保留当前原因。

响应主体

application/json

application/json

{  "ready": true}