@gguf/claw 2026.2.1 → 2026.2.3

package/docs/zh-CN/install/updating.md

@@ -0,0 +1,233 @@
+---
+read_when:
+  - 更新 OpenClaw
+  - 更新后出现问题
+summary: 安全更新 OpenClaw（全局安装或源码安装），以及回滚策略
+title: 更新
+x-i18n:
+  generated_at: "2026-02-01T21:16:51Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 612b2519cf3e4a2c2d0f01575c3fa75ab1c88a6fed9e59477bf27395beda03c1
+  source_path: install/updating.md
+  workflow: 15
+---
+
+# 更新
+
+OpenClaw 迭代速度很快（尚未到"1.0"）。请像对待基础设施发布一样对待更新：更新 → 运行检查 → 重启（或使用 `openclaw update`，它会自动重启）→ 验证。
+
+## 推荐方式：重新运行网站安装程序（原地升级）
+
+**首选**更新路径是重新运行网站上的安装程序。它会检测现有安装、原地升级，并在需要时运行 `openclaw doctor`。
+
+```bash
+curl -fsSL https://openclaw.ai/install.sh | bash
+```
+
+注意事项：
+
+- 如果不想再次运行新手引导向导，请添加 `--no-onboard`。
+- 对于**源码安装**，请使用：
+  ```bash
+  curl -fsSL https://openclaw.ai/install.sh | bash -s -- --install-method git --no-onboard
+  ```
+  安装程序**仅在**仓库工作区干净时才会执行 `git pull --rebase`。
+- 对于**全局安装**，脚本底层使用 `npm install -g openclaw@latest`。
+- 兼容性说明：`openclaw` 仍可作为兼容性垫片使用。
+
+## 更新前的准备
+
+- 了解你的安装方式：**全局安装**（npm/pnpm）还是**源码安装**（git clone）。
+- 了解你的 Gateway网关运行方式：**前台终端**还是**受监控服务**（launchd/systemd）。
+- 备份你的自定义配置：
+  - 配置文件：`~/.openclaw/openclaw.json`
+  - 凭据：`~/.openclaw/credentials/`
+  - 工作区：`~/.openclaw/workspace`
+
+## 更新（全局安装）
+
+全局安装（任选其一）：
+
+```bash
+npm i -g openclaw@latest
+```
+
+```bash
+pnpm add -g openclaw@latest
+```
+
+我们**不建议**使用 Bun 作为 Gateway网关运行时（存在 WhatsApp/Telegram 相关 bug）。
+
+切换更新渠道（git + npm 安装）：
+
+```bash
+openclaw update --channel beta
+openclaw update --channel dev
+openclaw update --channel stable
+```
+
+使用 `--tag <dist-tag|version>` 进行一次性指定标签/版本安装。
+
+有关渠道语义和发布说明，请参阅[开发渠道](/install/development-channels)。
+
+注意：在 npm 安装中，Gateway网关启动时会记录更新提示（检查当前渠道标签）。可通过 `update.checkOnStart: false` 禁用。
+
+然后：
+
+```bash
+openclaw doctor
+openclaw gateway restart
+openclaw health
+```
+
+注意事项：
+
+- 如果你的 Gateway网关作为服务运行，建议使用 `openclaw gateway restart` 而非直接终止 PID。
+- 如果你固定在特定版本，请参阅下方的"回滚/版本固定"。
+
+## 更新（`openclaw update`）
+
+对于**源码安装**（git checkout），推荐使用：
+
+```bash
+openclaw update
+```
+
+它会执行一个相对安全的更新流程：
+
+- 要求工作区干净。
+- 切换到所选渠道（标签或分支）。
+- 从配置的上游（dev 渠道）拉取并变基。
+- 安装依赖、构建、构建控制面板 UI，并运行 `openclaw doctor`。
+- 默认重启 Gateway网关（使用 `--no-restart` 跳过）。
+
+如果你通过 **npm/pnpm** 安装（无 git 元数据），`openclaw update` 会尝试通过你的包管理器进行更新。如果无法检测到安装方式，请改用"更新（全局安装）"。
+
+## 更新（控制面板 UI / RPC）
+
+控制面板 UI 提供**更新并重启**功能（RPC：`update.run`）。它会：
+
+1. 执行与 `openclaw update` 相同的源码更新流程（仅限 git checkout）。
+2. 写入重启哨兵文件及结构化报告（stdout/stderr 尾部内容）。
+3. 重启 Gateway网关并向最近活跃的会话发送报告。
+
+如果变基失败，Gateway网关会中止并在不应用更新的情况下重启。
+
+## 更新（源码安装）
+
+从仓库检出目录：
+
+推荐方式：
+
+```bash
+openclaw update
+```
+
+手动方式（大致等效）：
+
+```bash
+git pull
+pnpm install
+pnpm build
+pnpm ui:build # 首次运行时自动安装 UI 依赖
+openclaw doctor
+openclaw health
+```
+
+注意事项：
+
+- 当你运行打包后的 `openclaw` 二进制文件（[`openclaw.mjs`](https://github.com/openclaw/openclaw/blob/main/openclaw.mjs)）或使用 Node 运行 `dist/` 时，`pnpm build` 很重要。
+- 如果你从仓库检出运行而没有全局安装，请使用 `pnpm openclaw ...` 执行 CLI 命令。
+- 如果你直接从 TypeScript 运行（`pnpm openclaw ...`），通常不需要重新构建，但**配置迁移仍然适用** → 运行 doctor。
+- 在全局安装和 git 安装之间切换很容易：安装另一种方式，然后运行 `openclaw doctor`，这样 Gateway网关服务入口点会被重写为当前安装。
+
+## 必须执行：`openclaw doctor`
+
+Doctor 是"安全更新"命令。它有意设计得很朴素：修复 + 迁移 + 警告。
+
+注意：如果你使用的是**源码安装**（git checkout），`openclaw doctor` 会建议先运行 `openclaw update`。
+
+它通常执行以下操作：
+
+- 迁移已弃用的配置键 / 旧版配置文件位置。
+- 审核私信策略并对高风险的"开放"设置发出警告。
+- 检查 Gateway网关健康状态并可建议重启。
+- 检测并将旧版 Gateway网关服务（launchd/systemd；旧版 schtasks）迁移到当前的 OpenClaw 服务。
+- 在 Linux 上，确保 systemd 用户 lingering（使 Gateway网关在登出后继续运行）。
+
+详情：[Doctor](/gateway/doctor)
+
+## 启动/停止/重启 Gateway网关
+
+CLI（适用于所有操作系统）：
+
+```bash
+openclaw gateway status
+openclaw gateway stop
+openclaw gateway restart
+openclaw gateway --port 18789
+openclaw logs --follow
+```
+
+如果使用服务管理：
+
+- macOS launchd（应用捆绑的 LaunchAgent）：`launchctl kickstart -k gui/$UID/bot.molt.gateway`（使用 `bot.molt.<profile>`；旧版 `com.openclaw.*` 仍可用）
+- Linux systemd 用户服务：`systemctl --user restart openclaw-gateway[-<profile>].service`
+- Windows（WSL2）：`systemctl --user restart openclaw-gateway[-<profile>].service`
+  - `launchctl`/`systemctl` 仅在服务已安装时有效；否则请运行 `openclaw gateway install`。
+
+运维手册及完整服务标签：[Gateway网关运维手册](/gateway)
+
+## 回滚/版本固定（出现问题时）
+
+### 版本固定（全局安装）
+
+安装一个已知可用的版本（将 `<version>` 替换为上一个正常工作的版本）：
+
+```bash
+npm i -g openclaw@<version>
+```
+
+```bash
+pnpm add -g openclaw@<version>
+```
+
+提示：要查看当前已发布的版本，请运行 `npm view openclaw version`。
+
+然后重启并重新运行 doctor：
+
+```bash
+openclaw doctor
+openclaw gateway restart
+```
+
+### 版本固定（源码安装）按日期
+
+选取某个日期的提交（示例："main 分支截至 2026-01-01 的状态"）：
+
+```bash
+git fetch origin
+git checkout "$(git rev-list -n 1 --before=\"2026-01-01\" origin/main)"
+```
+
+然后重新安装依赖并重启：
+
+```bash
+pnpm install
+pnpm build
+openclaw gateway restart
+```
+
+如果之后想回到最新版本：
+
+```bash
+git checkout main
+git pull
+```
+
+## 如果你遇到困难
+
+- 再次运行 `openclaw doctor` 并仔细阅读输出（它通常会告诉你修复方法）。
+- 查看：[故障排除](/gateway/troubleshooting)
+- 在 Discord 中提问：https://discord.gg/clawd

package/docs/zh-CN/logging.md

@@ -0,0 +1,328 @@
+---
+read_when:
+  - 你需要一份面向初学者的日志概览
+  - 你想配置日志级别或格式
+  - 你正在故障排除，需要快速找到日志
+summary: 日志概览：文件日志、控制台输出、CLI 实时追踪和控制界面
+title: 日志
+x-i18n:
+  generated_at: "2026-02-01T21:17:08Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 884fcf4a906adff34d546908e22abd283cb89fe0845076cf925c72384ec3556b
+  source_path: logging.md
+  workflow: 15
+---
+
+# 日志
+
+OpenClaw 在两个地方记录日志：
+
+- **文件日志**（JSON 行格式），由 Gateway网关写入。
+- **控制台输出**，显示在终端和控制界面中。
+
+本页说明日志的存储位置、如何读取日志，以及如何配置日志级别和格式。
+
+## 日志存储位置
+
+默认情况下，Gateway网关会在以下路径写入滚动日志文件：
+
+`/tmp/openclaw/openclaw-YYYY-MM-DD.log`
+
+日期使用 Gateway网关主机的本地时区。
+
+你可以在 `~/.openclaw/openclaw.json` 中覆盖此设置：
+
+```json
+{
+  "logging": {
+    "file": "/path/to/openclaw.log"
+  }
+}
+```
+
+## 如何读取日志
+
+### CLI：实时追踪（推荐）
+
+使用 CLI 通过 RPC 追踪 Gateway网关日志文件：
+
+```bash
+openclaw logs --follow
+```
+
+输出模式：
+
+- **TTY 会话**：美观的、彩色的、结构化的日志行。
+- **非 TTY 会话**：纯文本。
+- `--json`：行分隔的 JSON（每行一个日志事件）。
+- `--plain`：在 TTY 会话中强制使用纯文本。
+- `--no-color`：禁用 ANSI 颜色。
+
+在 JSON 模式下，CLI 输出带 `type` 标签的对象：
+
+- `meta`：流元数据（文件、游标、大小）
+- `log`：解析后的日志条目
+- `notice`：截断/轮转提示
+- `raw`：未解析的日志行
+
+如果 Gateway网关不可达，CLI 会打印简短提示，建议运行：
+
+```bash
+openclaw doctor
+```
+
+### 控制界面（Web）
+
+控制界面的**日志**选项卡使用 `logs.tail` 追踪同一文件。
+请参阅 [/web/control-ui](/web/control-ui) 了解如何打开它。
+
+### 仅渠道日志
+
+要过滤渠道活动（WhatsApp/Telegram 等），请使用：
+
+```bash
+openclaw channels logs --channel whatsapp
+```
+
+## 日志格式
+
+### 文件日志（JSONL）
+
+日志文件中的每一行都是一个 JSON 对象。CLI 和控制界面会解析这些条目以呈现结构化输出（时间、级别、子系统、消息）。
+
+### 控制台输出
+
+控制台日志**感知 TTY**，并以可读性为目标进行格式化：
+
+- 子系统前缀（例如 `gateway/channels/whatsapp`）
+- 级别着色（info/warn/error）
+- 可选的紧凑模式或 JSON 模式
+
+控制台格式由 `logging.consoleStyle` 控制。
+
+## 配置日志
+
+所有日志配置位于 `~/.openclaw/openclaw.json` 的 `logging` 下。
+
+```json
+{
+  "logging": {
+    "level": "info",
+    "file": "/tmp/openclaw/openclaw-YYYY-MM-DD.log",
+    "consoleLevel": "info",
+    "consoleStyle": "pretty",
+    "redactSensitive": "tools",
+    "redactPatterns": ["sk-.*"]
+  }
+}
+```
+
+### 日志级别
+
+- `logging.level`：**文件日志**（JSONL）级别。
+- `logging.consoleLevel`：**控制台**详细程度级别。
+
+`--verbose` 仅影响控制台输出；不会更改文件日志级别。
+
+### 控制台样式
+
+`logging.consoleStyle`：
+
+- `pretty`：人类友好的、彩色的、带时间戳。
+- `compact`：更紧凑的输出（适合长时间会话）。
+- `json`：每行一个 JSON（用于日志处理器）。
+
+### 脱敏
+
+工具摘要可以在输出到控制台之前对敏感令牌进行脱敏处理：
+
+- `logging.redactSensitive`：`off` | `tools`（默认：`tools`）
+- `logging.redactPatterns`：正则表达式字符串列表，用于覆盖默认集合
+
+脱敏**仅影响控制台输出**，不会更改文件日志。
+
+## 诊断 + OpenTelemetry
+
+诊断是结构化的、机器可读的事件，用于模型运行**以及**消息流遥测（webhook、队列、会话状态）。它们**不会**替代日志；其存在是为了向指标、追踪和其他导出器提供数据。
+
+诊断事件在进程内发出，但导出器仅在启用诊断和导出器插件时才会挂载。
+
+### OpenTelemetry 与 OTLP
+
+- **OpenTelemetry (OTel)**：用于追踪、指标和日志的数据模型 + SDK。
+- **OTLP**：用于将 OTel 数据导出到收集器/后端的传输协议。
+- OpenClaw 目前通过 **OTLP/HTTP (protobuf)** 导出。
+
+### 导出的信号
+
+- **指标**：计数器 + 直方图（令牌使用、消息流、队列）。
+- **追踪**：模型使用 + webhook/消息处理的 span。
+- **日志**：当 `diagnostics.otel.logs` 启用时通过 OTLP 导出。日志量可能很大；请注意 `logging.level` 和导出器过滤器。
+
+### 诊断事件目录
+
+模型使用：
+
+- `model.usage`：令牌数、成本、持续时间、上下文、提供商/模型/渠道、会话 ID。
+
+消息流：
+
+- `webhook.received`：每个渠道的 webhook 入口。
+- `webhook.processed`：webhook 已处理 + 持续时间。
+- `webhook.error`：webhook 处理器错误。
+- `message.queued`：消息已入队等待处理。
+- `message.processed`：结果 + 持续时间 + 可选错误。
+
+队列 + 会话：
+
+- `queue.lane.enqueue`：命令队列通道入队 + 深度。
+- `queue.lane.dequeue`：命令队列通道出队 + 等待时间。
+- `session.state`：会话状态转换 + 原因。
+- `session.stuck`：会话卡住警告 + 持续时间。
+- `run.attempt`：运行重试/尝试元数据。
+- `diagnostic.heartbeat`：聚合计数器（webhook/队列/会话）。
+
+### 启用诊断（无导出器）
+
+如果你希望诊断事件可供插件或自定义接收器使用，请使用此配置：
+
+```json
+{
+  "diagnostics": {
+    "enabled": true
+  }
+}
+```
+
+### 诊断标志（定向日志）
+
+使用标志可以在不提高 `logging.level` 的情况下开启额外的定向调试日志。标志不区分大小写，支持通配符（例如 `telegram.*` 或 `*`）。
+
+```json
+{
+  "diagnostics": {
+    "flags": ["telegram.http"]
+  }
+}
+```
+
+环境变量覆盖（一次性）：
+
+```
+OPENCLAW_DIAGNOSTICS=telegram.http,telegram.payload
+```
+
+注意事项：
+
+- 标志日志写入标准日志文件（与 `logging.file` 相同）。
+- 输出仍然根据 `logging.redactSensitive` 进行脱敏。
+- 完整指南：[/diagnostics/flags](/diagnostics/flags)。
+
+### 导出到 OpenTelemetry
+
+诊断可以通过 `diagnostics-otel` 插件（OTLP/HTTP）导出。这适用于任何接受 OTLP/HTTP 的 OpenTelemetry 收集器/后端。
+
+```json
+{
+  "plugins": {
+    "allow": ["diagnostics-otel"],
+    "entries": {
+      "diagnostics-otel": {
+        "enabled": true
+      }
+    }
+  },
+  "diagnostics": {
+    "enabled": true,
+    "otel": {
+      "enabled": true,
+      "endpoint": "http://otel-collector:4318",
+      "protocol": "http/protobuf",
+      "serviceName": "openclaw-gateway",
+      "traces": true,
+      "metrics": true,
+      "logs": true,
+      "sampleRate": 0.2,
+      "flushIntervalMs": 60000
+    }
+  }
+}
+```
+
+注意事项：
+
+- 你也可以使用 `openclaw plugins enable diagnostics-otel` 来启用插件。
+- `protocol` 目前仅支持 `http/protobuf`。`grpc` 会被忽略。
+- 指标包括令牌使用、成本、上下文大小、运行持续时间，以及消息流计数器/直方图（webhook、队列、会话状态、队列深度/等待时间）。
+- 追踪/指标可以通过 `traces` / `metrics` 切换（默认：开启）。启用时，追踪包括模型使用 span 以及 webhook/消息处理 span。
+- 当你的收集器需要认证时，请设置 `headers`。
+- 支持的环境变量：`OTEL_EXPORTER_OTLP_ENDPOINT`、`OTEL_SERVICE_NAME`、`OTEL_EXPORTER_OTLP_PROTOCOL`。
+
+### 导出的指标（名称 + 类型）
+
+模型使用：
+
+- `openclaw.tokens`（计数器，属性：`openclaw.token`、`openclaw.channel`、`openclaw.provider`、`openclaw.model`）
+- `openclaw.cost.usd`（计数器，属性：`openclaw.channel`、`openclaw.provider`、`openclaw.model`）
+- `openclaw.run.duration_ms`（直方图，属性：`openclaw.channel`、`openclaw.provider`、`openclaw.model`）
+- `openclaw.context.tokens`（直方图，属性：`openclaw.context`、`openclaw.channel`、`openclaw.provider`、`openclaw.model`）
+
+消息流：
+
+- `openclaw.webhook.received`（计数器，属性：`openclaw.channel`、`openclaw.webhook`）
+- `openclaw.webhook.error`（计数器，属性：`openclaw.channel`、`openclaw.webhook`）
+- `openclaw.webhook.duration_ms`（直方图，属性：`openclaw.channel`、`openclaw.webhook`）
+- `openclaw.message.queued`（计数器，属性：`openclaw.channel`、`openclaw.source`）
+- `openclaw.message.processed`（计数器，属性：`openclaw.channel`、`openclaw.outcome`）
+- `openclaw.message.duration_ms`（直方图，属性：`openclaw.channel`、`openclaw.outcome`）
+
+队列 + 会话：
+
+- `openclaw.queue.lane.enqueue`（计数器，属性：`openclaw.lane`）
+- `openclaw.queue.lane.dequeue`（计数器，属性：`openclaw.lane`）
+- `openclaw.queue.depth`（直方图，属性：`openclaw.lane` 或 `openclaw.channel=heartbeat`）
+- `openclaw.queue.wait_ms`（直方图，属性：`openclaw.lane`）
+- `openclaw.session.state`（计数器，属性：`openclaw.state`、`openclaw.reason`）
+- `openclaw.session.stuck`（计数器，属性：`openclaw.state`）
+- `openclaw.session.stuck_age_ms`（直方图，属性：`openclaw.state`）
+- `openclaw.run.attempt`（计数器，属性：`openclaw.attempt`）
+
+### 导出的 span（名称 + 关键属性）
+
+- `openclaw.model.usage`
+  - `openclaw.channel`、`openclaw.provider`、`openclaw.model`
+  - `openclaw.sessionKey`、`openclaw.sessionId`
+  - `openclaw.tokens.*`（input/output/cache_read/cache_write/total）
+- `openclaw.webhook.processed`
+  - `openclaw.channel`、`openclaw.webhook`、`openclaw.chatId`
+- `openclaw.webhook.error`
+  - `openclaw.channel`、`openclaw.webhook`、`openclaw.chatId`、`openclaw.error`
+- `openclaw.message.processed`
+  - `openclaw.channel`、`openclaw.outcome`、`openclaw.chatId`、`openclaw.messageId`、`openclaw.sessionKey`、`openclaw.sessionId`、`openclaw.reason`
+- `openclaw.session.stuck`
+  - `openclaw.state`、`openclaw.ageMs`、`openclaw.queueDepth`、`openclaw.sessionKey`、`openclaw.sessionId`
+
+### 采样 + 刷新
+
+- 追踪采样：`diagnostics.otel.sampleRate`（0.0–1.0，仅根 span）。
+- 指标导出间隔：`diagnostics.otel.flushIntervalMs`（最小 1000ms）。
+
+### 协议说明
+
+- OTLP/HTTP 端点可通过 `diagnostics.otel.endpoint` 或 `OTEL_EXPORTER_OTLP_ENDPOINT` 设置。
+- 如果端点已包含 `/v1/traces` 或 `/v1/metrics`，则按原样使用。
+- 如果端点已包含 `/v1/logs`，则日志导出按原样使用。
+- `diagnostics.otel.logs` 启用主日志输出的 OTLP 日志导出。
+
+### 日志导出行为
+
+- OTLP 日志使用与写入 `logging.file` 相同的结构化记录。
+- 遵循 `logging.level`（文件日志级别）。控制台脱敏**不适用于** OTLP 日志。
+- 高流量实例应优先使用 OTLP 收集器的采样/过滤功能。
+
+## 故障排除提示
+
+- **Gateway网关不可达？** 先运行 `openclaw doctor`。
+- **日志为空？** 检查 Gateway网关是否正在运行并写入 `logging.file` 中指定的文件路径。
+- **需要更多细节？** 将 `logging.level` 设置为 `debug` 或 `trace` 并重试。