FlashCat 支持使用騰訊雲語音渠道進行告警通知,下面介紹如何配置對接騰訊雲語音。
配置字段說明
夜鶯模版參數 | 騰訊雲 | 解釋說明 |
---|---|---|
TcSecretId | SecretId | 雲 API 密鑰是構建騰訊雲 API 請求的重要憑證。用於調用騰訊雲 API 時生成簽名。僅支持在創建時查看,請及時保存 SecretKey。 |
TcSecretKey | SecretKey | 同上 |
TcSdkAppId | SDK AppID | 語音應用的唯一標識,調用語音 API 接口時,需要提供該參數。 |
TcTplId | 語音模板 ID | 控制台審核通過的模板 ID。 |
TcEndpoint | 騰訊語音就近地域接入域名 “vms.tencentcloudapi.com” | 指定地域接入參考 服務地址。 |
TcRegion | Region | 地域參數,用來標識希望操作哪個地域的數據。接口 Region 字段的可選值如下:華北地區(北京)ap-beijing; 華南地區(廣州)ap-guangzhou |
使用配置示例
1. 創建 SecretId & SecretKey
在騰訊雲控制台 API 密鑰管理中新建密鑰。
注意:新建的密鑰只在創建時提供 SecretKey,後續不可再進行查詢,請保存好 SecretKey。
2. 創建 SDK AppID
在騰訊雲控制台應用管理 —> 應用列表 —> 創建應用。創建好後就可以看到 SDKAppID。
3. 創建語音模板獲取語音模板 ID
在騰訊雲控制台應用管理 —> 語音模板 —> 創建語音模板。
注意:
● 選擇對應應用再創建語音模板。
● 語音模板中不支持任何變量。
● 創建完成語音模板需要等待騰訊雲審核,請參考騰訊雲審核規範。
填寫模板內容為你希望語音播報的內容。
常規模板(無變量使用)
變量語音模板
在創建語音模板時,模板內容使用變量 {1},這樣在告警通知時,{1} 會替換為 tx-voice 通知模板內容。
創建完成後就可以在頁面看到語音模板 ID,語音模板必須審核通過才能使用。
4. 在 FlashCat 填寫騰訊雲語音配置
根據上面在騰訊雲獲得的參數值填寫到對應字段中即可。
注意:
TcEndpoint:vms.tencentcloudapi.com 是騰訊語音就近地域接入域名,如指定地域接入參考 服務地址。
TcRegion:地域參數,可選值 ap-beijing 或 ap-guangzhou;
5. 配置通知模板
在系統設置通知模板 —> 選擇 tx-voice 模板,在 tx-voice 模板中可以自定義告警展示信息。如果在語音模板中使用變量,那麼 {1}
會被替換為模板中 S{{.Severity}}{{if .IsRecovered}}Recovered{{else}}Triggered{{end}}{{.RuleName}}
的變量內容。通知模板編寫可以參考此文檔 https://flashcat.cloud/docs/content/flashcat-monitor/nightingale-v6/faq/go-template/
6. 配置騰訊雲語音
- 在通知媒介中勾選
tx-voice
- 選擇告警接收組(組內成員必須填寫正確手機聯繫方式才能接收到短信通知)
在人員組織 —> 用戶管理 配置用戶手機號碼。
日誌排錯
如果無法正常發送消息,可以在 FlashCat 的 ERROR.log 中查看相關報錯信息,過濾關鍵詞 sender
。