日志

面向用户的概览(CLI + Control UI + 配置)见 /logging

OpenClaw 有两个日志”输出面”:

  • 控制台输出(你在终端/Debug UI 里看到的)。
  • 文件日志(JSON 行格式),由 Gateway 日志器写入。

文件日志器

  • 默认滚动日志文件位于 /tmp/openclaw/ 下(每天一个文件):openclaw-YYYY-MM-DD.log
    • 日期使用 Gateway 主机的本地时区。
  • 日志文件路径和级别可通过 ~/.openclaw/openclaw.json 配置:
    • logging.file
    • logging.level

文件格式为每行一个 JSON 对象。

Control UI 的 Logs 标签通过 Gateway(logs.tail)尾读此文件。 CLI 同样可以:

openclaw logs --follow

Verbose 与日志级别

  • 文件日志完全由 logging.level 控制。
  • --verbose 只影响控制台详细度(和 WS 日志样式);它不会提高文件日志级别。
  • 要在文件日志中捕获 verbose 级别的信息,把 logging.level 设为 debugtrace

控制台捕获

CLI 捕获 console.log/info/warn/error/debug/trace 并写入文件日志,同时仍然输出到 stdout/stderr。

你可以独立调节控制台详细度:

  • logging.consoleLevel(默认 info
  • logging.consoleStylepretty | compact | json

工具摘要脱敏

详细的工具摘要(如 🛠️ Exec: ...)可以在输出到控制台流之前掩盖敏感 token。这仅针对工具,不影响文件日志。

  • logging.redactSensitiveoff | tools(默认:tools
  • logging.redactPatterns:正则字符串数组(覆盖默认值)
    • 使用原始正则字符串(自动 gi),或 /pattern/flags 自定义标志。
    • 匹配项通过保留前 6 + 后 4 个字符来掩盖(长度 >= 18),否则用 ***
    • 默认值覆盖常见的键赋值、CLI 标志、JSON 字段、bearer 头、PEM 块和流行的 token 前缀。

Gateway WebSocket 日志

Gateway 以两种模式打印 WebSocket 协议日志:

  • 普通模式(无 --verbose:只打印”值得关注的” RPC 结果:
    • 错误(ok=false
    • 慢调用(默认阈值:>= 50ms
    • 解析错误
  • Verbose 模式(--verbose:打印所有 WS 请求/响应流量。

WS 日志样式

openclaw gateway 支持每个 Gateway 的样式开关:

  • --ws-log auto(默认):普通模式做优化;verbose 模式用紧凑输出
  • --ws-log compact:verbose 时用紧凑输出(配对的请求/响应)
  • --ws-log full:verbose 时用完整的每帧输出
  • --compact--ws-log compact 的别名

示例:

# 优化模式(仅错误/慢调用)
openclaw gateway

# 显示所有 WS 流量(配对格式)
openclaw gateway --verbose --ws-log compact

# 显示所有 WS 流量(完整元数据)
openclaw gateway --verbose --ws-log full

控制台格式化(子系统日志)

控制台格式化器感知 TTY,输出一致的、带前缀的行。 子系统日志器让输出分组清晰、方便扫读。

行为:

  • 每行都有子系统前缀(如 [gateway][canvas][tailscale]
  • 子系统颜色(每个子系统固定颜色)加上级别颜色
  • TTY 或富终端环境下使用彩色输出TERM/COLORTERM/TERM_PROGRAM),尊重 NO_COLOR
  • 缩短的子系统前缀:去掉开头的 gateway/ + channels/,保留最后两段(如 whatsapp/outbound
  • 按子系统的子日志器(自动前缀 + 结构化字段 { subsystem }
  • logRaw() 用于 QR/UX 输出(无前缀、无格式化)
  • 控制台样式(如 pretty | compact | json
  • 控制台日志级别与文件日志级别分离(logging.level 设为 debug/trace 时文件保留完整细节)
  • WhatsApp 消息体debug 级别记录(用 --verbose 查看)

这样既保持了文件日志的稳定性,又让交互式输出清晰可扫读。