275 lines
12 KiB
Markdown
275 lines
12 KiB
Markdown
---
|
||
read_when:
|
||
- 调整心跳频率或消息内容时
|
||
- 在心跳和定时任务之间做选择时
|
||
summary: 心跳轮询消息和通知规则
|
||
title: 心跳
|
||
x-i18n:
|
||
generated_at: "2026-02-01T20:26:52Z"
|
||
model: claude-opus-4-5
|
||
provider: pi
|
||
source_hash: 18b017066aa2c41811b985564dd389834906f4576e85b576fb357a0eff482e69
|
||
source_path: gateway/heartbeat.md
|
||
workflow: 14
|
||
---
|
||
|
||
# 心跳（Gateway网关）
|
||
|
||
> **心跳还是定时任务？** 参见 [定时任务与心跳对比](/automation/cron-vs-heartbeat) 了解何时使用哪种方式。
|
||
|
||
心跳在主会话中运行**定期智能体对话轮次**，以便模型在不打扰你的情况下主动呈现需要关注的事项。
|
||
|
||
## 快速入门（新手）
|
||
|
||
1. 保持心跳启用（默认间隔为 `30m`，Anthropic OAuth/setup-token 模式下为 `1h`），或设置自定义频率。
|
||
2. 在智能体工作区中创建一个简短的 `HEARTBEAT.md` 检查清单（可选但推荐）。
|
||
3. 决定心跳消息发送到哪里（默认为 `target: "last"`）。
|
||
4. 可选：启用心跳推理内容投递以提高透明度。
|
||
5. 可选：将心跳限制在活跃时段（本地时间）。
|
||
|
||
配置示例：
|
||
|
||
```json5
|
||
{
|
||
agents: {
|
||
defaults: {
|
||
heartbeat: {
|
||
every: "30m",
|
||
target: "last",
|
||
// activeHours: { start: "08:00", end: "24:00" },
|
||
// includeReasoning: true, // 可选：同时发送单独的 `Reasoning:` 消息
|
||
},
|
||
},
|
||
},
|
||
}
|
||
```
|
||
|
||
## 默认值
|
||
|
||
- 间隔：`30m`（当检测到 Anthropic OAuth/setup-token 认证模式时为 `1h`）。通过 `agents.defaults.heartbeat.every` 或按智能体 `agents.list[].heartbeat.every` 设置；使用 `0m` 禁用。
|
||
- 提示词正文（可通过 `agents.defaults.heartbeat.prompt` 配置）：
|
||
`Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.`
|
||
- 心跳提示词作为用户消息**原样**发送。系统提示词包含"Heartbeat"部分，且运行在内部标记为心跳。
|
||
- 活跃时段（`heartbeat.activeHours`）按配置的时区检查。在窗口外，心跳将被跳过，直到下一个处于窗口内的时刻。
|
||
|
||
## 心跳提示词的用途
|
||
|
||
默认提示词有意设计得比较宽泛：
|
||
|
||
- **后台任务**："Consider outstanding tasks" 促使智能体检查待办事项（收件箱、日历、提醒、排队工作）并呈现紧急事项。
|
||
- **关怀用户**："Checkup sometimes on your human during day time" 促使偶尔发送一条轻量级的"需要什么帮助吗？"消息，但通过使用你配置的本地时区避免夜间打扰（参见 [/concepts/timezone](/concepts/timezone)）。
|
||
|
||
如果你希望心跳执行非常具体的任务（例如"检查 Gmail PubSub 统计"或"验证 Gateway网关健康状态"），请将 `agents.defaults.heartbeat.prompt`（或 `agents.list[].heartbeat.prompt`）设置为自定义内容（原样发送）。
|
||
|
||
## 响应约定
|
||
|
||
- 如果没有需要关注的事项，回复 **`HEARTBEAT_OK`**。
|
||
- 在心跳运行期间，当 `HEARTBEAT_OK` 出现在回复的**开头或结尾**时，OpenClaw 将其视为确认。该标记会被移除，如果剩余内容 **≤ `ackMaxChars`**（默认：300），则整条回复被丢弃。
|
||
- 如果 `HEARTBEAT_OK` 出现在回复的**中间**，则不做特殊处理。
|
||
- 对于告警，**不要**包含 `HEARTBEAT_OK`；只返回告警文本。
|
||
|
||
在心跳之外，消息开头或结尾的多余 `HEARTBEAT_OK` 会被移除并记录日志；仅包含 `HEARTBEAT_OK` 的消息将被丢弃。
|
||
|
||
## 配置
|
||
|
||
```json5
|
||
{
|
||
agents: {
|
||
defaults: {
|
||
heartbeat: {
|
||
every: "30m", // 默认：30m（0m 禁用）
|
||
model: "anthropic/claude-opus-4-5",
|
||
includeReasoning: false, // 默认：false（可用时投递单独的 Reasoning: 消息）
|
||
target: "last", // last | none | <渠道 id>（核心或插件，例如 "bluebubbles"）
|
||
to: "+15551234567", // 可选的渠道特定覆盖
|
||
prompt: "Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.",
|
||
ackMaxChars: 300, // HEARTBEAT_OK 之后允许的最大字符数
|
||
},
|
||
},
|
||
},
|
||
}
|
||
```
|
||
|
||
### 作用域和优先级
|
||
|
||
- `agents.defaults.heartbeat` 设置全局心跳行为。
|
||
- `agents.list[].heartbeat` 在其之上合并；如果任何智能体有 `heartbeat` 块，则**只有这些智能体**运行心跳。
|
||
- `channels.defaults.heartbeat` 为所有渠道设置可见性默认值。
|
||
- `channels.<channel>.heartbeat` 覆盖渠道默认值。
|
||
- `channels.<channel>.accounts.<id>.heartbeat`（多账户渠道）覆盖按渠道的设置。
|
||
|
||
### 按智能体心跳
|
||
|
||
如果任何 `agents.list[]` 条目包含 `heartbeat` 块，则**只有这些智能体**运行心跳。按智能体的块在 `agents.defaults.heartbeat` 之上合并（因此你可以设置一次共享默认值，然后按智能体覆盖）。
|
||
|
||
示例：两个智能体，只有第二个运行心跳。
|
||
|
||
```json5
|
||
{
|
||
agents: {
|
||
defaults: {
|
||
heartbeat: {
|
||
every: "30m",
|
||
target: "last",
|
||
},
|
||
},
|
||
list: [
|
||
{ id: "main", default: true },
|
||
{
|
||
id: "ops",
|
||
heartbeat: {
|
||
every: "1h",
|
||
target: "whatsapp",
|
||
to: "+15551234567",
|
||
prompt: "Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.",
|
||
},
|
||
},
|
||
],
|
||
},
|
||
}
|
||
```
|
||
|
||
### 字段说明
|
||
|
||
- `every`：心跳间隔（时长字符串；默认单位 = 分钟）。
|
||
- `model`：可选的心跳运行模型覆盖（`provider/model`）。
|
||
- `includeReasoning`：启用后，在可用时还会投递一条以 `Reasoning:` 为前缀的单独消息（与 `/reasoning on` 格式相同）。
|
||
- `session`：可选的心跳运行会话键。
|
||
- `main`（默认）：智能体主会话。
|
||
- 显式会话键（从 `openclaw sessions --json` 或[会话 CLI](/cli/sessions) 复制）。
|
||
- 会话键格式：参见[会话](/concepts/session)和[群组](/concepts/groups)。
|
||
- `target`：
|
||
- `last`（默认）：投递到最近使用的外部渠道。
|
||
- 显式渠道：`whatsapp` / `telegram` / `discord` / `googlechat` / `slack` / `msteams` / `signal` / `imessage`。
|
||
- `none`：运行心跳但**不投递**到外部。
|
||
- `to`：可选的接收者覆盖（渠道特定 ID，例如 WhatsApp 的 E.164 格式或 Telegram 聊天 ID）。
|
||
- `prompt`：覆盖默认提示词正文（不合并）。
|
||
- `ackMaxChars`：`HEARTBEAT_OK` 之后在投递前允许的最大字符数。
|
||
|
||
## 投递行为
|
||
|
||
- 心跳默认在智能体的主会话中运行（`agent:<id>:<mainKey>`），或在 `session.scope = "global"` 时为 `global`。设置 `session` 可覆盖为特定渠道会话（Discord/WhatsApp 等）。
|
||
- `session` 仅影响运行上下文；投递由 `target` 和 `to` 控制。
|
||
- 要投递到特定渠道/接收者，设置 `target` + `to`。使用 `target: "last"` 时，投递使用该会话的最近外部渠道。
|
||
- 如果主队列繁忙，心跳将被跳过并稍后重试。
|
||
- 如果 `target` 解析不到外部目标，运行仍会执行但不发送出站消息。
|
||
- 仅包含心跳的回复**不会**保持会话活跃；`updatedAt` 会被恢复，因此空闲过期行为正常。
|
||
|
||
## 可见性控制
|
||
|
||
默认情况下，`HEARTBEAT_OK` 确认会被抑制，而告警内容会被投递。你可以按渠道或按账户调整：
|
||
|
||
```yaml
|
||
channels:
|
||
defaults:
|
||
heartbeat:
|
||
showOk: false # 隐藏 HEARTBEAT_OK（默认）
|
||
showAlerts: true # 显示告警消息（默认）
|
||
useIndicator: true # 发送指示器事件（默认）
|
||
telegram:
|
||
heartbeat:
|
||
showOk: true # 在 Telegram 上显示 OK 确认
|
||
whatsapp:
|
||
accounts:
|
||
work:
|
||
heartbeat:
|
||
showAlerts: false # 抑制该账户的告警投递
|
||
```
|
||
|
||
优先级：按账户 → 按渠道 → 渠道默认值 → 内置默认值。
|
||
|
||
### 各标志的作用
|
||
|
||
- `showOk`：当模型返回仅含 OK 的回复时，发送 `HEARTBEAT_OK` 确认。
|
||
- `showAlerts`：当模型返回非 OK 回复时，发送告警内容。
|
||
- `useIndicator`：为 UI 状态展示面板发送指示器事件。
|
||
|
||
如果**三者全部**为 false，OpenClaw 将完全跳过心跳运行（不调用模型）。
|
||
|
||
### 按渠道与按账户示例
|
||
|
||
```yaml
|
||
channels:
|
||
defaults:
|
||
heartbeat:
|
||
showOk: false
|
||
showAlerts: true
|
||
useIndicator: true
|
||
slack:
|
||
heartbeat:
|
||
showOk: true # 所有 Slack 账户
|
||
accounts:
|
||
ops:
|
||
heartbeat:
|
||
showAlerts: false # 仅抑制 ops 账户的告警
|
||
telegram:
|
||
heartbeat:
|
||
showOk: true
|
||
```
|
||
|
||
### 常见模式
|
||
|
||
| 目标 | 配置 |
|
||
| ----------------------------- | ---------------------------------------------------------------------------------------- |
|
||
| 默认行为（静默 OK，告警开启） | _（无需配置）_ |
|
||
| 完全静默（无消息，无指示器） | `channels.defaults.heartbeat: { showOk: false, showAlerts: false, useIndicator: false }` |
|
||
| 仅指示器（无消息） | `channels.defaults.heartbeat: { showOk: false, showAlerts: false, useIndicator: true }` |
|
||
| 仅在一个渠道显示 OK | `channels.telegram.heartbeat: { showOk: true }` |
|
||
|
||
## HEARTBEAT.md（可选）
|
||
|
||
如果工作区中存在 `HEARTBEAT.md` 文件，默认提示词会告诉智能体读取它。把它当作你的"心跳检查清单"：简短、稳定，可以安全地每 30 分钟包含一次。
|
||
|
||
如果 `HEARTBEAT.md` 存在但实际为空（仅包含空行和 markdown 标题如 `# Heading`），OpenClaw 将跳过心跳运行以节省 API 调用。如果文件不存在，心跳仍会运行，由模型决定做什么。
|
||
|
||
保持内容简短（简短的检查清单或提醒），避免提示词膨胀。
|
||
|
||
`HEARTBEAT.md` 示例：
|
||
|
||
```md
|
||
# Heartbeat checklist
|
||
|
||
- Quick scan: anything urgent in inboxes?
|
||
- If it's daytime, do a lightweight check-in if nothing else is pending.
|
||
- If a task is blocked, write down _what is missing_ and ask Peter next time.
|
||
```
|
||
|
||
### 智能体可以更新 HEARTBEAT.md 吗？
|
||
|
||
可以——只要你让它这样做。
|
||
|
||
`HEARTBEAT.md` 只是智能体工作区中的一个普通文件，所以你可以在正常聊天中告诉智能体：
|
||
|
||
- "更新 `HEARTBEAT.md`，添加每日日历检查。"
|
||
- "重写 `HEARTBEAT.md`，使其更简短，专注于收件箱跟进。"
|
||
|
||
如果你希望这种更新主动发生，也可以在心跳提示词中包含明确的指示，例如："如果检查清单变得过时，请用更好的内容更新 HEARTBEAT.md。"
|
||
|
||
安全提示：不要在 `HEARTBEAT.md` 中放入敏感信息（API 密钥、电话号码、私有令牌）——它会成为提示词上下文的一部分。
|
||
|
||
## 手动唤醒（按需）
|
||
|
||
你可以排入系统事件并立即触发心跳：
|
||
|
||
```bash
|
||
openclaw system event --text "Check for urgent follow-ups" --mode now
|
||
```
|
||
|
||
如果多个智能体配置了 `heartbeat`，手动唤醒会立即运行每个智能体的心跳。
|
||
|
||
使用 `--mode next-heartbeat` 等待下一个计划时刻。
|
||
|
||
## 推理内容投递（可选）
|
||
|
||
默认情况下，心跳仅投递最终的"回答"载荷。
|
||
|
||
如果你需要透明度，请启用：
|
||
|
||
- `agents.defaults.heartbeat.includeReasoning: true`
|
||
|
||
启用后，心跳还会投递一条以 `Reasoning:` 为前缀的单独消息（与 `/reasoning on` 格式相同）。当智能体管理多个会话/代码库，而你想了解它为什么决定联系你时，这很有用——但它也可能泄露比你期望的更多内部细节。建议在群聊中保持关闭。
|
||
|
||
## 成本意识
|
||
|
||
心跳运行完整的智能体对话轮次。更短的间隔消耗更多令牌。保持 `HEARTBEAT.md` 简短，如果你只需要内部状态更新，考虑使用更便宜的 `model` 或 `target: "none"`。
|