API 監(jiān)控報告是一種監(jiān)測 API 異常的工具。在 API 管理中揽趾,查看 API 異常監(jiān)控的監(jiān)控報告台汇,是 Eolink Apikit 常用的功能。Eolink Apikit 的監(jiān)控報告有 3種:
- 單接口監(jiān)控報告
- 流程監(jiān)控報告
- 項目監(jiān)控報告
1篱瞎、單接口監(jiān)控報告
單接口監(jiān)控報告通常關(guān)注單個應(yīng)用程序接口或系統(tǒng)的性能和可用性苟呐。它包括有關(guān)接口的指標(biāo),如響應(yīng)時間俐筋、錯誤率牵素、吞吐量等。僅關(guān)注一個接口澄者,不包括整個流程或項目笆呆。單接口監(jiān)控報告有助于及時發(fā)現(xiàn)和解決與特定接口相關(guān)的問題,以確保其正常運行粱挡。
1. API 綜合監(jiān)控報告
你可以在流程的綜合報告頁中看到當(dāng)前流程在選定的時間段內(nèi)的整體監(jiān)控概況赠幕,可以點擊不同的監(jiān)控節(jié)點來切換不同監(jiān)控節(jié)點發(fā)出的監(jiān)控信息,監(jiān)控信息包含以下內(nèi)容包括:
- 所有監(jiān)控節(jié)點(地區(qū))的監(jiān)控狀態(tài)
- 指定監(jiān)控節(jié)點(地區(qū))的監(jiān)控狀態(tài)
- 流程實時的監(jiān)控狀態(tài)
- 流程監(jiān)控次數(shù)及異常原因統(tǒng)計
- 流程正確率趨勢圖
- 流程運行時間統(tǒng)計
2. 選擇監(jiān)控報告的時間段
項目監(jiān)控報告默認(rèn)顯示最新的實時報告询筏,實時報告會顯示項目最新的一次監(jiān)控統(tǒng)計榕堰。如果你希望查看一段時間內(nèi)的報告,可以選擇今天嫌套、3天逆屡、7天或者是其他自定義的時間段圾旨。
注意,選擇實時報告時康二,正確率趨勢圖表會顯示今天的數(shù)據(jù),因為正確率趨勢無法僅根據(jù)最新的一次監(jiān)控情況計算得出勇蝙,必須顯示一段時間內(nèi)的數(shù)據(jù)才能夠繪制趨勢圖沫勿。
3. 選擇監(jiān)控報告的節(jié)點(地區(qū))范圍
監(jiān)控報告可以選擇查看什么監(jiān)控節(jié)點的報告數(shù)據(jù),項目簡況報告默認(rèn)選擇查看綜合統(tǒng)計味混,也就是所有節(jié)點數(shù)據(jù)的匯總報告产雹。
如果你希望僅查看某個監(jiān)控節(jié)點的數(shù)據(jù),點擊相應(yīng)的節(jié)點名稱即可翁锡。節(jié)點名稱前面會有綠色或紅色的圓點蔓挖,表示在當(dāng)前選中的時間段內(nèi),該節(jié)點是否有異常的歷史記錄馆衔,如果出現(xiàn)過API或者流程監(jiān)控異常瘟判,則會顯示紅色圓點,提示你查看相關(guān)的監(jiān)控告警列表角溃。
4. 流程實時監(jiān)控狀態(tài)
當(dāng)前流程最新一次監(jiān)控的結(jié)果拷获,顯示流程當(dāng)前為正常情況還是異常情況的API數(shù)量。
5. 流程監(jiān)控次數(shù)及異常原因統(tǒng)計
圖表會顯示在選中時間段內(nèi)的流程的正確次數(shù)以及異常次數(shù)减细。
6. 流程正確率趨勢圖
流程正確率趨勢圖會顯示在選中時間段內(nèi)的流程正確率趨勢匆瓜,正確率趨勢最小統(tǒng)計單位是小時,也就是一天最多會顯示24個統(tǒng)計點未蝌;當(dāng)選擇的時間段大于1天時驮吱,正確率的統(tǒng)計點為一天,即一天統(tǒng)計一次正確率萧吠。
7. 流程運行時間統(tǒng)計
流程的運行時間圖表會顯示流程從開啟監(jiān)控以來左冬,維持正確運行的時長以及錯誤運行的時長,可以對流程的質(zhì)量有直觀體現(xiàn)纸型。
8. 實時監(jiān)控報告
進入 API 的監(jiān)控詳情頁又碌,選擇時間段為 實時,此時頁面會顯示該 API 最新一次的監(jiān)控報告绊袋,可以看到API最新一次請求的各階段時間分析:
- 總時間
- 重定向時間
- 首字節(jié)時間
- DNS解析時間
- TCP建立連接時間
- 握手時間
- 等待首字節(jié)時間
還可以看到請求完整的請求內(nèi)容和返回內(nèi)容:
9. 詳細(xì)監(jiān)控日志
進入 API 監(jiān)控詳情頁毕匀,點擊頁面上方的詳細(xì)監(jiān)控日志標(biāo)簽。進入監(jiān)控日志標(biāo)簽頁后癌别,你可以查看選擇需要查看的時間段皂岔、日志所屬的節(jié)點。
在日志列表中展姐,你可以看到選定時間段和節(jié)點內(nèi)的每一次監(jiān)控請求躁垛。你可以在列表中篩選只查看異常的日志剖毯,點擊查看報告按鈕可以查看異常日志的詳細(xì)請求內(nèi)容。
注意教馆,系統(tǒng)僅會記錄異常的監(jiān)控日志逊谋,并且線上產(chǎn)品的異常監(jiān)控日志最長保存日期為15天。
2土铺、流程監(jiān)控報告
流程監(jiān)控報告關(guān)注業(yè)務(wù)流程中涉及的多個接口胶滋、系統(tǒng)或環(huán)節(jié)。它包括有關(guān)整個流程的指標(biāo)悲敷,如流程持續(xù)時間究恤、各個步驟的完成情況、流程吞吐量等后德。覆蓋整個業(yè)務(wù)流程部宿,而不僅僅是單個接口。流程監(jiān)控報告幫助組織了解業(yè)務(wù)流程的整體性能瓢湃,找出流程中的瓶頸或問題理张,以便改進流程效率和質(zhì)量。
1. 實時監(jiān)控報告
進入流程監(jiān)控詳情頁绵患,選擇時間段為 實時涯穷,此時頁面會顯示該流程最新一次的監(jiān)控報告,包含以下內(nèi)容:
- API 基本信息:API 請求地址藏雏、監(jiān)控狀態(tài)拷况、監(jiān)控節(jié)點IP地址、監(jiān)控狀態(tài)等掘殴;
- 流程的監(jiān)控步驟以及每一步的監(jiān)控狀態(tài)赚瘦。
你可以點擊監(jiān)控步驟來查看詳細(xì)的監(jiān)控內(nèi)容:
2. 詳細(xì)監(jiān)控日志
進入流程監(jiān)控詳情頁,點擊頁面上方的詳細(xì)監(jiān)控日志標(biāo)簽奏寨。進入監(jiān)控日志標(biāo)簽頁后起意,你可以查看選擇需要查看的時間段、日志所屬的節(jié)點病瞳。
在日志列表中揽咕,你可以看到選定時間段和節(jié)點內(nèi)的每一次監(jiān)控請求。你可以在列表中篩選只查看異常的日志套菜,點擊查看報告按鈕可以查看異常日志的詳細(xì)請求內(nèi)容亲善。
注意,系統(tǒng)僅會記錄異常的監(jiān)控日志逗柴,并且線上產(chǎn)品的異常監(jiān)控日志最長保存日期為15天蛹头。
3、項目監(jiān)控報告
項目監(jiān)控報告關(guān)注整個項目的狀態(tài)和進展情況。它包括項目的關(guān)鍵指標(biāo)渣蜗、計劃與實際的對比屠尊、風(fēng)險和問題的跟蹤等。涵蓋項目的各個方面耕拷,包括范圍讼昆、時間、成本骚烧、質(zhì)量和風(fēng)險等浸赫。項目監(jiān)控報告有助于項目管理人員和利益相關(guān)者了解項目的健康狀況,及時采取措施以確保項目按計劃推進止潘,減少風(fēng)險掺炭,確保項目成功完成辫诅。
你可以在項目概況頁中看到當(dāng)前項目在選定的時間段內(nèi)的整體監(jiān)控概況凭戴,包括:
- 所有監(jiān)控節(jié)點(地區(qū))的監(jiān)控狀態(tài)
- 指定監(jiān)控節(jié)點(地區(qū))的監(jiān)控狀態(tài)
- API 監(jiān)控狀態(tài)統(tǒng)計
- API 監(jiān)控次數(shù)及異常原因統(tǒng)計
- API 正確率趨勢圖
- 流程監(jiān)控狀態(tài)統(tǒng)計
- 流程監(jiān)控次數(shù)以及異常次數(shù)比例
- 流程正確率趨勢圖
- 項目正常運行時間統(tǒng)計
- 項目內(nèi)異常的 API 列表
- 項目內(nèi)異常的流程列表
1. 選擇監(jiān)控報告的時間段
項目監(jiān)控報告默認(rèn)顯示最新的實時報告,實時報告會顯示項目最新的一次監(jiān)控統(tǒng)計炕矮。如果你希望查看一段時間內(nèi)的報告么夫,可以選擇今天、3天肤视、7天或者是其他自定義的時間段档痪。
注意,選擇實時報告時邢滑,正確率趨勢圖表會顯示今天的數(shù)據(jù)腐螟,因為正確率趨勢無法僅根據(jù)最新的一次監(jiān)控情況計算得出,必須顯示一段時間內(nèi)的數(shù)據(jù)才能夠繪制趨勢圖困后。
2. 選擇監(jiān)控報告的節(jié)點(地區(qū))范圍
監(jiān)控報告可以選擇查看什么監(jiān)控節(jié)點的報告數(shù)據(jù)乐纸,項目簡況報告默認(rèn)選擇查看綜合統(tǒng)計,也就是所有節(jié)點數(shù)據(jù)的匯總報告摇予。
如果你希望僅查看某個監(jiān)控節(jié)點的數(shù)據(jù)汽绢,點擊相應(yīng)的節(jié)點名稱即可。節(jié)點名稱前面會有綠色或紅色的圓點侧戴,表示在當(dāng)前選中的時間段內(nèi)宁昭,該節(jié)點是否有異常的歷史記錄,如果出現(xiàn)過API或者流程監(jiān)控異常酗宋,則會顯示紅色圓點积仗,提示你查看相關(guān)的監(jiān)控告警列表。
3. API 監(jiān)控狀態(tài)統(tǒng)計
API 監(jiān)控狀態(tài)圖表會顯示當(dāng)前項目內(nèi)的 API 總數(shù)蜕猫、監(jiān)控中的 API 數(shù)量斥扛、正常API、異常API以及整體API正確率數(shù)據(jù)。
如果當(dāng)前選中的時間段內(nèi)有API出現(xiàn)了異常稀颁,則圖表顯示API監(jiān)控狀態(tài)為異常芬失,否則為正常。
4. API 監(jiān)控次數(shù)及異常原因統(tǒng)計
圖表會顯示在選中時間段內(nèi)的請求次數(shù)匾灶、各種錯誤原因的次數(shù)棱烂。你可以通過這個圖表了解出現(xiàn)最多的異常原因來進行針對性排查。
5. API 正確率趨勢圖
API 正確率趨勢圖會顯示在選中時間段內(nèi)的API正確率趨勢阶女,正確率趨勢最小統(tǒng)計單位是小時颊糜,也就是一天最多會顯示24個統(tǒng)計點;當(dāng)選擇的時間段大于1天時秃踩,正確率的統(tǒng)計點為一天衬鱼,即一天統(tǒng)計一次正確率。
6. 流程監(jiān)控狀態(tài)統(tǒng)計
流程監(jiān)控狀態(tài)圖表會顯示當(dāng)前項目內(nèi)的API流程總數(shù)憔杨、監(jiān)控中的流程數(shù)量鸟赫、正常流程、異常流程以及整體流程正確率數(shù)據(jù)消别。
如果當(dāng)前選中的時間段內(nèi)有流程出現(xiàn)了異常抛蚤,則圖表顯示監(jiān)控狀態(tài)為異常,否則為正常寻狂。
7. 流程監(jiān)控次數(shù)以及異常次數(shù)比例
圖表會顯示在選中時間段內(nèi)的請求次數(shù)岁经、錯誤次數(shù)。
8. 流程正確率趨勢圖
流程正確率趨勢圖會顯示在選中時間段內(nèi)的流程正確率趨勢蛇券,正確率趨勢最小統(tǒng)計單位是小時缀壤,也就是一天最多會顯示24個統(tǒng)計點;當(dāng)選擇的時間段大于1天時纠亚,正確率的統(tǒng)計點為一天塘慕,即一天統(tǒng)計一次正確率。
9. 項目正常運行時間統(tǒng)計
項目運行時間統(tǒng)計圖表會統(tǒng)計在選定的時間段內(nèi)項目的累計正常時間以及累計異常時間菜枷,并且會將每段正常苍糠、異常時間進行統(tǒng)計,方便你了解項目在什么時間段開始出現(xiàn)異常啤誊,以及異常的持續(xù)時間等岳瞭。
如下圖表示項目在2020年2月23日凌晨0點起至2020年2月23日晚20點32分54秒處于異常狀態(tài),隨后項目恢復(fù)正常蚊锹。
10. 項目內(nèi)異常的 API 列表
系統(tǒng)會統(tǒng)計在選定時間內(nèi)出現(xiàn)過異常的 API瞳筏,你可以通過異常 API 列表快速定位異常的 API,并且根據(jù)異常次數(shù)排序來找到異常次數(shù)最多的 API牡昆。
點擊列表項的更多消息按鈕姚炕,可以進入該 API 的監(jiān)控詳情頁摊欠。
11. 項目內(nèi)異常的流程列表
系統(tǒng)會統(tǒng)計在選定時間內(nèi)出現(xiàn)過異常的流程,你可以通過異常流程列表快速定位異常的流程柱宦,并且根據(jù)異常次數(shù)排序來找到異常次數(shù)最多的流程些椒。
點擊列表項的更多消息按鈕,可以進入該流程的監(jiān)控詳情頁掸刊。