报警回调
更新时间:2024-09-18
报警回调
通过报警回调,可实现将报警通知发送到您指定的URL。您可以自由、灵活的处理各类告警消息,BLS使用BCM通知模版,在BCM侧通知模版里可填写报警回调地址,通过企业微信、钉钉、如流、飞书、知音楼、KNOCK等办公软件接收报警通知,请参见webhook使用说明。同时支持自定义回调URL,支持通过 HTTP/HTTPS协议 的 POST 请求推送到可访问公网 URL ,您可基于回调接口推送的报警信息做进一步的处理。
报警回调使用说明
- 报警回调接口:您需要提供能接收 HTTP/HTTPS 协议的POST 请求,并且公网可访问的 URL 地址,作为回调地址。
- 报警回调触发:如果填写了报警回调地址,触发逻辑与报警短信、邮件、电话一致,当创建的报警策略被触发、报警策略恢复时,均会通过报警回调接口发送告警消息。
- 绑定报警回调接口:您可在创建告警策略详添加回调接口。一个告警策略只可绑定一个报警回调 URL。
- 返回内容:当向绑定的 URL 发出报警信息后,我们需要接收到标识成功的返回内容(httpCode = 200),以表明已成功接收信息;否则我们将重复发送告警信息,最多重试三次,超时时间为5s(重试机制)
报警回调操作步骤
- 在云监控BCM平台左侧导航栏中点击<报警管理>-><通知模版>,点击<添加模版>。
- 在添加通知模版页面,接口回调一栏,输入公网可访问的 URL 地址。
3.在日志服务BLS平台,<报警管理>-><创建报警策略>选择带有报警回调地址的报警通知模版即可
webhook使用说明
- 企业微信
- 登录企业微信,打开需要接收报警通知的企业微信群。
- 添加群机器人后,复制webhook地址,参考上面操作步骤填写到“报警回调”中即可。
- 配置成功后,当报警通知被触发时,您可以在企业微信群收到报警通知。
- 钉钉
- 登录钉钉,打开需要接收报警通知的钉钉群,添加群机器人。
- 填写表单,“安全设置”模块勾选“自定义关键词”选项,建议填写“报警”作为关键词。
说明:勾选自定义关键词复选框,输入添加关键词,最多可以设置10个关键词,消息中至少包含其中1个关键词才可以发送成功。例如添加了一个自定义关键词:报警,则这个机器人所发送的消息,必须包含报警这个词,才能发送成功。
- 群内添加钉钉机器人,复制webhook地址,参考上面操作步骤填写到“报警回调”中即可。
- 配置成功后,当报警通知被触发时,您可以在钉钉群收到报警通知。
- 如流
- 登录如流,打开需要接收报警通知的如流群。
- 群内添加如流机器人,复制webhook地址,参考上面操作步骤填写到“报警回调”中即可。
- 配置成功后,当报警通知被触发时,您可以在如流群收到报警通知。
- 知音楼
- 登录知音楼,打开需要接收报警通知的知音楼群
- 填写表单,“安全设置”模块勾选“自定义关键词”选项,建议填写“报警”作为关键词。
说明:勾选自定义关键词复选框,输入添加关键词,最多可以设置10个关键词,消息中至少包含其中1个关键词才可以发送成功。例如添加了一个自定义关键词:报警,则这个机器人所发送的消息,必须包含报警这个词,才能发送成功。。
- 群内添加如流机器人,复制webhook地址,参考上面操作步骤填写到“报警回调”中即可。
- 配置成功后,当报警通知被触发时,您可以在如流群收到报警通知。
- 飞书
- 登录飞书,打开需要接收报警通知的飞书群。
- 群内添加如流机器人,复制webhook地址,参考上面操作步骤填写到“报警回调”中即可。
- 配置成功后,当报警通知被触发时,您可以在如流群收到报警通知。
- Knock
- 登录Knock,打开需要接收报警通知的Knock群。
- 群内添加如流机器人,复制webhook地址,参考上面操作步骤填写到“报警回调”中即可。
- 配置成功后,当报警通知被触发时,您可以在如流群收到报警通知。
POST方式参数说明
日志报警POST方式参数说明
参数 | 说明 |
---|---|
alertId | 报警ID |
userId | 账号ID |
policyName | 报警策略名称 |
triggerTimestamp | 发生报警的时间戳 |
region | 报警对象所在的地域 |
objects | 发生报警的对象,包含project日志日志,logStoreName日志集,logStoreId日志集ID |
alarmLevel | 报警等级状态。根据实际情况返回严重、通知、重要、警告四种状态中的一种 |
alarmStauts | 报警状态,报警,恢复正常,重复报警三种中的一种 |
triggerCondition | 触发条件 |
currentValue | 报警发生或恢复时监控项的当前值 |
targetSQL | 触发报警的执行语句 |
rawLogs | 日志原文 |