建立自訂報表

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

自訂報表可讓您深入瞭解特定 API 指標，並查看想要查看的確切資料。在 API Monitoring 資訊主頁中，您可以根據在建立當下所設條件，使用預設篩選器和指標建立自訂報表。此外，報表會為您設定一組預設維度和指標。

根據情境建立自訂報表

請參閱下表的摘要說明，並根據目前情境快速建立自訂報表。在「自訂報表」頁面上，使用 API 監控功能建立的自訂報表的預設名稱會如表格所示 (預設名稱)；您可以在編輯自訂報表時變更名稱。

自訂報表內容 自訂報表的預設命名慣例
近期的資訊主頁 API Monitoring Recent Generated
時間軸資訊主頁 API Monitoring Timeline Generated
調查資訊主頁 API Monitoring Investigate Generated
顯示快訊的條件 API Monitoring Generated: alert-name

預設維度和指標

根據預設，所有 API Monitoring 產生的報表，都會包含下表所列的維度和指標。

元件 預設值
維度 要求 URI
指標
  • 總回應時間
  • 目標回覆時間
  • Proxy 錯誤
  • 目標錯誤

編輯自訂報表

如上一節所述，自訂報表中已預先設定一組預先定義的 API 監控預設維度和指標。建立完成後，您可以編輯自訂報表，視需要新增或刪除指標和維度。舉例來說，您可能會想將調查範圍縮小至特定存取權杖、開發人員應用程式、API Proxy 或要求 ID。

在下列自訂報表中新增預先定義的 Gateway Flow ID 維度，其中 Gateway Flow ID 包含向 Edge 發出的每個 API 要求的專屬 UUID。 請注意，報表已使用「Request URI」維度：

以下範例會在自訂報表中加入 Client ID 維度。 Client ID 維度包含進行 API 呼叫的開發人員用戶端金鑰 (API 金鑰)，無論是以 API 金鑰的形式傳入要求，還是包含在 OAuth 權杖中：

自訂報表包含所有 Client ID 值的資訊。下一個範例新增了篩選器，以便針對特定 Client ID 建立自訂報表：

如要進一步瞭解可在報表中加入的所有預先定義維度和指標，請參閱「Analytics (分析) 指標、維度和指標參考資料」一文。

在下一個範例中，您在自訂報表中新增篩選器，擷取 policies.ratelimit.QuotaViolation 錯誤代碼和 5xx 狀態碼的預設指標和維度：

如需修改自訂報表的完整詳細資訊，請參閱「管理自訂報表」一文。

範例：使用自訂報表診斷部署問題

將 StatisticsCollector 政策附加至 API Proxy，即可收集自訂數據分析資料，例如使用者或產品 ID、價格、REST 動作、目標版本、目標網址和訊息長度。資料可能來自 Apigee 預先定義的流程變數、要求標頭、查詢參數或您定義的自訂變數。

例如，傳送至 API Proxy 的要求包含產品 ID、使用者 ID 和目標伺服器版本的標頭。這項要求可能格式為：

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

之後，您可以使用標頭中的資訊，協助診斷 API Proxy 的執行階段問題。

若要建立這些標題的自訂報表：

  1. 將 StatisticsCollector 政策加到 API 中，以便擷取自訂標頭的值：

    <StatisticsCollector name="publishPurchaseDetails">
  <Statistics>
    <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
    <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
    <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
  </Statistics>
</StatisticsCollector>

  2. 部署 Proxy 並等待一段時間，讓 Proxy 可供存取。

  3. 在 Edge UI 中依序點選「分析」>「API 監控」>「近期」，查看任何 API 問題。請注意，myapi Proxy 會收到 4xx 和 5xx 錯誤：

  4. 選取 myapi Proxy 資料列，即可在「最近」資訊主頁的右側窗格中查看詳細資料。

  5. 在「近期」資訊主頁的右側窗格中，依序選取「「更多」選單」>「調查中查看」，即可存取調查資訊主頁：

  6. 使用 myapi Proxy 篩選調查資訊主頁，然後查看頂端圖表中的「狀態碼」。請注意，您收到了 403 和 501 錯誤：

  7. 在邊緣使用者介面中，依序選取「Analytics (分析)」>「自訂報表」>「報表」，即可建立自訂報表，納入這些自訂指標的值做為維度。

    不過根據預設，這些報表不會納入您的自訂數據分析資料，但您可以自行新增。

  8. 選取「+ 自訂報表」，建立名為 myapi_errors 的自訂報表。

  9. 為指標選取「Proxy Error」，然後將「匯總函式」設為「總和」。您也可以視需要新增更多指標。

  10. 選取預先定義的「回應狀態碼」維度，然後將以下三個自訂統計資料 (prodid、targetersion 和 userid) 加入維度：

  11. 將篩選器設為只包含 myapi API Proxy (apiproxy eq 'myapi') 的資料：

  12. 儲存報表。

  13. 執行前 24 小時的報表。報表首次開啟時，您會看到 HTTP 403 和 501 錯誤的圖表：

  14. 在「摘要」下方，按一下「403」或「510」查看是哪個產品產生錯誤。例如，如果您選取「403」403：

  15. 按一下「摘要」下方的產品 ID，依目標版本 (Alpha 版或 Beta 版) 查看錯誤：

  16. 在「Summary」下方，按一下目標版本即可查看使用者發生的錯誤：