Vendor OpenClaw source as Adolf fork baseline
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
This commit is contained in:
207
docs/diagnostics/flags.md
Normal file
207
docs/diagnostics/flags.md
Normal file
@@ -0,0 +1,207 @@
|
||||
---
|
||||
summary: "Diagnostics flags for targeted debug logs"
|
||||
read_when:
|
||||
- You need targeted debug logs without raising global logging levels
|
||||
- You need to capture subsystem-specific logs for support
|
||||
title: "Diagnostics flags"
|
||||
---
|
||||
|
||||
Diagnostics flags turn on extra logging for one subsystem without raising
|
||||
`logging.level` globally. A flag has no effect unless a subsystem checks it.
|
||||
|
||||
## How it works
|
||||
|
||||
- Flags are case-insensitive strings, resolved from `diagnostics.flags` in
|
||||
config plus the `OPENCLAW_DIAGNOSTICS` env override, deduped and lowercased.
|
||||
- `name.*` matches `name` itself and anything under `name.` (for example
|
||||
`telegram.*` matches `telegram.http`).
|
||||
- `*` or `all` enables every flag.
|
||||
- Restart the gateway after changing `diagnostics.flags` in config; it is not
|
||||
hot-reloaded.
|
||||
|
||||
## Known flags
|
||||
|
||||
| Flag | Enables |
|
||||
| ---------------- | --------------------------------------------------------- |
|
||||
| `telegram.http` | Telegram Bot API HTTP error logging |
|
||||
| `brave.http` | Brave Search request/response/cache logging |
|
||||
| `profiler` | Reply-stage profiler and Codex app-server profiler (both) |
|
||||
| `reply.profiler` | Reply-stage profiler only |
|
||||
| `codex.profiler` | Codex app-server profiler only |
|
||||
| `timeline` | Structured JSONL timeline artifact (see below) |
|
||||
|
||||
## Enable via config
|
||||
|
||||
```json
|
||||
{
|
||||
"diagnostics": {
|
||||
"flags": ["telegram.http"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Multiple flags:
|
||||
|
||||
```json
|
||||
{
|
||||
"diagnostics": {
|
||||
"flags": ["telegram.http", "brave.http", "gateway.*"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Env override (one-off)
|
||||
|
||||
```bash
|
||||
OPENCLAW_DIAGNOSTICS=telegram.http,brave.http
|
||||
```
|
||||
|
||||
Values split on commas or whitespace. Special values:
|
||||
|
||||
| Value | Effect |
|
||||
| --------------------------- | ---------------------------------------- |
|
||||
| `0`, `false`, `off`, `none` | Disable all flags, overriding config too |
|
||||
| `1`, `true`, `all`, `*` | Enable every flag |
|
||||
|
||||
`OPENCLAW_DIAGNOSTICS=0` disables flags from both env and config for that
|
||||
process, useful for temporarily silencing a profiler flag left on in config
|
||||
without editing the file.
|
||||
|
||||
## Profiler flags
|
||||
|
||||
Profiler flags gate lightweight timing spans; they add no overhead when off.
|
||||
|
||||
Enable all profiler-gated spans for one gateway run:
|
||||
|
||||
```bash
|
||||
OPENCLAW_DIAGNOSTICS=profiler openclaw gateway run
|
||||
```
|
||||
|
||||
Enable only reply-dispatch profiler spans:
|
||||
|
||||
```bash
|
||||
OPENCLAW_DIAGNOSTICS=reply.profiler openclaw gateway run
|
||||
```
|
||||
|
||||
Enable only Codex app-server startup/tool/thread profiler spans:
|
||||
|
||||
```bash
|
||||
OPENCLAW_DIAGNOSTICS=codex.profiler openclaw gateway run
|
||||
```
|
||||
|
||||
`profiler` enables both the reply profiler and the Codex profiler; use the
|
||||
scoped flag names to enable just one.
|
||||
|
||||
Or set it in config:
|
||||
|
||||
```json
|
||||
{
|
||||
"diagnostics": {
|
||||
"flags": ["reply.profiler", "codex.profiler"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Restart the gateway after changing config flags. To disable a profiler flag,
|
||||
remove it from `diagnostics.flags` and restart, or start the process with
|
||||
`OPENCLAW_DIAGNOSTICS=0` to override every diagnostics flag for that run.
|
||||
|
||||
## Timeline artifacts
|
||||
|
||||
The `timeline` flag (alias: `diagnostics.timeline`) writes structured startup
|
||||
and runtime timing events as JSONL, for external QA harnesses:
|
||||
|
||||
```bash
|
||||
OPENCLAW_DIAGNOSTICS=timeline \
|
||||
OPENCLAW_DIAGNOSTICS_TIMELINE_PATH=/tmp/openclaw-timeline.jsonl \
|
||||
openclaw gateway run
|
||||
```
|
||||
|
||||
Or enable it in config:
|
||||
|
||||
```json
|
||||
{
|
||||
"diagnostics": {
|
||||
"flags": ["timeline"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The output path always comes from `OPENCLAW_DIAGNOSTICS_TIMELINE_PATH`, even
|
||||
when the flag itself is set in config; there is no config key for the path.
|
||||
When `timeline` is enabled only from config, the earliest config-loading spans
|
||||
are missing because OpenClaw has not read config yet; subsequent startup spans
|
||||
are captured normally.
|
||||
|
||||
`OPENCLAW_DIAGNOSTICS=1`, `=all`, and `=*` also enable the timeline, since they
|
||||
enable every flag. Prefer the scoped `timeline` flag when you only want the
|
||||
JSONL artifact and not every other diagnostics flag.
|
||||
|
||||
Event-loop delay samples in the timeline need one more opt-in beyond
|
||||
`timeline`: set `OPENCLAW_DIAGNOSTICS_EVENT_LOOP=1` (or `on`/`true`/`yes`) on
|
||||
top of enabling the timeline.
|
||||
|
||||
Timeline records use the `openclaw.diagnostics.v1` envelope and can include
|
||||
process ids, phase names, span names, durations, plugin ids, dependency
|
||||
counts, event-loop delay samples, provider operation names, child-process exit
|
||||
state, and startup error names/messages. Treat timeline files as local
|
||||
diagnostics artifacts; review before sharing them outside your machine.
|
||||
|
||||
## Where logs go
|
||||
|
||||
Flags emit logs into the standard diagnostics log file. By default:
|
||||
|
||||
```
|
||||
/tmp/openclaw/openclaw-YYYY-MM-DD.log
|
||||
```
|
||||
|
||||
If you set `logging.file`, use that path instead. Logs are JSONL (one JSON
|
||||
object per line). Redaction still applies based on `logging.redactSensitive`.
|
||||
See [Logging](/logging) for the full log-path resolution, rotation, and
|
||||
redaction model.
|
||||
|
||||
## Extract logs
|
||||
|
||||
Pick the latest log file:
|
||||
|
||||
```bash
|
||||
ls -t /tmp/openclaw/openclaw-*.log | head -n 1
|
||||
```
|
||||
|
||||
Filter for Telegram HTTP diagnostics:
|
||||
|
||||
```bash
|
||||
rg "telegram http error" /tmp/openclaw/openclaw-*.log
|
||||
```
|
||||
|
||||
Filter for Brave Search HTTP diagnostics:
|
||||
|
||||
```bash
|
||||
rg "brave http" /tmp/openclaw/openclaw-*.log
|
||||
```
|
||||
|
||||
Or tail while reproducing:
|
||||
|
||||
```bash
|
||||
tail -f /tmp/openclaw/openclaw-$(date +%F).log | rg "telegram http error"
|
||||
```
|
||||
|
||||
For remote gateways, use `openclaw logs --follow` instead (see
|
||||
[/cli/logs](/cli/logs)).
|
||||
|
||||
## Notes
|
||||
|
||||
- If `logging.level` is set higher than `warn`, flag-gated logs may be
|
||||
suppressed. Default `info` is fine.
|
||||
- `brave.http` logs Brave Search request URLs/query params, response
|
||||
status/timing, and cache hit/miss/write events. It does not log the API key
|
||||
(sent as a request header) or response bodies, but search queries can be
|
||||
sensitive.
|
||||
- Flags are safe to leave enabled; they only affect log volume for the
|
||||
specific subsystem.
|
||||
- Use [/logging](/logging) to change log destinations, levels, and redaction.
|
||||
|
||||
## Related
|
||||
|
||||
- [Gateway diagnostics](/gateway/diagnostics)
|
||||
- [Gateway troubleshooting](/gateway/troubleshooting)
|
||||
Reference in New Issue
Block a user