文档

了解如何用 Doyouok 监控你的定时任务、事件触发的处理流程和后台作业。

快速开始

  1. 登录后在控制台点击"新建监控项",为你的任务命名并设置打卡间隔。
  2. 复制监控项对应的 Ping URL。
  3. 让你的任务在每次运行成功后请求这个 URL。
  4. 如果超过设定的间隔没有收到打卡,我们会立即提醒你。

Ping URL

每个监控项都有一个专属 Ping URL,格式如下(api_key 是可轮换的密钥,与监控项本身无关):

https://ping.doyouok.com/ping/{api_key}

支持 GET 或 POST 请求,返回固定的 200 状态码 —— 无论 api_key 是否有效,响应都不会透露任何信息,避免被枚举猜测。

路径 作用
/ping/{api_key} 打卡(心跳)
/ping/{api_key}/start 标记任务开始运行,仅任务模式下用于计算本次运行耗时

如果 Ping URL 泄露,可以在控制台随时轮换(Rotate):旧的 URL 会立即失效,无需重建监控项。

两种监控模式

心跳模式(LifeMonitor)

适合"应该持续发生、但不一定按固定时间表运行"的流程,既可以是定时任务(例如"每天凌晨备份一次"),也可以是由事件触发的处理流程(例如每次收到 webhook、处理一笔订单时打卡)。只要在你设置的间隔内收到至少一次 Ping,监控项就保持 Up;超过间隔没收到 Ping,监控项变为 Down 并触发告警。

任务模式(TaskMonitor)

适合需要记录每次运行日志和耗时的任务。配合 /start 与结束时的打卡使用,可以记录本次运行的耗时;如果只请求结束打卡,则记录一条不含耗时的运行日志。

监控项状态

  • New —— 刚创建,还没收到过打卡。
  • Up —— 打卡正常,一切正常。
  • Down —— 超过设定间隔没收到打卡,已发送告警。

告警机制

监控项超时后,我们会发送提醒:先是首次提醒,若仍未恢复则发送最后一次提醒,单次"失联"最多发送 2 次;只要收到一次打卡,计数会重置。