開發(fā)常用的 3種 API 監(jiān)控報(bào)告- Eolink Apikit

API 監(jiān)控報(bào)告是一種監(jiān)測(cè) API 異常的工具。在 API 管理中,查看 API 異常監(jiān)控的監(jiān)控報(bào)告,是 Eolink Apikit 常用的功能。Eolink Apikit 的監(jiān)控報(bào)告有 3種:

  • 單接口監(jiān)控報(bào)告
  • 流程監(jiān)控報(bào)告
  • 項(xiàng)目監(jiān)控報(bào)告


1、單接口監(jiān)控報(bào)告

單接口監(jiān)控報(bào)告通常關(guān)注單個(gè)應(yīng)用程序接口或系統(tǒng)的性能和可用性。它包括有關(guān)接口的指標(biāo),如響應(yīng)時(shí)間、錯(cuò)誤率、吞吐量等。僅關(guān)注一個(gè)接口,不包括整個(gè)流程或項(xiàng)目。單接口監(jiān)控報(bào)告有助于及時(shí)發(fā)現(xiàn)和解決與特定接口相關(guān)的問題,以確保其正常運(yùn)行。

1. API 綜合監(jiān)控報(bào)告

你可以在流程的綜合報(bào)告頁中看到當(dāng)前流程在選定的時(shí)間段內(nèi)的整體監(jiān)控概況,可以點(diǎn)擊不同的監(jiān)控節(jié)點(diǎn)來切換不同監(jiān)控節(jié)點(diǎn)發(fā)出的監(jiān)控信息,監(jiān)控信息包含以下內(nèi)容包括:

  • 所有監(jiān)控節(jié)點(diǎn)(地區(qū))的監(jiān)控狀態(tài)
  • 指定監(jiān)控節(jié)點(diǎn)(地區(qū))的監(jiān)控狀態(tài)
  • 流程實(shí)時(shí)的監(jiān)控狀態(tài)
  • 流程監(jiān)控次數(shù)及異常原因統(tǒng)計(jì)
  • 流程正確率趨勢(shì)圖
  • 流程運(yùn)行時(shí)間統(tǒng)計(jì)

2. 選擇監(jiān)控報(bào)告的時(shí)間段

項(xiàng)目監(jiān)控報(bào)告默認(rèn)顯示最新的實(shí)時(shí)報(bào)告,實(shí)時(shí)報(bào)告會(huì)顯示項(xiàng)目最新的一次監(jiān)控統(tǒng)計(jì)。如果你希望查看一段時(shí)間內(nèi)的報(bào)告,可以選擇今天、3天、7天或者是其他自定義的時(shí)間段。

注意,選擇實(shí)時(shí)報(bào)告時(shí),正確率趨勢(shì)圖表會(huì)顯示今天的數(shù)據(jù),因?yàn)檎_率趨勢(shì)無法僅根據(jù)最新的一次監(jiān)控情況計(jì)算得出,必須顯示一段時(shí)間內(nèi)的數(shù)據(jù)才能夠繪制趨勢(shì)圖。

3. 選擇監(jiān)控報(bào)告的節(jié)點(diǎn)(地區(qū))范圍

監(jiān)控報(bào)告可以選擇查看什么監(jiān)控節(jié)點(diǎn)的報(bào)告數(shù)據(jù),項(xiàng)目簡(jiǎn)況報(bào)告默認(rèn)選擇查看綜合統(tǒng)計(jì),也就是所有節(jié)點(diǎn)數(shù)據(jù)的匯總報(bào)告。

如果你希望僅查看某個(gè)監(jiān)控節(jié)點(diǎn)的數(shù)據(jù),點(diǎn)擊相應(yīng)的節(jié)點(diǎn)名稱即可。節(jié)點(diǎn)名稱前面會(huì)有綠色或紅色的圓點(diǎn),表示在當(dāng)前選中的時(shí)間段內(nèi),該節(jié)點(diǎn)是否有異常的歷史記錄,如果出現(xiàn)過API或者流程監(jiān)控異常,則會(huì)顯示紅色圓點(diǎn),提示你查看相關(guān)的監(jiān)控告警列表。

4. 流程實(shí)時(shí)監(jiān)控狀態(tài)

當(dāng)前流程最新一次監(jiān)控的結(jié)果,顯示流程當(dāng)前為正常情況還是異常情況的API數(shù)量。

5. 流程監(jiān)控次數(shù)及異常原因統(tǒng)計(jì)

圖表會(huì)顯示在選中時(shí)間段內(nèi)的流程的正確次數(shù)以及異常次數(shù)。

6. 流程正確率趨勢(shì)圖

流程正確率趨勢(shì)圖會(huì)顯示在選中時(shí)間段內(nèi)的流程正確率趨勢(shì),正確率趨勢(shì)最小統(tǒng)計(jì)單位是小時(shí),也就是一天最多會(huì)顯示24個(gè)統(tǒng)計(jì)點(diǎn);當(dāng)選擇的時(shí)間段大于1天時(shí),正確率的統(tǒng)計(jì)點(diǎn)為一天,即一天統(tǒng)計(jì)一次正確率。

7. 流程運(yùn)行時(shí)間統(tǒng)計(jì)

流程的運(yùn)行時(shí)間圖表會(huì)顯示流程從開啟監(jiān)控以來,維持正確運(yùn)行的時(shí)長(zhǎng)以及錯(cuò)誤運(yùn)行的時(shí)長(zhǎng),可以對(duì)流程的質(zhì)量有直觀體現(xiàn)。

8. 實(shí)時(shí)監(jiān)控報(bào)告

進(jìn)入 API 的監(jiān)控詳情頁,選擇時(shí)間段為 實(shí)時(shí),此時(shí)頁面會(huì)顯示該 API 最新一次的監(jiān)控報(bào)告,可以看到API最新一次請(qǐng)求的各階段時(shí)間分析:

  • 總時(shí)間
  • 重定向時(shí)間
  • 首字節(jié)時(shí)間
  • DNS解析時(shí)間
  • TCP建立連接時(shí)間
  • 握手時(shí)間
  • 等待首字節(jié)時(shí)間

還可以看到請(qǐng)求完整的請(qǐng)求內(nèi)容和返回內(nèi)容:

9. 詳細(xì)監(jiān)控日志

進(jìn)入 API 監(jiān)控詳情頁,點(diǎn)擊頁面上方的詳細(xì)監(jiān)控日志標(biāo)簽。進(jìn)入監(jiān)控日志標(biāo)簽頁后,你可以查看選擇需要查看的時(shí)間段、日志所屬的節(jié)點(diǎn)。

在日志列表中,你可以看到選定時(shí)間段和節(jié)點(diǎn)內(nèi)的每一次監(jiān)控請(qǐng)求。你可以在列表中篩選只查看異常的日志,點(diǎn)擊查看報(bào)告按鈕可以查看異常日志的詳細(xì)請(qǐng)求內(nèi)容。

注意,系統(tǒng)僅會(huì)記錄異常的監(jiān)控日志,并且線上產(chǎn)品的異常監(jiān)控日志最長(zhǎng)保存日期為15天。


2、流程監(jiān)控報(bào)告

流程監(jiān)控報(bào)告關(guān)注業(yè)務(wù)流程中涉及的多個(gè)接口、系統(tǒng)或環(huán)節(jié)。它包括有關(guān)整個(gè)流程的指標(biāo),如流程持續(xù)時(shí)間、各個(gè)步驟的完成情況、流程吞吐量等。覆蓋整個(gè)業(yè)務(wù)流程,而不僅僅是單個(gè)接口。流程監(jiān)控報(bào)告幫助組織了解業(yè)務(wù)流程的整體性能,找出流程中的瓶頸或問題,以便改進(jìn)流程效率和質(zhì)量。

1. 實(shí)時(shí)監(jiān)控報(bào)告

進(jìn)入流程監(jiān)控詳情頁,選擇時(shí)間段為 實(shí)時(shí),此時(shí)頁面會(huì)顯示該流程最新一次的監(jiān)控報(bào)告,包含以下內(nèi)容:

  • API 基本信息:API 請(qǐng)求地址、監(jiān)控狀態(tài)、監(jiān)控節(jié)點(diǎn)IP地址、監(jiān)控狀態(tài)等;
  • 流程的監(jiān)控步驟以及每一步的監(jiān)控狀態(tài)。

你可以點(diǎn)擊監(jiān)控步驟來查看詳細(xì)的監(jiān)控內(nèi)容:

2. 詳細(xì)監(jiān)控日志

進(jìn)入流程監(jiān)控詳情頁,點(diǎn)擊頁面上方的詳細(xì)監(jiān)控日志標(biāo)簽。進(jìn)入監(jiān)控日志標(biāo)簽頁后,你可以查看選擇需要查看的時(shí)間段、日志所屬的節(jié)點(diǎn)。

在日志列表中,你可以看到選定時(shí)間段和節(jié)點(diǎn)內(nèi)的每一次監(jiān)控請(qǐng)求。你可以在列表中篩選只查看異常的日志,點(diǎn)擊查看報(bào)告按鈕可以查看異常日志的詳細(xì)請(qǐng)求內(nèi)容。

注意,系統(tǒng)僅會(huì)記錄異常的監(jiān)控日志,并且線上產(chǎn)品的異常監(jiān)控日志最長(zhǎng)保存日期為15天。


3、項(xiàng)目監(jiān)控報(bào)告

項(xiàng)目監(jiān)控報(bào)告關(guān)注整個(gè)項(xiàng)目的狀態(tài)和進(jìn)展情況。它包括項(xiàng)目的關(guān)鍵指標(biāo)、計(jì)劃與實(shí)際的對(duì)比、風(fēng)險(xiǎn)和問題的跟蹤等。涵蓋項(xiàng)目的各個(gè)方面,包括范圍、時(shí)間、成本、質(zhì)量和風(fēng)險(xiǎn)等。項(xiàng)目監(jiān)控報(bào)告有助于項(xiàng)目管理人員和利益相關(guān)者了解項(xiàng)目的健康狀況,及時(shí)采取措施以確保項(xiàng)目按計(jì)劃推進(jìn),減少風(fēng)險(xiǎn),確保項(xiàng)目成功完成。

你可以在項(xiàng)目概況頁中看到當(dāng)前項(xiàng)目在選定的時(shí)間段內(nèi)的整體監(jiān)控概況,包括:

  • 所有監(jiān)控節(jié)點(diǎn)(地區(qū))的監(jiān)控狀態(tài)
  • 指定監(jiān)控節(jié)點(diǎn)(地區(qū))的監(jiān)控狀態(tài)
  • API 監(jiān)控狀態(tài)統(tǒng)計(jì)
  • API 監(jiān)控次數(shù)及異常原因統(tǒng)計(jì)
  • API 正確率趨勢(shì)圖
  • 流程監(jiān)控狀態(tài)統(tǒng)計(jì)
  • 流程監(jiān)控次數(shù)以及異常次數(shù)比例
  • 流程正確率趨勢(shì)圖
  • 項(xiàng)目正常運(yùn)行時(shí)間統(tǒng)計(jì)
  • 項(xiàng)目?jī)?nèi)異常的 API 列表
  • 項(xiàng)目?jī)?nèi)異常的流程列表

1. 選擇監(jiān)控報(bào)告的時(shí)間段

項(xiàng)目監(jiān)控報(bào)告默認(rèn)顯示最新的實(shí)時(shí)報(bào)告,實(shí)時(shí)報(bào)告會(huì)顯示項(xiàng)目最新的一次監(jiān)控統(tǒng)計(jì)。如果你希望查看一段時(shí)間內(nèi)的報(bào)告,可以選擇今天、3天、7天或者是其他自定義的時(shí)間段。

注意,選擇實(shí)時(shí)報(bào)告時(shí),正確率趨勢(shì)圖表會(huì)顯示今天的數(shù)據(jù),因?yàn)檎_率趨勢(shì)無法僅根據(jù)最新的一次監(jiān)控情況計(jì)算得出,必須顯示一段時(shí)間內(nèi)的數(shù)據(jù)才能夠繪制趨勢(shì)圖。

2. 選擇監(jiān)控報(bào)告的節(jié)點(diǎn)(地區(qū))范圍

監(jiān)控報(bào)告可以選擇查看什么監(jiān)控節(jié)點(diǎn)的報(bào)告數(shù)據(jù),項(xiàng)目簡(jiǎn)況報(bào)告默認(rèn)選擇查看綜合統(tǒng)計(jì),也就是所有節(jié)點(diǎn)數(shù)據(jù)的匯總報(bào)告。

如果你希望僅查看某個(gè)監(jiān)控節(jié)點(diǎn)的數(shù)據(jù),點(diǎn)擊相應(yīng)的節(jié)點(diǎn)名稱即可。節(jié)點(diǎn)名稱前面會(huì)有綠色或紅色的圓點(diǎn),表示在當(dāng)前選中的時(shí)間段內(nèi),該節(jié)點(diǎn)是否有異常的歷史記錄,如果出現(xiàn)過API或者流程監(jiān)控異常,則會(huì)顯示紅色圓點(diǎn),提示你查看相關(guān)的監(jiān)控告警列表。

3. API 監(jiān)控狀態(tài)統(tǒng)計(jì)

API 監(jiān)控狀態(tài)圖表會(huì)顯示當(dāng)前項(xiàng)目?jī)?nèi)的 API 總數(shù)、監(jiān)控中的 API 數(shù)量、正常API、異常API以及整體API正確率數(shù)據(jù)。

如果當(dāng)前選中的時(shí)間段內(nèi)有API出現(xiàn)了異常,則圖表顯示API監(jiān)控狀態(tài)為異常,否則為正常。

4. API 監(jiān)控次數(shù)及異常原因統(tǒng)計(jì)

圖表會(huì)顯示在選中時(shí)間段內(nèi)的請(qǐng)求次數(shù)、各種錯(cuò)誤原因的次數(shù)。你可以通過這個(gè)圖表了解出現(xiàn)最多的異常原因來進(jìn)行針對(duì)性排查。

5. API 正確率趨勢(shì)圖

API 正確率趨勢(shì)圖會(huì)顯示在選中時(shí)間段內(nèi)的API正確率趨勢(shì),正確率趨勢(shì)最小統(tǒng)計(jì)單位是小時(shí),也就是一天最多會(huì)顯示24個(gè)統(tǒng)計(jì)點(diǎn);當(dāng)選擇的時(shí)間段大于1天時(shí),正確率的統(tǒng)計(jì)點(diǎn)為一天,即一天統(tǒng)計(jì)一次正確率。

6. 流程監(jiān)控狀態(tài)統(tǒng)計(jì)

流程監(jiān)控狀態(tài)圖表會(huì)顯示當(dāng)前項(xiàng)目?jī)?nèi)的API流程總數(shù)、監(jiān)控中的流程數(shù)量、正常流程、異常流程以及整體流程正確率數(shù)據(jù)。

如果當(dāng)前選中的時(shí)間段內(nèi)有流程出現(xiàn)了異常,則圖表顯示監(jiān)控狀態(tài)為異常,否則為正常。

7. 流程監(jiān)控次數(shù)以及異常次數(shù)比例

圖表會(huì)顯示在選中時(shí)間段內(nèi)的請(qǐng)求次數(shù)、錯(cuò)誤次數(shù)。

8. 流程正確率趨勢(shì)圖

流程正確率趨勢(shì)圖會(huì)顯示在選中時(shí)間段內(nèi)的流程正確率趨勢(shì),正確率趨勢(shì)最小統(tǒng)計(jì)單位是小時(shí),也就是一天最多會(huì)顯示24個(gè)統(tǒng)計(jì)點(diǎn);當(dāng)選擇的時(shí)間段大于1天時(shí),正確率的統(tǒng)計(jì)點(diǎn)為一天,即一天統(tǒng)計(jì)一次正確率。

9. 項(xiàng)目正常運(yùn)行時(shí)間統(tǒng)計(jì)

項(xiàng)目運(yùn)行時(shí)間統(tǒng)計(jì)圖表會(huì)統(tǒng)計(jì)在選定的時(shí)間段內(nèi)項(xiàng)目的累計(jì)正常時(shí)間以及累計(jì)異常時(shí)間,并且會(huì)將每段正常、異常時(shí)間進(jìn)行統(tǒng)計(jì),方便你了解項(xiàng)目在什么時(shí)間段開始出現(xiàn)異常,以及異常的持續(xù)時(shí)間等。

如下圖表示項(xiàng)目在2020年2月23日凌晨0點(diǎn)起至2020年2月23日晚20點(diǎn)32分54秒處于異常狀態(tài),隨后項(xiàng)目恢復(fù)正常。

10. 項(xiàng)目?jī)?nèi)異常的 API 列表

系統(tǒng)會(huì)統(tǒng)計(jì)在選定時(shí)間內(nèi)出現(xiàn)過異常的 API,你可以通過異常 API 列表快速定位異常的 API,并且根據(jù)異常次數(shù)排序來找到異常次數(shù)最多的 API。

點(diǎn)擊列表項(xiàng)的更多消息按鈕,可以進(jìn)入該 API 的監(jiān)控詳情頁。

11. 項(xiàng)目?jī)?nèi)異常的流程列表

系統(tǒng)會(huì)統(tǒng)計(jì)在選定時(shí)間內(nèi)出現(xiàn)過異常的流程,你可以通過異常流程列表快速定位異常的流程,并且根據(jù)異常次數(shù)排序來找到異常次數(shù)最多的流程。

點(diǎn)擊列表項(xiàng)的更多消息按鈕,可以進(jìn)入該流程的監(jiān)控詳情頁。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容