配置任务告警
CloudCanal 支持对任务进行告警配置，以便监控任务状态。本文介绍如何进行配置和查看配置信息。
功能入口
进入同步任务列表或任务详情页，点击任务的告警配置入口，打开“任务告警配置”弹窗。
单任务配置会展示该任务当前的完整告警配置，包括告警人员、告警规则和通知设置。批量配置会先展示可配置项入口，只有主动添加的配置项才会在保存时批量覆盖到选中的任务。
告警编辑权限说明
告警配置需要两类权限：告警规则权限和告警人员权限。
账号角色权限会影响页面上可见、可操作的功能。子账号权限是更细粒度的权限划分，决定用户是否能查看/编辑某个资源（数据源/任务等）。
具体可参考 CloudCanal 官方文档：角色权限、子账号权限。
| 操作 | 角色权限要求 | 子账号权限要求 | 说明 |
|---|---|---|---|
| 编辑单任务告警规则或批量修改告警规则 | • 数据同步 ○ 任务 i. 任务查看 ii. 任务管理 | • 任务权限 ○ 数据同步 ▪ 任务读权限 ▪ 任务写权限 | 用于修改告警规则配置。 |
| 编辑告警人员 | • 数据同步 ○ 任务 i. 任务查看 ii. 任务管理 • 系统设置 ○ 子账号管理 i. 子账号管理 ii. 资源授权管理 | • 任务权限 ○ 数据同步 ▪ 任务读权限 ▪ 任务写权限 | 满足权限时，告警人员会展示为可选择的多选框，同时可编辑告警人员；否则只展示当前接收人。 |
信息
如果一个账号具有 “全部资源” 的权限（系统配置 - 子账号管理 - 全部资源权限），则默认会接收到所有任务的告警。
告警通知配置
告警人员
告警人员决定哪些账号会收到该任务的告警通知。修改告警人员只影响接收权限，不改变告警规则本身。
通知设置
通知设置是任务级公共通知配置，会应用到该任务的告警配置上，优先级最高。
| 字段 | 说明 |
|---|---|
| 暂时关闭告警 | 勾选“关闭”并选择时间段后，在该时间段内暂停发送告警。暂停时间结束后，系统会自动恢复告警。 |
| IM 类型 | 选择任务级 IM 通知渠道。中国站点支持钉钉、企业微信、飞书、自定义。 |
| WebHook | IM 通知的 WebHook 地址。勾选 IM 告警方式后，会使用这里配置的任务级 IM 通知信息。 |
| 代理地址 | 访问 WebHook 时使用的代理地址，可按环境需要填写。 |
告警事件和配置项
当前任务告警主要分为 4 类：延迟告警、异常告警、校验差异、事件告警。
| 告警类型 | 事件标识 | 触发说明 | 常用配置 |
|---|---|---|---|
| 延迟告警 | TASK_POSITION_DELAY_EVENT | 同步任务延迟超过配置阈值时触发；延迟恢复稳定后发送恢复通知。 | 延迟阈值、告警方式、告警抑制间隔、持续时间、是否关联异常。 |
| 异常告警 | TASK_EXCEPTION_EVENT | 任务运行过程中出现异常事件时触发。 | 告警方式、告警抑制间隔、关键字白名单。 |
| 校验差异 | DATA_TASK_DIFF_EVENT | 校验任务发现数据不一致或数据丢失时触发。 | 告警方式。 |
| 事件告警 | TASK_NORMAL_EVENT | 任务触发特定业务事件时触发。 | 事件子类型、告警方式。 |
延迟告警
延迟告警用于发现同步任务消费位点落后。
| 配置项 | 说明 |
|---|---|
| 指标 | 固定为任务延迟时间，单位分钟。配置值最小为 1 分钟。 |
| 告警方式 | 可选择 IM、邮箱、短信、电话。 |
| 告警抑制间隔 | 同一延迟告警在指定分钟内只通知一次。默认 5 分钟。同时会受到 cloudcanal console 配置文件中的 console.config.alert.incre.delay.scan.period.sec 扫表频率配置项影响，默认 5 分钟。 |
| 持续时间 | 延迟时间达到告警阈值并且持续指定分钟才触发延迟告警；进入延迟态后，在延迟时间小于告警阈值并且持续指定分钟才触发延迟恢复告警。默认 0，表示满足条件后立即触发或恢复。 |
| 关联异常后才发送延迟告警 | 开启后，延迟条件满足时还需要在本次延迟周期内关联到任务异常，才发送延迟告警。异常检索范围为：[上一次延迟恢复的时间，当前时间]。 |
异常告警
异常告警用于通知任务运行过程中的异常。
| 配置项 | 说明 |
|---|---|
| 告警方式 | 可选择 IM、邮箱、短信、电话 。 |
| 告警抑制间隔 | 同一异常告警在指定分钟内只通知一次。默认 5 分钟。同时会受到 cloudcanal sidecar 配置文件中的 sidecar.config.exp.suppressed.min 配置项影响，默认 5 分钟。该配置项主要用于防止高频相同异常占用 sidecar 与 console 之间的网络资源。 |
| 关键字白名单 | 命中白名单关键字的异常不会发送告警，具体值配置为 CloudCanal 发送的告警所携带的异常信息。 |
校验差异
校验差异告警用于通知校验任务的数据不一致或数据丢失。
| 配置项 | 说明 |
|---|---|
| 告警方式 | 可选择 IM、邮箱、短信、电话。 |
事件告警
事件告警用于通知任务内的特定业务事件。
| 配置项 | 说明 |
|---|---|
| 事件 | 多选事件子类型。选择多个事件时，任一事件发生都会触发告警。 |
| 告警方式 | 可选择 IM、邮箱、短信、电话。 |
| 子事件 | 标识 | 说 明 |
|---|---|---|
| 源端数据库主备切换事件 | TASK_DB_SWITCH_EVENT | 任务检测到源端数据库发生主备切换时触发。 |
| DDL 事件 | TASK_DDL_EVENT | 任务检测到源端 DDL 事件时触发。 |
批量配置
批量配置用于对多个任务应用同一组告警改动。
- 在任务列表中选择多个任务。
- 打开“批量修改告警配置”。
- 按需添加要修改的内容，例如“告警人员”“延迟告警”“异常告警”“校验差异”“事件告警”“通知设置”。
- 只填写本次需要统一修改的配置项。
- 点击“确认”后，系统会将这些配置应用到所有选中的任务。
批量配置的关键原则是：没有添加的配置项不会修改。比如只添加“异常告警”，则不会改变选中任务的延迟告警、校验差异、事件告警、告警人员和通知设置。
