監控近期的 API 流量

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

使用「近期」資訊主頁,即可監控貴機構在過去 1 小時內,所有 API Proxy 和目標服務近期的 API 流量。API 監控資料可以以詳細清單或熱視圖顯示。您可以在下列各節中探索各個檢視畫面:

使用清單檢視

清單檢視會顯示貴機構中過去曾有流量的 API Proxy 和目標服務的摘要資訊。

瀏覽清單檢視

如要顯示清單檢視畫面,請在 Edge UI 中依序選取「Analyze」>「API Monitoring」>「Recent」

根據預設,系統會顯示清單檢視模式。在「最近使用」資訊主頁中按一下 ,即可隨時返回「清單」檢視畫面。

最近造訪的頁面

如圖中所示,清單檢視可讓您:

  • 針對貴機構中在過去一小時內具有交易的所有 API Proxy 和目標服務,查看摘要資訊。系統會按照區域和環境列出 API Proxy 和目標服務。(如需更廣泛的歷來資料,請參閱「找出 API 監控資料中的趨勢」一文)。
  • 快速識別 API Proxy 和含有快訊的目標服務。(如要瞭解如何設定快訊,請參閱「設定快訊和通知」一文)。
  • 按一下清單中的 API Proxy 或目標服務名稱,即可在右側窗格中查看詳細資料
  • 根據目前的使用情境,快速執行下列工作 (如果選項不適用於目前所選情境,則會呈現灰色):

    • 建立自訂報表並加入其他維度。按一下
    • 建立快訊,然後新增其他快訊條件、設定通知,以及根據快訊產生自訂報表。
    • 你可以在時間軸調查資訊主頁中查看目前的背景資訊。分別依序點選 「更多」選單 圖示 >「在時間軸中查看」或「在調查中查看」
  • 按照名稱或網址搜尋清單檢視畫面 (例如 https://acme.com/api)。在搜尋框中輸入完整或部分的相關字串。您可以在「Proxy」、「目標」或「區域」欄位中搜尋內容。

    注意:如果選取「僅限快訊」篩選器,則搜尋結果只會顯示含有快訊的 API Proxy 或目標服務。

  • 視需要啟用或停用網頁的自動重新整理功能。

  • 在清單中顯示或隱藏目標服務詳細資料。

找出已發出快訊的 API Proxy 和目標服務

查看清單檢視時,紅色警告圖示 和紅色左框線代表哪些 API Proxy 和目標服務有快訊。

按一下「僅限快訊」,僅顯示有快訊的 API Proxy 或服務目標。

僅播放快訊

如要查看 4xx 和 5xx 錯誤數量的摘要,以及整體錯誤率,請將滑鼠遊標懸停在表格中的任何數值上。

查看 API Proxy 或目標服務的詳細資料

如要查看 API Proxy 或目標服務的詳細資料,請在「清單」檢視中按一下服務名稱。詳細資料會顯示在右側窗格中。

詳細檢視

點選下列標籤即可檢視詳細資訊:

此外,在目前情境中,您也可以快速執行下列工作:

注意:如果選項不適用於目前所選內容,則會顯示為灰色。

  • 建立自訂報表並加入其他維度。按一下
  • 建立快訊,然後新增其他快訊條件、設定通知,以及根據快訊產生自訂報表。依序按一下 「更多」選單>「建立快訊」
  • 你可以在時間軸調查資訊主頁中查看目前的背景資訊。分別依序點選 「更多」選單 圖示 >「在時間軸中查看」或「在調查中查看」

詳細說明

「詳細資料」分頁可讓您快速查看指定時間軸的流量資料 (如上圖所示):

詳細資訊 說明
總流量 交易總數。
錯誤總數 錯誤總數。
總錯誤率 發生錯誤的流量百分比 (錯誤總數/總流量)。

注意:API Monitoring 會將這個百分比與您設定的快訊條件進行比較。如果總錯誤率超過閾值,使用者介面中就會顯示快訊指標。

平均 TPS 每秒平均交易次數。
總延遲時間 (P99) 以 5 分鐘的滾動週期計算,第 99 個百分位數的回應延遲時間總值。
注意:僅針對 API Proxy 顯示。
目標延遲時間 (P99) 以 5 分鐘的滾動週期計算,第 99 個百分位數的目標回應延遲時間值。
注意:僅針對 API Proxy 顯示。
錯誤來源 API Proxy 組合錯誤 (4xx 和 5xx) 發生的細目和總百分比。

「趨勢」分頁會顯示所選元件的下列圖表:

  • 4xx 和 5xx 錯誤的錯誤率
  • 流量 (TPS)
  • 總延遲時間 (毫秒)
  • 所有目標延遲時間

將滑鼠遊標懸停在圖表上的不同點,即可分別顯示每個時間點的錯誤百分比、總流量數量和延遲時間。

Google 搜尋趨勢

記錄檔

在「記錄檔」分頁中,依據 4xx、5xx 或「所有錯誤」進行篩選,並使用 API Proxy、目標服務 (您的服務) 或 Apigee (Apigee 基礎架構) 縮小錯誤來源。

記錄檔

按一下錯誤即可開啟記錄對話方塊,並在清單中展開其詳細資料。

記錄檔

使用熱視圖

熱視圖提供色彩區塊檢視畫面,可讓您找出有警報的環境。

  • 綠色表示尚未超過快訊條件門檻。
  • 紅色:表示超過快訊條件門檻,已觸發快訊。

探索熱視圖

在「近期」頁面上按一下 ,顯示熱視圖,如下圖所示。

熱視圖

如上圖所示,熱視圖能用來:

  • 快速找出已發出快訊的 API Proxy 和目標服務。(如要瞭解如何設定快訊,請參閱設定快訊和通知)。
  • 從下拉式清單中選取元件即可篩選顯示畫面,或是按兩下方塊即可進一步細查資料。在「Proxy」和「目標」下拉式清單中,您可以使用集合進行篩選。例如:
  • 按一下熱視圖中的區塊,在右側窗格中查看詳細資料
  • 根據目前的情境,快速執行下列工作 (如果選項不適用於目前所選內容,選項會顯示為灰色):

    • 建立自訂報表並加入其他維度。按一下
    • 建立快訊,然後新增其他快訊條件、設定通知,以及根據快訊產生自訂報表。依序按一下 「更多」選單>「建立快訊」
    • 你可以在時間軸調查資訊主頁中查看目前的背景資訊。分別依序點選 「更多」選單 圖示 >「在時間軸中查看」或「在調查中查看」
  • scaled by 設定為對數或線性,即可設定熱視圖的顯示比例。並根據整體流量比例調整方塊大小。舉例來說,具有 200 呼叫的 Proxy 大小為包含 100 次呼叫的 Proxy 大小的兩倍。

    調整熱視圖

  • 在搜尋框中輸入完整或部分相關字串,即可搜尋熱視圖。視目前顯示的內容而定,您可以在區域、環境、Proxy 或目標地圖上搜尋內容。

    注意:如果選取「僅限快訊」篩選器,則搜尋結果只會顯示含有快訊的 API Proxy 或目標服務。

  • 視需要啟用或停用網頁的自動重新整理功能。

找出已發出快訊的 API Proxy 和目標服務

查看熱視圖時,red區塊會指出哪些環境、API Proxy 和目標服務收到快訊。如要進一步瞭解如何設定快訊,請參閱設定快訊和通知

例如,下圖顯示兩種環境:

  • test 環境red,因為其流量錯誤百分比超過您為指定時間軸設定的快訊條件門檻。
  • 實際環境為綠色,因為其流量錯誤百分比尚未超過指定時間軸的快訊條件門檻。

熱視圖

從下拉式清單中選取元件,即可篩選顯示畫面。或者,請「按兩下」方塊,從環境對應連結至 API Proxy 對應關係,並從 API Proxy 對應至該 API Proxy 的服務目標對應資料,找出含有快訊的 API Proxy 和目標服務。

環境 >> Proxy >> 目標

按一下「僅顯示快訊」,根據目前顯示的內容,僅顯示有快訊的環境、API Proxy 或服務目標。

如要返回上一層,請按一下 熱視圖箭頭

查看環境、API Proxy 或目標服務的詳細資料

如要查看環境、API Proxy 或目標服務的詳細資料,請按一下熱視圖中對應的方塊。詳細資料會顯示在右側窗格中。

熱視圖

這些分頁提供的資訊與清單檢視中提供的相同。詳情請參閱:

只要點選地圖上的方塊,即可查看過去一小時內的呼叫次數和錯誤率。

熱視圖工具提示

使用近期資訊主頁建立自訂報表

根據所選條件組合建立自訂報表。您可以在建立自訂報表後加以編輯,並視需要新增或刪除指標和維度。舉例來說,您可能會想將調查範圍縮小至特定存取權杖、開發人員應用程式或 API Proxy。詳情請參閱「Analytics (分析) 指標、維度和篩選器參考資料」一文。

詳情請參閱「建立自訂報表」一文。

如要透過「近期」資訊主頁建立自訂報表,請按照下列步驟進行:

  1. 在 Edge UI 中依序點選「Analyze」>「API Monitoring」>「Recent」
  2. 在「清單檢視」或「熱視圖」篩選器下拉式選單中選取 API Proxy 或目標服務,即可查看詳細資料。 注意:如果 Proxy 和目標篩選器設為 All,就無法使用自訂報表。

  3. 按一下右上角的 建立自訂報表

    自訂報表頁面會在新分頁中開啟相關欄位,並預先填入預設維度和指標。根據預設,自訂報表的命名方式如下:API Monitoring Recent Generated 注意:如果目前結構定義已有自訂報表,就會開啟該報表。

  4. 視需要編輯自訂報表,然後按一下「儲存」

  5. 在清單上按一下報表名稱,然後執行自訂報表