開發常用的 3種 API 監控報告- Eolink Apikit

API小達人發表於2023-11-09

API 監控報告是一種監測 API 異常的工具。在 API 管理中,檢視 API 異常監控的監控報告,是 Eolink Apikit 常用的功能。Eolink Apikit 的監控報告有 3種:

  • 單介面監控報告
  • 流程監控報告
  • 專案監控報告


1、單介面監控報告

單介面監控報告通常關注單個應用程式介面或系統的效能和可用性。它包括有關介面的指標,如響應時間、錯誤率、吞吐量等。僅關注一個介面,不包括整個流程或專案。單介面監控報告有助於及時發現和解決與特定介面相關的問題,以確保其正常執行。

1. API 綜合監控報告

你可以在流程的綜合報告頁中看到當前流程在選定的時間段內的整體監控概況,可以點選不同的監控節點來切換不同監控節點發出的監控資訊,監控資訊包含以下內容包括:

  • 所有監控節點(地區)的監控狀態
  • 指定監控節點(地區)的監控狀態
  • 流程實時的監控狀態
  • 流程監控次數及異常原因統計
  • 流程正確率趨勢圖
  • 流程執行時間統計



2. 選擇監控報告的時間段

專案監控報告預設顯示最新的實時報告,實時報告會顯示專案最新的一次監控統計。如果你希望檢視一段時間內的報告,可以選擇今天、3天、7天或者是其他自定義的時間段。

注意,選擇實時報告時,正確率趨勢圖表會顯示今天的資料,因為正確率趨勢無法僅根據最新的一次監控情況計算得出,必須顯示一段時間內的資料才能夠繪製趨勢圖。



3. 選擇監控報告的節點(地區)範圍

監控報告可以選擇檢視什麼監控節點的報告資料,專案簡況報告預設選擇檢視綜合統計,也就是所有節點資料的彙總報告。

如果你希望僅檢視某個監控節點的資料,點選相應的節點名稱即可。節點名稱前面會有綠色或紅色的圓點,表示在當前選中的時間段內,該節點是否有異常的歷史記錄,如果出現過API或者流程監控異常,則會顯示紅色圓點,提示你檢視相關的監控告警列表。


4. 流程實時監控狀態

當前流程最新一次監控的結果,顯示流程當前為正常情況還是異常情況的API數量。


5. 流程監控次數及異常原因統計

圖表會顯示在選中時間段內的流程的正確次數以及異常次數。


6. 流程正確率趨勢圖

流程正確率趨勢圖會顯示在選中時間段內的流程正確率趨勢,正確率趨勢最小統計單位是小時,也就是一天最多會顯示24個統計點;當選擇的時間段大於1天時,正確率的統計點為一天,即一天統計一次正確率。


7. 流程執行時間統計

流程的執行時間圖表會顯示流程從開啟監控以來,維持正確執行的時長以及錯誤執行的時長,可以對流程的質量有直觀體現。


8. 實時監控報告

進入 API 的監控詳情頁,選擇時間段為  實時,此時頁面會顯示該 API 最新一次的監控報告,可以看到API最新一次請求的各階段時間分析:

  • 總時間
  • 重定向時間
  • 首位元組時間
  • DNS解析時間
  • TCP建立連線時間
  • 握手時間
  • 等待首位元組時間

還可以看到請求完整的請求內容和返回內容:


9. 詳細監控日誌

進入 API 監控詳情頁,點選頁面上方的詳細監控日誌標籤。進入監控日誌標籤頁後,你可以檢視選擇需要檢視的時間段、日誌所屬的節點。

在日誌列表中,你可以看到選定時間段和節點內的每一次監控請求。你可以在列表中篩選只檢視異常的日誌,點選檢視報告按鈕可以檢視異常日誌的詳細請求內容。

注意,系統僅會記錄異常的監控日誌,並且線上產品的異常監控日誌最長儲存日期為15天。



2、流程監控報告

流程監控報告關注業務流程中涉及的多個介面、系統或環節。它包括有關整個流程的指標,如流程持續時間、各個步驟的完成情況、流程吞吐量等。覆蓋整個業務流程,而不僅僅是單個介面。流程監控報告幫助組織瞭解業務流程的整體效能,找出流程中的瓶頸或問題,以便改進流程效率和質量。

1. 實時監控報告

進入流程監控詳情頁,選擇時間段為  實時,此時頁面會顯示該流程最新一次的監控報告,包含以下內容:

  • API 基本資訊:API 請求地址、監控狀態、監控節點IP地址、監控狀態等;
  • 流程的監控步驟以及每一步的監控狀態。

你可以點選監控步驟來檢視詳細的監控內容:


2. 詳細監控日誌

進入流程監控詳情頁,點選頁面上方的詳細監控日誌標籤。進入監控日誌標籤頁後,你可以檢視選擇需要檢視的時間段、日誌所屬的節點。

在日誌列表中,你可以看到選定時間段和節點內的每一次監控請求。你可以在列表中篩選只檢視異常的日誌,點選檢視報告按鈕可以檢視異常日誌的詳細請求內容。

注意,系統僅會記錄異常的監控日誌,並且線上產品的異常監控日誌最長儲存日期為15天。



3、專案監控報告

專案監控報告關注整個專案的狀態和進展情況。它包括專案的關鍵指標、計劃與實際的對比、風險和問題的跟蹤等。涵蓋專案的各個方面,包括範圍、時間、成本、質量和風險等。專案監控報告有助於專案管理人員和利益相關者瞭解專案的健康狀況,及時採取措施以確保專案按計劃推進,減少風險,確保專案成功完成。

你可以在專案概況頁中看到當前專案在選定的時間段內的整體監控概況,包括:

  • 所有監控節點(地區)的監控狀態
  • 指定監控節點(地區)的監控狀態
  • API 監控狀態統計
  • API 監控次數及異常原因統計
  • API 正確率趨勢圖
  • 流程監控狀態統計
  • 流程監控次數以及異常次數比例
  • 流程正確率趨勢圖
  • 專案正常執行時間統計
  • 專案內異常的 API 列表
  • 專案內異常的流程列表


1. 選擇監控報告的時間段

專案監控報告預設顯示最新的實時報告,實時報告會顯示專案最新的一次監控統計。如果你希望檢視一段時間內的報告,可以選擇今天、3天、7天或者是其他自定義的時間段。

注意,選擇實時報告時,正確率趨勢圖表會顯示今天的資料,因為正確率趨勢無法僅根據最新的一次監控情況計算得出,必須顯示一段時間內的資料才能夠繪製趨勢圖。


2. 選擇監控報告的節點(地區)範圍

監控報告可以選擇檢視什麼監控節點的報告資料,專案簡況報告預設選擇檢視綜合統計,也就是所有節點資料的彙總報告。

如果你希望僅檢視某個監控節點的資料,點選相應的節點名稱即可。節點名稱前面會有綠色或紅色的圓點,表示在當前選中的時間段內,該節點是否有異常的歷史記錄,如果出現過API或者流程監控異常,則會顯示紅色圓點,提示你檢視相關的監控告警列表。


3. API 監控狀態統計

API 監控狀態圖表會顯示當前專案內的 API 總數、監控中的 API 數量、正常API、異常API以及整體API正確率資料。

如果當前選中的時間段內有API出現了異常,則圖表顯示API監控狀態為異常,否則為正常。


4. API 監控次數及異常原因統計

圖表會顯示在選中時間段內的請求次數、各種錯誤原因的次數。你可以透過這個圖表瞭解出現最多的異常原因來進行針對性排查。



5. API 正確率趨勢圖

API 正確率趨勢圖會顯示在選中時間段內的API正確率趨勢,正確率趨勢最小統計單位是小時,也就是一天最多會顯示24個統計點;當選擇的時間段大於1天時,正確率的統計點為一天,即一天統計一次正確率。


6. 流程監控狀態統計

流程監控狀態圖表會顯示當前專案內的API流程總數、監控中的流程數量、正常流程、異常流程以及整體流程正確率資料。

如果當前選中的時間段內有流程出現了異常,則圖表顯示監控狀態為異常,否則為正常。



7. 流程監控次數以及異常次數比例

圖表會顯示在選中時間段內的請求次數、錯誤次數。



8. 流程正確率趨勢圖

流程正確率趨勢圖會顯示在選中時間段內的流程正確率趨勢,正確率趨勢最小統計單位是小時,也就是一天最多會顯示24個統計點;當選擇的時間段大於1天時,正確率的統計點為一天,即一天統計一次正確率。



9. 專案正常執行時間統計

專案執行時間統計圖表會統計在選定的時間段內專案的累計正常時間以及累計異常時間,並且會將每段正常、異常時間進行統計,方便你瞭解專案在什麼時間段開始出現異常,以及異常的持續時間等。

如下圖表示專案在2020年2月23日凌晨0點起至2020年2月23日晚20點32分54秒處於異常狀態,隨後專案恢復正常。



10. 專案內異常的 API 列表

系統會統計在選定時間內出現過異常的 API,你可以透過異常 API 列表快速定位異常的 API,並且根據異常次數排序來找到異常次數最多的 API。

點選列表項的更多訊息按鈕,可以進入該 API 的監控詳情頁。



11. 專案內異常的流程列表

系統會統計在選定時間內出現過異常的流程,你可以透過異常流程列表快速定位異常的流程,並且根據異常次數排序來找到異常次數最多的流程。

點選列表項的更多訊息按鈕,可以進入該流程的監控詳情頁。


瞭解更多  API  異常監控請前往官網: 


來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/70027288/viewspace-2994576/,如需轉載,請註明出處,否則將追究法律責任。

相關文章