1. 概述
1.1 版本
維運平台版本 | 功能變更 |
---|---|
V1.5.5 | - |
V1.7.0 | 警報方式頁面視覺優化,功能無變更 |
V1.10.0 | 新增支援警報類型:企業微信機器人、釘釘機器人、飛書機器人 |
V2.3.0 | 優化警報信箱寄件人「登入名稱」配置,預設與寄件人地址聯動 |
1.2 應用場景
在應用程式出現高負載、當機風險、磁碟空間不足等重要事件時,需要確定管理者即時收到關鍵的警報資訊,以便能夠快速回應和處理問題,進而最大限度地減少應用程式的中斷時間和減輕潛在的損失。
支援透過多種方式通知管理者:信箱、webhook、企業微信、企業微信機器人、釘釘機器人、飛書機器人。
注:本文設定的所有警報方式,對維運平台中的所有專案生效,暫不支援對指定專案配置警報通知物件。
2. 信箱警報
如需使用信箱警報,需配置寄件人和收件人。
2.1 配置寄件人
發郵件,需要有一個寄件人,否則傳送動作無法完成。
1)管理者登入「維運平台」,點選「警報中心>警報通知設定」。
2)點選「新增寄件人」,配置寄件人賬戶,點選「確定」。
注1:寄件人信箱類型不同,配置步驟可能不完全相同,具體請參見:信箱。
注2:「登入名稱」配置項,即為寄件人姓名,預設值為寄件人地址,手動更改後不再與寄件人地址聯動調整。
對於通用信箱(例如QQ、網易等),登入名與信箱相同,一般無需配置。
對於企業自建信箱伺服器,該配置需與內部登入帳號相同。
注3:配置完成後,請點選「傳送測試郵件」,確定信箱可使用。
3)設定「系統預設寄件人」。
2.2 配置警報收件人
發郵件,需要配置收件人,接收警報資訊。
1)管理者登入「維運平台」,點選「警報中心>警報通知設定」,點選「新增警報物件」。
2)設定警報類型為「email」,設定警報物件名稱和收件人地址,點選「確定」,點選「儲存」。如下圖所示:
注:配置完成後,請點選「傳送測試郵件」,確定信箱可使用。
2.3 效果預覽
當FineOps監測到專案觸發警報任務後,傳送郵件給收件人,如下圖所示:
3. webhook警報
3.1 配置警報物件
1)準備 Webhook 的 URL
管理者需要先準備好一個 Webhook 的 url,當有新資料的警報訊息時,維運平台會往這個 url 發資料,提醒使用者警報。
由於各人訴求不同,帆軟不提供 Webhook 的 url 搭建獲取步驟,請自行準備。
2)新增警報物件
管理者登入「維運平台」,點選「警報中心>警報通知設定」,點選「新增警報物件」。
設定警報類型為「webhook」,設定警報物件名稱和 Webhook 的相關資訊。
注:若 Webhook 的API存在驗證,需要配置帳號及密碼。
3)傳送測試資訊
點選「傳送測試郵件」,存取 Webhook 的 url,確定收到測試通知,確定Webhook可使用。
4)儲存
點選「確定」,即可完成webhook警報物件的配置。
3.2 效果預覽
當FineOps監測到專案觸發警報任務後,傳送訊息到 Webhook 的 url,如下圖所示:
警報推播頻率:
首次觸發某專案的某警報項時,即刻推播給Webhook。
如不即時處理該專案的該警報項,此後每隔一小時再推播一次。
警報推播頻率不支援自訂。
注:此處附上一個警報內容範例。僅供參考:
點選展開更多 |
{ "receiver": "fine_channel", "status": "firing", "alerts": [ { "status": "firing", "labels": { "alertname": "系統當機警報——無迴應", "instance": "192.168.101.82:8085", "job": "app_schedule__fb2ef781-9133-464c-bc65-90ad005929e6", "source": "default", "target_belong_app": "fr11" }, "annotations": { "description": "專案:fr11 \n應用節點:192.168.101.82:8085 \n異常項:應用節點發生當機 \n處理建議:請儘快重啟並排查當機問題,避免影響系統使用" }, "startsAt": "2023-08-24T06:38:57.192Z", "endsAt": "0001-01-01T00:00:00Z", "generatorURL": "http://42956542b88e:9090/graph?g0.expr=up%7Bjob%3D~%22.%2Aapp_schedule.%2A%22%7D+%3D%3D+0&g0.tab=1", "fingerprint": "63131302d98ec860" }, { "status": "firing", "labels": { "alertname": "負載過高警報——節點無迴應", "instance": "192.168.101.82:8085", "job": "app_schedule__fb2ef781-9133-464c-bc65-90ad005929e6", "source": "default", "target_belong_app": "fr11" }, "annotations": { "description": "專案:fr11 \n應用節點:192.168.101.82:8085 \n異常項:應用節點迴應異常 \n處理建議:請存取應用節點檢查其是否存在異常或即時重啟異常節點,避免影響系統使用" }, "startsAt": "2023-08-24T06:37:27.192Z", "endsAt": "0001-01-01T00:00:00Z", "generatorURL": "http://42956542b88e:9090/graph?g0.expr=up%7Bjob%3D~%22.%2Aapp_schedule.%2A%22%7D+%3D%3D+0&g0.tab=1", "fingerprint": "8b12f8d538c68f97" }, { "status": "firing", "labels": { "ClusterID": "2076660091", "ClusterNodeID": "5e971cea-8525-73a6-65cf-9efd4c0cb1c5", "ClusterNodeName": "12", "IP": "192.168.5.12", "Port": "8085", "ServletURL": "/webroot/tomcat", "alertname": "工程磁碟空間預警", "instance": "192.168.5.12:8085", "job": "app_schedule__fb2ef781-9133-464c-bc65-90ad005929e6", "source": "default", "target_belong_app": "fr11" }, "annotations": { "description": "專案:fr11 \n應用節點:192.168.5.12:8085 \n異常項:工程磁碟剩餘空間不足15% \n處理建議:當前伺服器工程磁碟剩餘空間不足15%,請即時清理磁碟或增加磁碟空間" }, "startsAt": "2023-08-24T07:19:57.192Z", "endsAt": "0001-01-01T00:00:00Z", "generatorURL": "http://42956542b88e:9090/graph?g0.expr=disk_use_project+%2F+disk_space_project+%3E+0.85&g0.tab=1", "fingerprint": "e5b6ca5c09f2dbcb" } ], "groupLabels": {}, "commonLabels": { "job": "app_schedule__fb2ef781-9133-464c-bc65-90ad005929e6", "source": "default", "target_belong_app": "fr11" }, "commonAnnotations": {}, "externalURL": "http://3ef45ec83ecc:9093", "version": "4", "groupKey": "{}:{}", "truncatedAlerts": 0 } |
4. 企業微信警報
支援透過企業微信傳送警報通知。
管理者需要先在企業微信端建立一個用於傳送警報的應用,並獲得相關應用參數,方可進入維運平台配置警報物件。
4.1 微信後台建立應用
企業微信管理者登入 企業微信管理後台,在「應用管理」Tab 下點選「建立應用」,如下圖所示:
上傳應用 logo,填寫應用名稱,應用介紹選填,設定可見範圍,設定完成後,點選「建立應用」,如下圖所示:
建議將可見範圍設定為部門/標籤。若「可見範圍」是單獨的微信使用者,那麼在平台「微信管理」的「成員管理」Tab下會看不到使用者資訊。
4.2 獲取微信參數
管理者需要在企業微信後台獲取以下參數資料。
參數名 | 含義 |
---|---|
CorpID | 企業ID |
應用AgentID | 用於傳送警報的應用的AgentID |
應用Secret | 用於傳送警報的應用的Secret |
接收物件 | 用於接收警報的部門或使用者ID,請確定該部門/使用者在上文設定的應用可見範圍內 |
1)CorpID
企業微信管理者登入 企業微信管理後台,在「我的企業」Tab 下,點選「企業資訊」,即可獲取CorpID。
2)應用AgentID和應用Secret
企業微信管理者登入 企業微信管理後台,在「應用管理」Tab 下,點選剛剛建立的用於傳送警報資訊的應用,即可獲取應用AgentID和應用Secret。如下圖所示:
3)接收物件的部門或使用者ID
企業微信管理者登入 企業微信管理後台,在「通訊錄」Tab 下。
左側可選擇部門,點選後方的按鈕,即可查看部門ID
點選單個使用者的資訊,即可在資訊詳情頁查看使用者ID
請確定該部門/使用者在上文設定的應用可見範圍內。
4.3 配置警報物件
管理者登入「維運平台」,點選「警報中心>警報通知設定」,點選「新增警報物件」。
設定警報類型為「企業微信」,填寫4.2節獲取的相關微信參數資訊,點選「確定」。如下圖所示:
注1:接收物件僅支援設定單個使用者/單個部門。請確定該部門/使用者在上文設定的傳送警報資訊的應用可見範圍內。
注2:若部門ID/使用者ID為空,則警報資訊將推播給應用可見範圍內的全部使用者。
注3:配置完成後,請點選「傳送測試郵件」,確定信箱可使用。
注4:警報推播頻率:
首次觸發某專案的某警報項時,即刻推播給接收人。
如不即時處理該專案的該警報項,此後每隔一小時再推播一次。
警報推播頻率不支援自訂。
5. 企業微信機器人警報
支援透過企業微信機器人傳送警報通知到企業微信群。
管理者需要先在企業微信群中建立並新增一個用於傳送警報的機器人,並獲得相關Webhook地址,方可進入維運平台配置警報物件。
5.1 微信群建立機器人
1)開啟需要推播訊息的企業微信群中,點選「設定>新增群機器人>新增機器人」。
2)點選「建立立一個機器人」,設定機器人頭像和名稱,點選「新增機器人」,即可將機器人新增到企業微信群中。
5.2 獲取Webhook地址
在微信群中,點選查看機器人資訊,即可獲取Webhook地址。如下圖所示:
5.3 配置警報物件
管理者登入「維運平台」,點選「警報中心>警報通知設定」,點選「新增警報物件」。
自訂警報物件名稱,設定警報類型為「企業微信機器人」,填寫5.2節獲取的Webhook地址,點選「確定」。如下圖所示:
5.4 效果預覽
當FineOps監測到專案觸發警報任務後,機器人會傳送訊息到所在的企業微信群中,如下圖所示:
6. 釘釘機器人警報
支援透過釘釘機器人傳送警報通知到釘釘群。
管理者需要先在釘釘群中建立並新增一個用於傳送警報的機器人,並獲得相關Webhook地址,方可進入維運平台配置警報物件。
6.1 釘釘群建立機器人
1)開啟需要推播訊息的釘釘群中,點選「群設定>機器人>新增機器人>自訂」。
2)點選「新增」,設定機器人資訊,可開啟安全設定中的「加簽」,即金鑰功能。點選「完成」,即可將機器人新增到釘釘群中。
注:安全設定中,可以自行選擇是否設定「加簽」。
如使用「自訂關鍵詞」,若警報資訊中不包含該關鍵詞,會導致訊息接收不到。
6.2 獲取webhook地址
在釘釘群中,點選「群設定>機器人」,查看機器人資訊,即可獲取Webhook地址和加簽資訊。如下圖所示:
6.3 配置警報物件
管理者登入「維運平台」,點選「警報中心>警報通知設定」,點選「新增警報物件」。
自訂警報物件名稱,設定警報類型為「釘釘機器人」,填寫6.2節獲取的Webhook地址和加簽資訊(如未設定加簽,可不填寫),點選「確定」。如下圖所示:
7. 飛書機器人
支援透過飛書機器人傳送警報通知到飛書群。
管理者需要先飛書群中建立並新增一個用於傳送警報的機器人,並獲得相關Webhook地址,方可進入維運平台配置警報物件。
7.1 飛書群建立機器人
1)開啟需要推播訊息的飛書群中,點選「設定>群機器人>新增機器人」。
2)選擇「自訂機器人」,設定機器人頭像、名稱和描述,點選「新增」。
3)支援設定「簽章校驗」等安全設定,點選「完成」,即可將機器人新增到飛書群中。
7.2 獲取Webhook地址
在飛書群中,點選「設定>群機器人」。查看機器人資訊,即可獲取Webhook地址和簽章金鑰。如下圖所示:
7.3 配置警報物件
管理者登入「維運平台」,點選「警報中心>警報通知設定」,點選「新增警報物件」。
自訂警報物件名稱,設定警報類型為「飛書機器人」,填寫7.2節獲取的Webhook地址和簽章金鑰(如未設定簽章校驗,可不填寫),點選「確定」。如下圖所示:
7.4 效果預覽
當FineOps監測到專案觸發警報任務後,機器人會傳送訊息到所在的飛書群中,如下圖所示: