跳转到主要内容

Heartbeat(Gateway)

Heartbeat vs Cron? 有关何时使用每个的指导,请参见 Cron vs Heartbeat
Heartbeat 在主 session 中运行周期性 agent 轮次,以便模型可以显示需要注意的任何内容,而不会向您发送垃圾邮件。

快速入门(初学者)

  1. 保持 heartbeats 启用(默认为 30m,或对于 Anthropic OAuth/setup-token 为 1h)或设置您自己的节奏。
  2. 在 agent workspace 中创建一个微小的 HEARTBEAT.md 清单(可选但推荐)。
  3. 决定 heartbeat 消息应该去哪里(target: "last" 是默认值)。
  4. 可选:启用 heartbeat reasoning 传递以提高透明度。
  5. 可选:将 heartbeats 限制在活动时间(本地时间)。
示例配置:
{
  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 或每个 agent 的 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”部分,并且运行在内部被标记。
  • 活动时间(heartbeat.activeHours)在配置的时区中检查。在窗口之外,heartbeats 被跳过,直到窗口内的下一个 tick。

Heartbeat 提示的用途

默认提示有意广泛:
  • 后台任务:“Consider outstanding tasks”促使 agent 审查后续事项(收件箱、日历、提醒、排队工作)并显示任何紧急内容。
  • 人工检查:“Checkup sometimes on your human during day time”促使偶尔的轻量级”anything you need?”消息,但通过使用您配置的本地时区避免夜间垃圾邮件(参见 /zh/concepts/timezone)。
如果您希望 heartbeat 执行非常具体的操作(例如”check Gmail PubSub stats”或”verify gateway health”),请将 agents.defaults.heartbeat.prompt(或 agents.list[].heartbeat.prompt)设置为自定义正文(逐字发送)。

响应契约

  • 如果不需要注意,请回复 HEARTBEAT_OK
  • 在 heartbeat 运行期间,当它出现在回复的开头或结尾时,OpenClaw 将 HEARTBEAT_OK 视为确认。令牌被剥离,如果剩余内容 ackMaxChars(默认:300),则回复被丢弃。
  • 如果 HEARTBEAT_OK 出现在回复的中间,则不会特别对待。
  • 对于警报,不要包含 HEARTBEAT_OK;仅返回警报文本。
在 heartbeats 之外,消息开头/结尾的游离 HEARTBEAT_OK 被剥离并记录;仅包含 HEARTBEAT_OK 的消息被丢弃。

配置

{
  agents: {
    defaults: {
      heartbeat: {
        every: "30m",           // 默认:30m(0m 禁用)
        model: "anthropic/claude-opus-4-5",
        includeReasoning: false, // 默认:false(可用时传递单独的 Reasoning: 消息)
        target: "last",         // last | none | <channel id>(核心或插件,例如"bluebubbles")
        to: "+15551234567",     // 可选的特定 channel 覆盖
        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 设置全局 heartbeat 行为。
  • agents.list[].heartbeat 在顶部合并;如果任何 agent 有 heartbeat 块,仅那些 agents 运行 heartbeats。
  • channels.defaults.heartbeat 为所有 channels 设置可见性默认值。
  • channels.<channel>.heartbeat 覆盖 channel 默认值。
  • channels.<channel>.accounts.<id>.heartbeat(多账户 channels)覆盖每个 channel 的设置。

每个 agent 的 heartbeats

如果任何 agents.list[] 条目包含 heartbeat 块,仅那些 agents 运行 heartbeats。每个 agent 的块在 agents.defaults.heartbeat 之上合并(因此您可以设置一次共享默认值并按 agent 覆盖)。 示例:两个 agents,只有第二个 agent 运行 heartbeats。
{
  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:heartbeat 间隔(持续时间字符串;默认单位 = 分钟)。
  • model:heartbeat 运行的可选模型覆盖(provider/model)。
  • includeReasoning:启用时,在可用时也传递单独的 Reasoning: 消息(与 /reasoning on 相同的形状)。
  • session:heartbeat 运行的可选 session 键。
    • main(默认):agent 主 session。
    • 显式 session 键(从 openclaw sessions --jsonsessions CLI 复制)。
    • Session 键格式:参见 SessionsGroups
  • target:
    • last(默认):传递到最后使用的外部 channel。
    • 显式 channel:whatsapp / telegram / discord / googlechat / slack / msteams / signal / imessage
    • none:运行 heartbeat 但不要外部传递。
  • to:可选的接收者覆盖(特定 channel 的 id,例如 WhatsApp 的 E.164 或 Telegram 聊天 id)。
  • prompt:覆盖默认提示正文(不合并)。
  • ackMaxChars:传递前 HEARTBEAT_OK 后允许的最大字符数。

传递行为

  • Heartbeats 默认在 agent 的主 session 中运行(agent:<id>:<mainKey>),或当 session.scope = "global" 时为 global。设置 session 以覆盖到特定的 channel session(Discord/WhatsApp/等)。
  • session 仅影响运行上下文;传递由 targetto 控制。
  • 要传递到特定的 channel/接收者,设置 target + to。使用 target: "last",传递使用该 session 的最后一个外部 channel。
  • 如果主队列繁忙,heartbeat 被跳过并稍后重试。
  • 如果 target 解析为无外部目标,运行仍然发生,但不发送出站消息。
  • 仅 Heartbeat 的回复不会保持 session 活动;最后的 updatedAt 被恢复,因此空闲过期正常运行。

可见性控制

默认情况下,HEARTBEAT_OK 确认被抑制,而警报内容被传递。您可以按 channel 或按账户调整此设置:
channels:
  defaults:
    heartbeat:
      showOk: false      # 隐藏 HEARTBEAT_OK(默认)
      showAlerts: true   # 显示警报消息(默认)
      useIndicator: true # 发出指示器事件(默认)
  telegram:
    heartbeat:
      showOk: true       # 在 Telegram 上显示 OK 确认
  whatsapp:
    accounts:
      work:
        heartbeat:
          showAlerts: false # 抑制此账户的警报传递
优先级:每个账户 → 每个 channel → channel 默认值 → 内置默认值。

每个标志的作用

  • showOk:当模型返回仅 OK 回复时发送 HEARTBEAT_OK 确认。
  • showAlerts:当模型返回非 OK 回复时发送警报内容。
  • useIndicator:为 UI 状态表面发出指示器事件。
如果全部三个都为 false,OpenClaw 完全跳过 heartbeat 运行(无模型调用)。

每个 channel vs 每个账户示例

channels:
  defaults:
    heartbeat:
      showOk: false
      showAlerts: true
      useIndicator: true
  slack:
    heartbeat:
      showOk: true # 所有 Slack 账户
    accounts:
      ops:
        heartbeat:
          showAlerts: false # 仅抑制 ops 账户的警报
  telegram:
    heartbeat:
      showOk: true

常见模式

目标配置
默认行为(静默 OKs,警报开启)(不需要配置)
完全静默(无消息,无指示器)channels.defaults.heartbeat: { showOk: false, showAlerts: false, useIndicator: false }
仅指示器(无消息)channels.defaults.heartbeat: { showOk: false, showAlerts: false, useIndicator: true }
仅在一个 channel 中 OKschannels.telegram.heartbeat: { showOk: true }

HEARTBEAT.md(可选)

如果 workspace 中存在 HEARTBEAT.md 文件,默认提示告诉 agent 读取它。将其视为您的”heartbeat 清单”:小、稳定且每 30 分钟包含一次是安全的。 如果 HEARTBEAT.md 存在但实际上为空(仅空白行和 markdown 标题,如 # Heading),OpenClaw 跳过 heartbeat 运行以节省 API 调用。如果文件缺失,heartbeat 仍然运行,模型决定做什么。 保持它很小(简短的清单或提醒)以避免提示膨胀。 示例 HEARTBEAT.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.

Agent 可以更新 HEARTBEAT.md 吗?

是的 — 如果您要求它。 HEARTBEAT.md 只是 agent workspace 中的一个普通文件,因此您可以在正常聊天中告诉 agent 类似:
  • “Update HEARTBEAT.md to add a daily calendar check.”
  • “Rewrite HEARTBEAT.md so it’s shorter and focused on inbox follow-ups.”
如果您希望这主动发生,您还可以在 heartbeat 提示中包含一个显式行,例如:“If the checklist becomes stale, update HEARTBEAT.md with a better one.” 安全注意事项:不要将秘密(API 密钥、电话号码、私有令牌)放入 HEARTBEAT.md — 它成为提示上下文的一部分。

手动唤醒(按需)

您可以将系统事件加入队列并使用以下命令触发立即 heartbeat:
openclaw system event --text "Check for urgent follow-ups" --mode now
如果多个 agents 配置了 heartbeat,手动唤醒会立即运行每个这些 agent heartbeats。 使用 --mode next-heartbeat 等待下一个计划的 tick。

Reasoning 传递(可选)

默认情况下,heartbeats 仅传递最终的”answer”有效负载。 如果您想要透明度,启用:
  • agents.defaults.heartbeat.includeReasoning: true
启用时,heartbeats 还将传递一个单独的消息,前缀为 Reasoning:(与 /reasoning on 相同的形状)。当 agent 管理多个 sessions/codexes 并且您想看到它为什么决定 ping 您时,这可能很有用 — 但它也可能泄漏比您想要的更多的内部细节。在群聊中最好保持关闭。

成本意识

Heartbeats 运行完整的 agent 轮次。较短的间隔消耗更多令牌。保持 HEARTBEAT.md 小,并考虑更便宜的 modeltarget: "none",如果您只想要内部状态更新。