openclaw/docs/cli/health.md

summary, read_when, title

summary	read_when	title
CLI reference for `openclaw health` (gateway health snapshot via RPC)	You want to quickly check the running Gateway's health	Health

openclaw health

Fetch a health snapshot from the running Gateway over WebSocket RPC (no direct channel sockets from the CLI).

Options

Flag	Default	Description
--json	false	Print machine-readable JSON instead of text.
--timeout <ms>	10000	Connection timeout in milliseconds.
--verbose	false	Forces a live probe and expands output across all configured accounts and agents.
--debug	false	Alias for --verbose.

Examples:

openclaw health
openclaw health --json
openclaw health --timeout 2500
openclaw health --verbose
openclaw health --debug

Behavior

• Without --verbose, the Gateway can return a cached snapshot (fresh for up to 60 seconds and unchanged from live channel runtime state) and refresh it in the background for the next caller.
• --verbose forces a live probe (per-channel account probes), prints Gateway connection details, and expands human-readable output across all configured accounts and agents instead of just the default agent.
• --json always returns the full snapshot: channels, per-account probes, plugin load state, context-engine quarantine state, model-pricing cache state, event-loop health, delivery-queue warnings, and per-agent session stores.
• Top-level ok: true means the health RPC succeeded and the Gateway produced a snapshot. Queue warnings do not change it to false.
• When outbound or session deliveries are dead-lettered, text output reports classification counts, the oldest payload-bearing failure, and retention-maintenance errors without exposing content. The owner-cleanup-pending count includes both provider cleanup still owed and exact media removal awaiting retry. Inspect failures with openclaw delivery failures list. Inbound counts are grouped by channel account; inspect or recover individual events with openclaw channels dead-letters.
• Optional deliveryQueues.ingressPressure summarizes durable inbound lanes that may be blocking later events. It is grouped by channel account and never exposes event, lane, payload, error, owner, token, session, or target identifiers. See Gateway health for the exact qualification and counting semantics.

Related

• CLI reference
• openclaw status — local diagnosis and channel probes without a full health snapshot
• Gateway health