mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-08 15:51:06 +00:00
637f15375b
- cli-backends.md: remove duplicate modelAliases key - discovery.md: add missing transport=gateway and displayName TXT keys - authentication.md: retitle to "Authentication (Model Providers)", add disambiguation Note pointing to gateway connection auth docs - health.md: expand frontmatter scope, add --probe flag and response shape docs - gateway-lock.md: remove stale hardcoded date, add Related section - troubleshooting.md: fix wrong auth cross-link (model auth -> gateway config) - logging.md: add Related section linking to gateway logging internals
54 lines
3.6 KiB
Markdown
54 lines
3.6 KiB
Markdown
---
|
||
summary: "Health check commands and gateway health monitoring"
|
||
read_when:
|
||
- Diagnosing channel connectivity or gateway health
|
||
- Understanding health check CLI commands and options
|
||
title: "Health Checks"
|
||
---
|
||
|
||
# Health Checks (CLI)
|
||
|
||
Short guide to verify channel connectivity without guessing.
|
||
|
||
## Quick checks
|
||
|
||
- `openclaw status` — local summary: gateway reachability/mode, update hint, linked channel auth age, sessions + recent activity.
|
||
- `openclaw status --all` — full local diagnosis (read-only, color, safe to paste for debugging).
|
||
- `openclaw status --deep` — also probes the running Gateway (per-channel probes when supported).
|
||
- `openclaw health --json` — asks the running Gateway for a full health snapshot (WS-only; no direct Baileys socket).
|
||
- Send `/status` as a standalone message in WhatsApp/WebChat to get a status reply without invoking the agent.
|
||
- Logs: tail `/tmp/openclaw/openclaw-*.log` and filter for `web-heartbeat`, `web-reconnect`, `web-auto-reply`, `web-inbound`.
|
||
|
||
## Deep diagnostics
|
||
|
||
- Creds on disk: `ls -l ~/.openclaw/credentials/whatsapp/<accountId>/creds.json` (mtime should be recent).
|
||
- Session store: `ls -l ~/.openclaw/agents/<agentId>/sessions/sessions.json` (path can be overridden in config). Count and recent recipients are surfaced via `status`.
|
||
- Relink flow: `openclaw channels logout && openclaw channels login --verbose` when status codes 409–515 or `loggedOut` appear in logs. (Note: the QR login flow auto-restarts once for status 515 after pairing.)
|
||
|
||
## Health monitor config
|
||
|
||
- `gateway.channelHealthCheckMinutes`: how often the gateway checks channel health. Default: `5`. Set `0` to disable health-monitor restarts globally.
|
||
- `gateway.channelStaleEventThresholdMinutes`: how long a connected channel can stay idle before the health monitor treats it as stale and restarts it. Default: `30`. Keep this greater than or equal to `gateway.channelHealthCheckMinutes`.
|
||
- `gateway.channelMaxRestartsPerHour`: rolling one-hour cap for health-monitor restarts per channel/account. Default: `10`.
|
||
- `channels.<provider>.healthMonitor.enabled`: disable health-monitor restarts for a specific channel while leaving global monitoring enabled.
|
||
- `channels.<provider>.accounts.<accountId>.healthMonitor.enabled`: multi-account override that wins over the channel-level setting.
|
||
- These per-channel overrides apply to the built-in channel monitors that expose them today: Discord, Google Chat, iMessage, Microsoft Teams, Signal, Slack, Telegram, and WhatsApp.
|
||
|
||
## When something fails
|
||
|
||
- `logged out` or status 409–515 → relink with `openclaw channels logout` then `openclaw channels login`.
|
||
- Gateway unreachable → start it: `openclaw gateway --port 18789` (use `--force` if the port is busy).
|
||
- No inbound messages → confirm linked phone is online and the sender is allowed (`channels.whatsapp.allowFrom`); for group chats, ensure allowlist + mention rules match (`channels.whatsapp.groups`, `agents.list[].groupChat.mentionPatterns`).
|
||
|
||
## Dedicated "health" command
|
||
|
||
`openclaw health --json` asks the running Gateway for its health snapshot (no direct channel sockets from the CLI). It reports linked creds/auth age when available, per-channel probe summaries, session-store summary, and a probe duration. It exits non-zero if the Gateway is unreachable or the probe fails/timeouts.
|
||
|
||
Options:
|
||
|
||
- `--json`: machine-readable JSON output
|
||
- `--timeout <ms>`: override the default 10s probe timeout
|
||
- `--probe`: force a live probe of all channels instead of returning the cached health snapshot
|
||
|
||
The health snapshot includes: `ok` (boolean), `ts` (timestamp), `durationMs` (probe time), per-channel status, agent availability, and session-store summary.
|