觸達(dá)通道
本文檔內(nèi)容為 Quick Tracking 產(chǎn)品使用介紹和技術(shù)集成說(shuō)明文檔，不作為銷售依據(jù)；具體企業(yè)采購(gòu)產(chǎn)品和技術(shù)服務(wù)內(nèi)容，以商業(yè)采購(gòu)合同為準(zhǔn)。
概述
通過(guò)觸達(dá)通道可以設(shè)置監(jiān)控告警的推送通道，如郵箱、webhook，設(shè)置后監(jiān)控告警的信息則可通過(guò)該通道做監(jiān)控結(jié)果觸達(dá)。
生效范圍：組織范圍內(nèi)均生效。
功能介紹
郵箱設(shè)置
該設(shè)置需要“發(fā)送郵箱地址、郵箱授權(quán)碼和SMTP”，具體如下圖：
發(fā)送地址獲取：發(fā)送郵件的郵箱地址，比如“c***@1*.com”。
郵箱授權(quán)碼和SMTP（發(fā)件箱服務(wù)器地址）獲取：
以QQ郵箱為例，在郵箱的“設(shè)置-賬戶-POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服務(wù)”中，點(diǎn)擊POP3/SMTP服務(wù)的”開(kāi)啟“，并通過(guò)手機(jī)短信生成授權(quán)碼。
以163網(wǎng)易郵箱為例，可在“設(shè)置-POP3/SMTP/IMAP”頁(yè)面中，點(diǎn)擊IMAP/SMTP服務(wù)的”開(kāi)啟“，并通過(guò)手機(jī)短信生成授權(quán)碼。
群Webhook通道
選擇Webhook方式，添加設(shè)置，平臺(tái)名稱可自定義（可以設(shè)置為釘釘群名，易于區(qū)分）
Webhook支持推送到釘釘群，具體設(shè)置方式如下
Webhook鏈接獲取方式
1、首先需要在收信群組中添加自定義機(jī)器人
2、在釘釘機(jī)器人中設(shè)置關(guān)鍵詞：
在告警計(jì)劃中觸達(dá)請(qǐng)使用“QT業(yè)務(wù)報(bào)警”
3、獲取到webhook地址
4、添加至QT“觸達(dá)通道”
5、消息樣式
自定義Webhook通道
自定義webhook流程圖
接入步驟
在配置webhook的時(shí)候，由于每個(gè)客戶的協(xié)議都會(huì)有所不同，為了兼容多種情況，webhook配置會(huì)支持多種方式，具體如下：
配置項(xiàng)
子配置項(xiàng)
是否必填
含義
示例
request
method
是
請(qǐng)求方法（POST/GET）
https://xxx.yyy.com
headers
否
請(qǐng)求頭（填入的是Key-Value）
POST
body
否
請(qǐng)求體（客戶側(cè)自己定義即可，格式是json，用大括號(hào){{xx}}進(jìn)行占位，表示的是預(yù)定義的變量）
{ "name": "測(cè)試自定義Webhook", "title": "「{{OrgName}}」的「{{AppName}}」監(jiān)控任務(wù)「{{MonitorTaskName}}」發(fā)生異常", "content": "指標(biāo)：{{IndicatorDescription}}發(fā)生異常\n異常信息為：{{IndicatorExceptionMsgContent}}" }
bodySuccessTag
-
否
請(qǐng)求成功標(biāo)識(shí)
預(yù)定義的字段
預(yù)定義字段
含義
OrgName
組織名稱
AppName
應(yīng)用名稱
WebhookPlatformName
自定義webhook名稱
MonitorTaskId
監(jiān)控任務(wù)ID
MonitorTaskName
監(jiān)控任務(wù)名稱
IndicatorDescription
指標(biāo)描述
IndicatorExceptionMsgContent
指標(biāo)異常信息正文
IndicatorExceptionMsgList
指標(biāo)異常信息列表
代碼示例
示例一：
配置：
{
"request": {
"method": "post",
"headers": {
"Content-Type": "application/json"
},
"body": {
"name": "測(cè)試自定義Webhook",
"title": "「{{OrgName}}」的「{{AppName}}」監(jiān)控任務(wù)「{{MonitorTaskName}}」發(fā)生異常",
"content": "指標(biāo)：{{IndicatorDescription}}發(fā)生異常\n異常信息為：{{IndicatorExceptionMsgContent}}"
}
}
}響應(yīng)：
{
"name": "測(cè)試自定義Webhook",
"title": "「測(cè)試組織」的「測(cè)試視圖」監(jiān)控任務(wù)「測(cè)試視圖監(jiān)控」發(fā)生異常",
"content": "指標(biāo)：任意事件(預(yù)置)的設(shè)備ID的觸發(fā)次數(shù)發(fā)生異常\n異常信息為：告警計(jì)算時(shí)間:2024/05/09 01:00:00「SDK版本 [\"5.3.2\"]」當(dāng)前指標(biāo)值為232.0, 區(qū)間在 1 至 10000\n「SDK版本 [\"6.5.6\"]」當(dāng)前指標(biāo)值為186.0, 區(qū)間在 1 至 10000\n「SDK版本 [\"6.3.0\"]」當(dāng)前指標(biāo)值為326.0, 區(qū)間在 1 至 10000\n「SDK版本 [\"10.3.2\"]」當(dāng)前指標(biāo)值為288.0, 區(qū)間在 1 至 10000\n「SDK版本 [\"12.5.6\"]」當(dāng)前指標(biāo)值為48.0, 區(qū)間在 1 至 10000\n「SDK版本 [\"11.3.0\"]」當(dāng)前指標(biāo)值為48.0, 區(qū)間在 1 至 10000"
}示例二：
配置：
{
"request": {
"method": "post",
"headers": {
"Content-Type": "application/json"
},
"body": {
"name": "測(cè)試自定義Webhook",
"title": "「{{OrgName}}」的「{{AppName}}」監(jiān)控任務(wù)「{{MonitorTaskName}}」發(fā)生異常",
"taskId": "{{MonitorTaskId}}",
"msgList": {{IndicatorExceptionMsgList}}
}
}
}響應(yīng)：
{
"name": "測(cè)試自定義Webhook",
"title": "「測(cè)試組織」的「測(cè)試視圖」監(jiān)控任務(wù)「測(cè)試視圖監(jiān)控」發(fā)生異常",
"taskId": "1837812901",
"msgList": [
"「SDK版本 [\"5.3.2\"]」當(dāng)前指標(biāo)值為232.0",
"「SDK版本 [\"6.5.6\"]」當(dāng)前指標(biāo)值為186.0, 區(qū)間在 1 至 10000",
"「SDK版本 [\"10.3.2\"]」當(dāng)前指標(biāo)值為288.0, 區(qū)間在 1 至 10000",
"「SDK版本 [\"12.5.6\"]」當(dāng)前指標(biāo)值為48.0, 區(qū)間在 1 至 10000"
]
}