配置告警
简介
本文档介绍 CloudCanal docker 部署如何配置告警。CloudCanal任务告警、机器告警均需要先完成系统的告警配置才可以正常工作。告警当前支持的发送方式和对接实现方式主要如下表所示:
发送方式 | 对接实现方式 |
---|---|
短信 | 阿里云短信服务 |
即时通讯软件(IM) | 钉钉 |
即时通讯软件(IM) | 微信 |
即时通讯软件(IM) | 飞书 |
即时通讯软件(IM) | webhook |
配置告警
告警设置准备
- 创建钉钉告警群,创建钉钉机器人,获取告警API参考《创建告警机器人》
- 创建微信告警群,获取告警API参考《使用企业微信群接收告警通知》
- 创建飞书机器人,参考《自定义机器人指南》
- 自定义webhook请自行准备好webhook
快捷配置
CloudCanal控制台提供了快速配置告警设置的方式。点击右上角个人头像选择 账户信息 ,红框内的设置即是报警相关的配置。如果是从未配置过的,显示为红色待创建状态。配置后即可生效,其优先级高于配置文件中的配置。
基于配置文件配置
配置文件中包含更加完整的配置项,如果有比较强的自定义配置需求可以采用基于配置文件配置的方式。
修改 console 容器中 springboot 配置文件中配置
- 进入cloudcanal-console容器,docker exec -it cloudcanal-console /bin/bash
- 修改文件:/home/clougence/cloudcanal/console/conf/business-output.properties
- 修改配置项
## 对接实现方式,可以填写weixin、feishu、dingtalk、custom
console.config.alert.type=weixin
## 钉钉机器人webhook地址
console.config.alert.dingtalk.alerturl=
## 微信webhook地址
console.config.alert.weixin.alerturl=
## 飞书机器人webhook地址
console.config.alert.feishu.alerturl=
## 自定义webhook地址
console.config.alert.custom.alerturl=
## 延迟任务探测周期,默认30秒
console.config.alert.incre.delay.scan.period.sec=30
## 报警抑制,同一个报警内容在指定时间范围内进行抑制,默认1分钟以内不发送重复的报警
console.config.alert.task.indicator.suppression.min=1
备注:告警类型type(dingtalk/weixin),任选一个然后将对应的api填到alerturl行
重启 console 容器并确认能够正常登陆控制台
订阅任务告警
创建完任务后,CloudCanal默认将任务告警发送给创建人,并默认勾选发送给管理员,即所有身份为系统管理员(SYSTEM)的用户也能收到该任务的告警信息。
订阅任务
如果想要接收某个任务的告警,点击 任务详情-功能列表-告警配置,弹出任务告警配置弹窗,点击 关注告警 按钮,即可接收到该任务的告警信息。
同理,如果不想接收到某任务的告警,点击 取消关注 即可。
查看订阅的任务
如果想要查看所有已经订阅的任务,点击右上角个人头像选择 账户信息,红框内的关注列表即为当前订阅的任务。