--- summary: "Create shareable Gateway diagnostics bundles for bug reports" title: "Diagnostics export" read_when: - Preparing a bug report or support request - Debugging Gateway crashes, restarts, memory pressure, or oversized payloads - Reviewing what diagnostics data is recorded or redacted --- OpenClaw can build a local diagnostics `.zip` for bug reports: sanitized Gateway status, health, logs, config shape, and recent payload-free stability events. Treat diagnostics bundles like secrets until reviewed. Payloads and credentials are redacted by design, but the bundle still summarizes local Gateway logs and host-level runtime state. ## Quick start ```bash openclaw gateway diagnostics export ``` Prints the written zip path. Choose an output path: ```bash openclaw gateway diagnostics export --output openclaw-diagnostics.zip ``` For automation: ```bash openclaw gateway diagnostics export --json ``` ## Chat command Owners can run `/diagnostics [note]` in any conversation to request a local Gateway export as one copy-pasteable support report: 1. Send `/diagnostics`, optionally with a short note (`/diagnostics bad tool choice`). 2. OpenClaw sends a preamble and asks for one explicit exec approval, which runs `openclaw gateway diagnostics export --json`. Do not approve diagnostics via an allow-all rule. 3. After approval, OpenClaw replies with the local bundle path, manifest summary, privacy notes, and relevant session ids. In group chats, an owner can still run `/diagnostics`, but OpenClaw sends the export result, approval prompts, and Codex session/thread breakdown to the owner privately. The group sees only a short status notice: approval pending, private delivery confirmed, delivery pending, or delivery suppressed. Pending delivery does not trigger another private send. If no private owner route exists, the command asks the owner to run it from a DM. When the active session uses the native OpenAI Codex harness, the same exec approval also covers an OpenAI feedback upload for the Codex threads OpenClaw knows about. That upload is separate from the local Gateway zip and only happens for Codex harness sessions. The approval prompt states that approving also sends Codex feedback, without listing Codex session or thread ids. After approval, the reply lists channels, OpenClaw session ids, Codex thread ids, and local resume commands for the threads that were sent to OpenAI. Denying or ignoring the approval skips the export, the Codex feedback upload, and the Codex id list. That makes the Codex debugging loop short: notice bad behavior in a channel, run `/diagnostics`, approve once, share the report, then run the printed `codex resume ` command locally if you want to inspect the thread yourself. See [Codex harness](/plugins/codex-harness/commands#inspect-codex-threads-locally). ## What the export contains - `summary.md`: human-readable overview for support. - `diagnostics.json`: machine-readable summary of config, logs, status, health, and stability data. - `manifest.json`: export metadata and file list. - Sanitized config shape and non-secret config details. - Sanitized log summaries and recent redacted log lines. - Best-effort Gateway status and health snapshots. - `stability/latest.json`: newest persisted stability bundle, when available. The export is still useful when the Gateway is unhealthy: if status/health requests fail, local logs, config shape, and the latest stability bundle are still collected when available. ## Privacy model Kept: subsystem names, plugin ids, provider ids, channel ids, configured modes, status codes, durations, byte counts, queue state, memory readings, sanitized log metadata, redacted operational messages, config shape, and non-secret feature settings. Omitted or redacted: chat text, prompts, instructions, webhook bodies, tool outputs, credentials, API keys, tokens, cookies, secret values, raw request/response bodies, account ids, message ids, raw session ids, hostnames, and local usernames. When a log message looks like user, chat, prompt, or tool payload text, the export keeps only that a message was omitted plus its byte count. ## WebSocket disconnect logs Connected webchat and authenticated-user disconnects include `durationMs` (connection lifetime in milliseconds) in default info-level file logs. The `cause` field contains the Gateway's recorded close cause, when known; otherwise it is omitted. `heartbeat-timeout` records the Gateway's missed-pong decision. It does not prove that a ping reached the remote peer or that the peer caused the transport failure. Heartbeat-timeout records also capture these facts before termination: - `pingWriteState`: `pending` when no write callback has been observed, `completed` after local write completion, or `failed` after a write error. Pending does not prove the ping was unsent; completed does not prove peer receipt. - `lastPongAgeMs`: monotonic elapsed milliseconds since the last observed pong, omitted when no pong has been observed. - `bufferedBytes`: aggregate local WebSocket buffering at the timeout decision, not the delivery status of an individual ping. ## Stability recorder The Gateway records a bounded, payload-free stability stream by default when diagnostics are enabled. It captures operational facts, not content. The same heartbeat also samples liveness when the event loop or CPU looks saturated, emitting `diagnostic.liveness.warning` events with event-loop delay, event-loop utilization, CPU-core ratio, active/waiting/queued session counts, the current startup/runtime phase (when known), recent phase spans, and bounded work labels. These become Gateway `warn`-level log lines when work is waiting or queued, when active work overlaps sustained event-loop delay, or when the Gateway reports at least 60 seconds of persistent degradation; otherwise they log at `debug`. Persistent Gateway degradation can warn even when no tracked work is active. Other idle liveness samples remain diagnostic events without escalating to a warning. Startup phases emit `diagnostic.phase.completed` events with wall-clock and whole-process CPU timing, including worker and native threads. Phase CPU can include concurrent work outside that phase; it is not exclusive attribution. The `cpuCoreRatio` in phase and liveness events is measured in core equivalents and can exceed `1`. See [CPU pressure and event-loop delay](/gateway/health#cpu-pressure-and-event-loop-delay). With diagnostics enabled, `sessions.patch` and `sessions.patchMany` calls lasting at least one second add an info-level `slow session patch` file-log record. Its `elapsedMs`, `phaseDurationsMs`, and `phaseCounts` distinguish lifecycle admission, snapshot reads, catalog preparation, projection, commit, runtime acknowledgements, effects, and response work. Records inherit the request's diagnostic trace when available and contain fixed phase names and numbers, not patch values or session keys. Repeated stage visits contribute to the counts and totals. Parallel and nested stages can overlap, so their totals are neither an exclusive breakdown of request time nor CPU measurements. Two related info-level records help attribute slow worktree cleanup: `slow managed worktree removal` separates allocation admission, callback work, and final settlement; `slow Git ref mutation` separates directory resolution, queue waiting, and queued work. Both require diagnostics and info-level logging, emit only after an operation lasting at least one second settles, and have separate fixed budgets of 60 records per minute per runtime isolate with `omittedObservations` counts. They retain fixed scalar fields and existing traces, without adding private paths or new identities. Their elapsed intervals can nest inside `worktreeCleanup` and include asynchronous waits; they are not CPU or individual child-command timings. See [Slow worktree cleanup](/logging#slow-worktree-cleanup) for fields and missing-record limits. SQLite session-write warnings also separate `queueWaitMs`, `writerExecutionMs`, and `completionDelayMs`. These measure time until the writer starts, work and awaits inside the writer lane, and time until its caller resumes after execution. Writer execution is not SQLite transaction-lock hold time; native transaction lock-wait and hold warnings remain separate. Writes rejected before entering the writer omit these three fields. This breakdown is in file logs, not the aggregate Gateway RPC Prometheus histograms. These warnings include the writer's `pid`, Node `threadId`, and `isMainThread`. Reclamation callbacks also record their `reclamationKind` and, when a Worker was created, its captured `workerThreadId`. Within the same process lifetime, match the warning's `pid` and `workerThreadId` to an agent-database-open warning's `pid` and `threadId` to identify the awaited Worker. This establishes association, not CPU attribution or a breakdown of the Worker's lifetime. A missing Worker ID does not establish that work ran on the main thread. Stalled embedded-run diagnostics mark `terminalProgressStale=true` when the last bridge progress looked terminal (for example a raw response item or response-completion event) but the Gateway still considers the embedded run active. Inspect the live recorder: ```bash openclaw gateway stability openclaw gateway stability --type payload.large openclaw gateway stability --json ``` Inspect the newest persisted bundle after a fatal exit, shutdown timeout, or restart startup failure: ```bash openclaw gateway stability --bundle latest ``` Create a diagnostics zip from the newest persisted bundle: ```bash openclaw gateway stability --bundle latest --export ``` Persisted bundles live under `~/.openclaw/logs/stability/` when events exist. ## Useful options ```bash openclaw gateway diagnostics export \ --output openclaw-diagnostics.zip \ --log-lines 5000 \ --log-bytes 1000000 ``` | Flag | Default | Description | | ----------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------- | | `--output ` | `$OPENCLAW_STATE_DIR/logs/support/openclaw-diagnostics--.zip` | Write to a specific zip path (or directory). | | `--log-lines ` | `5000` | Maximum sanitized log lines to include. | | `--log-bytes ` | `1000000` | Maximum log bytes to inspect. | | `--url ` | - | Gateway WebSocket URL for status/health snapshots. | | `--token ` | - | Gateway token for status/health snapshots. | | `--password ` | - | Gateway password for status/health snapshots. | | `--timeout ` | `3000` | Status/health snapshot timeout. | | `--no-stability-bundle` | off | Skip persisted stability bundle lookup. | | `--json` | off | Print machine-readable export metadata. | ## Disable diagnostics Diagnostics are enabled by default. To disable the stability recorder and diagnostic event collection: ```json5 { diagnostics: { enabled: false, }, } ``` Disabling diagnostics reduces bug-report detail; it does not affect normal Gateway logging. Memory pressure events record RSS, heap, threshold, and growth facts (`rss_threshold`, `heap_threshold`, `rss_growth`) without performing a file-system scan or writing a pre-OOM snapshot. ## Related - [Health checks](/gateway/health) - [Gateway CLI](/cli/gateway#gateway-diagnostics-export) - [Gateway protocol](/gateway/protocol/rpc-methods#rpc-method-families) - [Logging](/logging) - [OpenTelemetry export](/gateway/opentelemetry) - separate flow for streaming diagnostics to a collector - [Codex harness runtime](/plugins/codex-harness-runtime) - runtime boundaries, permissions, and diagnostics for the Codex harness - [Diagnostics flags](/diagnostics/flags) - the named flags that turn on extra logging for one subsystem without raising `logging.level` globally