標準集成
本文介紹如何基于產(chǎn)品官方自定義的標準集成方案進行對接。
簡介
標準集成是運維事件中心官方提供的標準監(jiān)控集成API,支持用戶自定義場景接入,將相關異常告警以標準集成數(shù)據(jù)格式進行推送即可,從而通過流轉規(guī)則觸發(fā)報警或事件實現(xiàn)統(tǒng)一的運維管理;查看以下集成步驟完成集成接入。
如何實現(xiàn)標準集成接入?
步驟1:找到標準集成監(jiān)控源
進入運維事件中心-集成中心-集成配置菜單找到標準集成監(jiān)控源,進入標準集成的新增集成頁面查看集成步驟完成集成接入。
步驟2:配置報警推送URL地址
在控制臺獲取含集成密鑰的推送URL地址。
https://public-alert.aliyuncs.com/event/standard/{集成密鑰}
以上URL中的集成密鑰為標準集成的集成密鑰。
步驟3:按照標準集成數(shù)據(jù)格式推送告警記錄
將自定義場景的異常告警記錄,按照標準集成數(shù)據(jù)格式推送至URL地址。
步驟4:確認集成
完成以上配置后點擊集成密鑰下的「確認集成」按鈕完成集成配置。
步驟5:驗證集成是否成功
在標準集成監(jiān)控側配置告警、訂閱規(guī)則并觸發(fā)報警后,前往集成配置頁面查看到標準集成監(jiān)控源狀態(tài)為“已接收”,則說明已集成成功。
標準集成數(shù)據(jù)格式
標準集成目前僅支持POST方式集成,后續(xù)將逐步開放Get、Push等集成接入方式。
推送的日志請務必按以下JSON格式配置推送,確保所有告警字段都能通過流轉規(guī)則完成配置;查看ECS上通過腳本進行主動推送告警記錄至標準集成最佳實踐完成告警接入。
{
"summary":"Cpu_util at 85.16% on machine 112.11.123.11",
"priority":"P1",
"name":"Cpu 使用超額預警",
"timestamp":"2021-07-17T08:42:58.315+0000",
"region":"shanghai",
"source":"112.11.123.11",
"application":"zheda/mozi",
"group":"線上",
"class":"Load",
"details":{
"freeSpace":"1%",
"pingTime":"1500ms",
"loadAvg":"0.75"
},
"tags":"{}"
}
字段說明如下:
字段 | 日志字段 | 描述 | 是否必要 | 字符類型 | 樣例 |
告警摘要 | summary | Event的報警記錄摘要 | 必要 | 字符串(String) | 如:" Cpu_util at 85.16% on machine 112.11.123.11" 格式:{指標} at {指標值}on{告警對象} |
優(yōu)先級 | priority | Event 優(yōu)先等級 | 必要 | 字符串(String) | 如:{P1/P2/P3/P4} |
告警名稱 | name | Event名稱(監(jiān)控項的名稱) | 非必要 | 字符串(String) | 如:Cpu_usage ; 使用超額預警 |
告警時間 | timestamp | 時間戳 | 必要 | 字符串(String) | 如:'2018-04-08T00:00:00Z' |
告警地區(qū) | region | 不同地域的產(chǎn)品字段 | 非必要 | 字符串(String) | 如:shang hai / zhe jiang … |
告警對象 | source | Event 告警觸發(fā)對象,如主機ID或主機名 | 必要 | 字符串(String) | 如:machine 112.11.XXX.XX(hostID)or {hostname…} |
所屬分組 | group | 告警對象的分組或集群 | 非必要 | 字符串(String) | 如:日常/預發(fā)/線上等分組 |
所屬應用 | application | 受影響的應用系統(tǒng) | 非必要 | 字符串(String) | 如:Zheda/Mozi… |
告警分類 | class | Event對應的指標類型 | 非必要 | 字符串(String) | 如:CPU / Load / DiskIO … |
告警內(nèi)容 | details | Event 的內(nèi)容詳情,如:content | 必要 | 字符串(String) | 如:{"free space": “1%”, "ping time": "1500ms", "load avg": 0.75 } |
擴展字段 | tags | 擴展字段 | 非必要 | 字符串(String) | 支持用戶自定義擴展字段 |