环境与调试

诊断标志

诊断标志可为某个子系统启用额外日志,而不会全局提高 logging.level。除非子系统检查某个标志,否则该标志不会生效。

工作原理

  • 标志是不区分大小写的字符串,由配置中的 diagnostics.flags 加上 OPENCLAW_DIAGNOSTICS 环境变量覆盖值解析而来,随后进行去重并转换为小写。
  • name.* 匹配 name 本身及 name. 下的所有内容(例如, telegram.* 匹配 telegram.http)。
  • *all 会启用所有标志。
  • 在配置中更改 diagnostics.flags 后,请重启 Gateway 网关;该配置 不支持热重载。

已知标志

标志 启用的功能
telegram.http Telegram Bot API HTTP 错误日志
brave.http Brave Search 请求/响应/缓存日志
profiler 回复阶段分析器和 Codex app-server 分析器(两者)
reply.profiler 仅回复阶段分析器
codex.profiler 仅 Codex app-server 分析器
health Gateway 健康探测/账户/绑定调试详情
ingress.timing 会话加载、模型选择和模型目录计时
plugin.load-profile 同步插件模块加载计时
timeline 结构化 JSONL 时间线工件(见下文)

通过配置启用

json
{  "diagnostics": {    "flags": ["telegram.http"]  }}

多个标志:

json
{  "diagnostics": {    "flags": ["telegram.http", "brave.http", "gateway.*"]  }}

环境变量覆盖(单次)

bash
OPENCLAW_DIAGNOSTICS=telegram.http,brave.http

值按逗号或空白字符分隔。特殊值:

效果
0, false, off, none 禁用所有标志,同时覆盖配置
1, true, all, * 启用所有标志

OPENCLAW_DIAGNOSTICS=0 会为该进程同时禁用环境变量和配置中的标志, 便于在不编辑文件的情况下,临时静默配置中仍处于启用状态的分析器标志。

分析器标志

分析器标志控制轻量级计时区间;关闭时不会增加任何开销。

为一次 Gateway 网关运行启用所有受分析器标志控制的区间:

bash
OPENCLAW_DIAGNOSTICS=profiler openclaw gateway run

仅启用回复分发分析器区间:

bash
OPENCLAW_DIAGNOSTICS=reply.profiler openclaw gateway run

仅启用 Codex app-server 启动/工具/线程分析器区间:

bash
OPENCLAW_DIAGNOSTICS=codex.profiler openclaw gateway run

profiler 会同时启用回复分析器和 Codex 分析器;若只需启用其中一个, 请使用限定作用域的标志名称。

也可以在配置中进行设置:

json
{  "diagnostics": {    "flags": ["reply.profiler", "codex.profiler"]  }}

更改配置标志后,请重启 Gateway 网关。要禁用分析器标志, 请将其从 diagnostics.flags 中移除并重启,或者使用 OPENCLAW_DIAGNOSTICS=0 启动进程,以覆盖该次运行的所有诊断标志。

时间线工件

timeline 标志(别名:diagnostics.timeline)会将结构化的启动 和运行时计时事件写入 JSONL,供外部 QA 测试框架使用:

bash
OPENCLAW_DIAGNOSTICS=timeline \OPENCLAW_DIAGNOSTICS_TIMELINE_PATH=/tmp/openclaw-timeline.jsonl \openclaw gateway run

也可以在配置中启用:

json
{  "diagnostics": {    "flags": ["timeline"]  }}

输出路径始终来自 OPENCLAW_DIAGNOSTICS_TIMELINE_PATH, 即使标志本身是在配置中设置的也是如此;该路径没有对应的配置键。 当 timeline 仅通过配置启用时,由于 OpenClaw 尚未读取配置, 最早的配置加载区间会缺失;后续启动区间仍会正常捕获。

OPENCLAW_DIAGNOSTICS=1=all=* 也会启用时间线,因为它们 会启用所有标志。如果只需要 JSONL 工件,而不需要其他所有诊断标志, 请优先使用限定作用域的 timeline 标志。

时间线中的事件循环延迟样本除了需要启用 timeline 外,还需额外选择启用:在启用时间线的基础上,设置 OPENCLAW_DIAGNOSTICS_EVENT_LOOP=1(或 on/true/yes)。

时间线记录使用 openclaw.diagnostics.v1 信封结构,并且可能包含 进程 ID、阶段名称、区间名称、持续时间、插件 ID、依赖项 数量、事件循环延迟样本、提供商操作名称、子进程退出 状态,以及启动错误名称/消息。请将时间线文件视为本地 诊断工件;在将其分享至你的机器之外前,请先进行审查。

日志存放位置

标志会将日志发送到标准诊断日志文件。默认路径为:

Code
/tmp/openclaw/openclaw-YYYY-MM-DD.log

命名配置文件使用 /tmp/openclaw/openclaw-<profile>-YYYY-MM-DD.log;例如, --dev 使用 openclaw-dev-YYYY-MM-DD.log

如果设置了 logging.file,请改用该路径。日志采用 JSONL 格式(每行一个 JSON 对象)。仍会根据 logging.redactSensitive 应用脱敏。 有关完整的日志路径解析、轮转和脱敏模型,请参阅日志

提取日志

读取当前配置文件的最新日志文件:

bash
openclaw logs --plain# 命名配置文件示例:openclaw --profile work logs --plain

筛选 Telegram HTTP 诊断信息:

bash
openclaw logs --plain --limit 5000 | rg "telegram http error"

筛选 Brave Search HTTP 诊断信息:

bash
openclaw logs --plain --limit 5000 | rg "brave http"

或者在复现问题时持续跟踪:

bash
openclaw logs --follow --plain | rg "telegram http error"

对于远程 Gateway 网关,请改用 openclaw logs --follow(参阅 /cli/logs)。

注意事项

  • 如果 logging.level 设置得高于 warn,受标志控制的日志可能会 被抑制。默认的 info 即可。
  • brave.http 会记录 Brave Search 请求 URL/查询参数、响应 状态/计时以及缓存命中/未命中/写入事件。它不会记录 API 密钥 (该密钥通过请求标头发送)或响应正文,但搜索查询可能包含 敏感信息。
  • 标志可以安全地保持启用;它们只会影响 特定子系统的日志量。
  • 使用/日志更改日志目标位置、级别和脱敏设置。

相关内容

Was this useful?
On this page

On this page