ewilliams28/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-08-21 01:51:39 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
6205cf3bb3d6156c228aea9ff74a2e85cb6ea00a
openclaw/docs/cli/health.md
T
Peter Steinberger ad6bc6d3ae fix(delivery): keep failed queue rows payload-free (#123642) 
* refactor(delivery): collapse failed-row lifecycle

Replace the unshipped failure-operations platform with payload-free terminal receipts owned by existing queue boundaries. Keep bounded/permanent idempotency only for reusable or crash-ambiguous producers, move physical expiry to queue maintenance, and preserve migration and media-cleanup safety.\n\nTogether with #123410, production code is net negative by 11 lines; tests, docs, and generated protocol mirrors are accounted separately.

* fix(delivery): break state DB import cycle

* fix(delivery): classify SQLite boundary uses

* test(gateway): mark retained health fixture
2026-08-14 06:22:51 -07:00

2.7 KiB
Raw Blame History

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, or inbound channel events, are dead-lettered, text output reports their counts and oldest failure age. 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

Reference in New Issue View Git Blame Copy Permalink