Gateway: optimize ws logs in normal mode
This commit is contained in:
55
docs/logging.md
Normal file
55
docs/logging.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Logging
|
||||
|
||||
Clawdis has two log “surfaces”:
|
||||
|
||||
- **Console output** (what you see in the terminal / Debug UI).
|
||||
- **File logs** (JSON lines) written by the internal logger.
|
||||
|
||||
## File-based logger
|
||||
|
||||
Clawdis uses a file logger backed by `tslog` (`src/logging.ts`).
|
||||
|
||||
- Default rolling log file is under `/tmp/clawdis/` (one file per day): `clawdis-YYYY-MM-DD.log`
|
||||
- The log file path and level can be configured via `~/.clawdis/clawdis.json`:
|
||||
- `logging.file`
|
||||
- `logging.level`
|
||||
|
||||
The file format is one JSON object per line.
|
||||
|
||||
## Console capture
|
||||
|
||||
The CLI entrypoint enables console capture (`src/index.ts` calls `enableConsoleCapture()`).
|
||||
That means every `console.log/info/warn/error/debug/trace` is also written into the file logs,
|
||||
while still behaving normally on stdout/stderr.
|
||||
|
||||
## Gateway WebSocket logs
|
||||
|
||||
The gateway prints WebSocket protocol logs in two modes:
|
||||
|
||||
- **Normal mode (no `--verbose`)**: only “interesting” RPC results are printed:
|
||||
- errors (`ok=false`)
|
||||
- slow calls (default threshold: `>= 50ms`)
|
||||
- parse errors
|
||||
- **Verbose mode (`--verbose`)**: prints all WS request/response traffic.
|
||||
|
||||
### WS log style
|
||||
|
||||
`clawdis gateway` supports a per-gateway style switch:
|
||||
|
||||
- `--ws-log auto` (default): normal mode is optimized; verbose mode uses compact output
|
||||
- `--ws-log compact`: compact output (paired request/response) when verbose
|
||||
- `--ws-log full`: full per-frame output when verbose
|
||||
- `--compact`: alias for `--ws-log compact`
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
# optimized (only errors/slow)
|
||||
clawdis gateway
|
||||
|
||||
# show all WS traffic (paired)
|
||||
clawdis gateway --verbose --ws-log compact
|
||||
|
||||
# show all WS traffic (full meta)
|
||||
clawdis gateway --verbose --ws-log full
|
||||
```
|
||||
Reference in New Issue
Block a user