本文档内容为 Quick Tracking 产品使用介绍和技术集成说明文档,不作为销售依据;具体企业采购产品和技术服务内容,以商业采购合同为准。
概述
通过触达通道可以设置监控告警的推送通道,如邮箱、webhook,设置后监控告警的信息则可通过该通道做监控结果触达。
生效范围:组织范围内均生效。
功能介绍
邮箱设置
该设置需要“发送邮箱地址、邮箱授权码和SMTP”,具体如下图:
发送地址获取:发送邮件的邮箱地址,比如“c***@1*.com”。
邮箱授权码和SMTP(发件箱服务器地址)获取:
以QQ邮箱为例,在邮箱的“设置-账户-POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服务”中,点击POP3/SMTP服务的”开启“,并通过手机短信生成授权码。
以163网易邮箱为例,可在“设置-POP3/SMTP/IMAP”页面中,点击IMAP/SMTP服务的”开启“,并通过手机短信生成授权码。
群Webhook通道
选择Webhook方式,添加设置,平台名称可自定义(可以设置为钉钉群名,易于区分)
Webhook支持推送到钉钉群,具体设置方式如下
Webhook链接获取方式
1、首先需要在收信群组中添加自定义机器人
2、在钉钉机器人中设置关键词:
在告警计划中触达请使用“QT业务报警”
3、获取到webhook地址
4、添加至QT“触达通道”
5、消息样式
自定义Webhook通道
自定义webhook流程图
接入步骤
在配置webhook的时候,由于每个客户的协议都会有所不同,为了兼容多种情况,webhook配置会支持多种方式,具体如下:
配置项
子配置项
是否必填
含义
示例
request
method
是
请求方法(POST/GET)
https://xxx.yyy.com
headers
否
请求头(填入的是Key-Value)
POST
body
否
请求体(客户侧自己定义即可,格式是json,用大括号{{xx}}进行占位,表示的是预定义的变量)
{ "name": "测试自定义Webhook", "title": "「{{OrgName}}」的「{{AppName}}」监控任务「{{MonitorTaskName}}」发生异常", "content": "指标:{{IndicatorDescription}}发生异常\n异常信息为:{{IndicatorExceptionMsgContent}}" }
bodySuccessTag
-
否
请求成功标识
预定义的字段
预定义字段
含义
OrgName
组织名称
AppName
应用名称
WebhookPlatformName
自定义webhook名称
MonitorTaskId
监控任务ID
MonitorTaskName
监控任务名称
IndicatorDescription
指标描述
IndicatorExceptionMsgContent
指标异常信息正文
IndicatorExceptionMsgList
指标异常信息列表
代码示例
示例一:
配置:
{
"request": {
"method": "post",
"headers": {
"Content-Type": "application/json"
},
"body": {
"name": "测试自定义Webhook",
"title": "「{{OrgName}}」的「{{AppName}}」监控任务「{{MonitorTaskName}}」发生异常",
"content": "指标:{{IndicatorDescription}}发生异常\n异常信息为:{{IndicatorExceptionMsgContent}}"
}
}
}
响应:
{
"name": "测试自定义Webhook",
"title": "「测试组织」的「测试视图」监控任务「测试视图监控」发生异常",
"content": "指标:任意事件(预置)的设备ID的触发次数发生异常\n异常信息为:告警计算时间:2024/05/09 01:00:00「SDK版本 [\"5.3.2\"]」当前指标值为232.0, 区间在 1 至 10000\n「SDK版本 [\"6.5.6\"]」当前指标值为186.0, 区间在 1 至 10000\n「SDK版本 [\"6.3.0\"]」当前指标值为326.0, 区间在 1 至 10000\n「SDK版本 [\"10.3.2\"]」当前指标值为288.0, 区间在 1 至 10000\n「SDK版本 [\"12.5.6\"]」当前指标值为48.0, 区间在 1 至 10000\n「SDK版本 [\"11.3.0\"]」当前指标值为48.0, 区间在 1 至 10000"
}
示例二:
配置:
{
"request": {
"method": "post",
"headers": {
"Content-Type": "application/json"
},
"body": {
"name": "测试自定义Webhook",
"title": "「{{OrgName}}」的「{{AppName}}」监控任务「{{MonitorTaskName}}」发生异常",
"taskId": "{{MonitorTaskId}}",
"msgList": {{IndicatorExceptionMsgList}}
}
}
}
响应:
{
"name": "测试自定义Webhook",
"title": "「测试组织」的「测试视图」监控任务「测试视图监控」发生异常",
"taskId": "1837812901",
"msgList": [
"「SDK版本 [\"5.3.2\"]」当前指标值为232.0",
"「SDK版本 [\"6.5.6\"]」当前指标值为186.0, 区间在 1 至 10000",
"「SDK版本 [\"10.3.2\"]」当前指标值为288.0, 区间在 1 至 10000",
"「SDK版本 [\"12.5.6\"]」当前指标值为48.0, 区间在 1 至 10000"
]
}