Apigee API Analytics 簡介

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

本主題將介紹 Apigee API 數據分析。

透過數據分析改善 API

Apigee API 數據分析會收集並計算透過 API Proxy 傳輸的大量資訊。 您可以在 Apigee 使用者介面中，以圖表呈現這項資料，也可以使用 Apigee API 下載原始資料，進行離線分析。

Analytics 可協助您解答常見問題，例如：

  • 我的 API 流量隨時間的變化趨勢為何？
  • 哪些 API 方法最熱門？
  • 哪些開發人員的應用程式最受歡迎？
  • API 回應速度最快的時間是？最慢？
  • 從地理位置來看，我的 API 流量最多來自哪裡？
  • 交易帶來多少收益？

您可以分析特定主機名稱或整個環境的資料。

這類問題的答案有助於改善 API、排解問題，以及針對 API 計畫做出更明智的業務決策。

API 數據分析有助於提升品質

Apigee API Analytics 會持續收集、分析及顯示資料，協助 API 團隊改善 API，並協助應用程式開發人員改善應用程式：

資料會從應用程式流經 API 代理伺服器，然後資料分析會協助引導應用程式開發人員、API 團隊、營運團隊和企業主的行動。
  • API 團隊：API 團隊會運用內部系統建立有趣的 API。 API 團隊想瞭解 API 計畫的整體成效、個別 API 的成效，以及如何改善 API。
  • 應用程式開發人員 - 與應用程式開發人員分享數據分析資訊，有助於提升應用程式品質。這些開發人員運用您的 API 進行創新，並建構有助於為企業帶來收益的創意應用程式。應用程式開發人員可透過 Analytics 瞭解應用程式的成效，以及應用程式對企業營收的貢獻。應用程式開發人員想知道如何改善應用程式。
  • 營運團隊 - 營運團隊想瞭解流量模式，並預測何時應新增後端資源或進行其他重大調整。
  • 企業主：企業主想瞭解 API 投資的效益，以及未來應將 API 預算投入哪些領域。

如何開始使用 Apigee API 數據分析？

您使用的 Apigee 機構類型會決定開始使用 Apigee API Analytics 的必要步驟。 如果您不確定自己使用的是訂閱型或即付即用型 Apigee 機構，請與 Apigee 機構管理員聯絡。

在訂閱機構中使用 Apigee API 數據分析

如果您是 Apigee 訂閱方案客戶，Apigee API Analytics 的存取權會納入您的訂閱授權，並為每個 Apigee 環境自動啟用。

您可以使用Cloud 控制台中的 Apigee UI 或 Apigee API，存取訂閱機構的 Analytics 資料。詳情請參閱「如何存取我的數據分析資料」。

在即付即用機構中使用 Apigee API 數據分析

如果您是Pay-as-you-go方案客戶，必須啟用 Apigee API Analytics 做為付費外掛程式，才能開始使用 Analytics 資料。如要進一步瞭解如何為中級或完整 Apigee 環境啟用 Apigee API 數據分析外掛程式，請參閱「 管理 Apigee API 數據分析外掛程式」。

在環境中啟用 Apigee API 數據分析外掛程式後，您可以使用 Cloud Console 中的 Apigee 使用者介面或 Apigee API，存取數據分析資料及管理 Apigee API 數據分析外掛程式。詳情請參閱「如何存取我的數據分析資料」。對於 Pay 即付即用機構，傳統 Apigee UI 不提供 Analytics 資料和外掛程式管理功能。

系統會收集及分析哪些類型的資料？

Apigee API 數據分析會收集及分析 API Proxy 傳輸的各種資料，例如：

  • 回應時間
  • 要求延遲時間
  • 要求大小
  • 目標錯誤
  • API 產品名稱
  • 開發人員電子郵件地址或 AppGroup ID
  • 應用程式名稱
  • 交易收益

如需 API Analytics 收集的完整資料清單，請參閱「數據分析指標、維度和篩選器參考資料」。

如何收集自訂的 Analytics 資料？

Apigee 本身就會收集大量資料，您可能也想收集 API Proxy、應用程式、產品或開發人員專屬的自訂數據分析資料。舉例來說，您可能想從查詢參數、要求標頭、要求和回應主體，或您在 API 中定義的變數收集 Analytics 資料。

您可以使用 DataCapture 政策收集自訂 Analytics 資料，然後使用 Analytics 使用者介面或 API 檢查收集到的資料。

分析資料何時會提供？保留時間有多長？

有兩個時間間隔可控制您查看數據資料的時間和長度：

  • 資料延遲間隔 - 呼叫 API Proxy 後，資料最多可能需要 10 分鐘才會顯示，或透過 API 呼叫存取。
  • 數據分析資料的可用時間 - Apigee 提供數據分析資料 (包括營利和 Sense 資料，如適用) 的時間長度因方案而異。 視方案而定，你可能可以查看過去 30 天、90 天或 14 個月的數據資料。

使用 Apigee API Analytics 外掛程式時的資料保留期限

如果您使用隨用隨付方案，可以在環境層級啟用 Apigee API Analytics 外掛程式。 為環境啟用外掛程式後，系統會保留該環境的數據分析資料 14 個月。只要啟用外掛程式，您就能在控制台的「API 指標」頁面存取環境的歷來數據分析資料。

如果您在隨用隨付機構中停用環境的 Apigee API 數據分析外掛程式，系統會在 30 天後刪除該環境的數據分析資料。如果在停用外掛程式後 30 天內，於相同環境中重新啟用，您就能在 14 個月的保留期限內，重新存取該環境的 Analytics 資料。如果 30 天後重新啟用環境的外掛程式，系統不會還原任何資料。

如要保留隨用隨付機構中任何環境的 Analytics 資料，且保留期限超過 14 個月，建議您匯出資料並儲存到其他位置。您也可以在停用 Apigee API Analytics 外掛程式前，或在停用後的 30 天內匯出 Analytics 資料。詳情請參閱「 從 Analytics 匯出資料」。

我的數據分析資料會在哪裡儲存及處理？

數據分析資料的儲存和處理位置取決於您安裝 Apigee 時指定的數據分析區域：

  • 如果您是訂閱方案客戶，並使用 Apigee 佈建精靈安裝 Apigee，則在建立機構步驟 1 中設定「Analytics 託管區域」時，已指定 Analytics 區域。
  • 如果您是隨用隨付方案客戶，並使用 Google Cloud 控制台安裝 Apigee，則在建立機構的步驟 3 中，設定「Analytics hosting region」(Analytics 託管區域) 時，已指定 Analytics 區域。
  • 如果您是訂閱或隨用隨付方案客戶，並從指令列安裝 Apigee，則在定義環境變數 ANALYTICS_REGION 時，已指定 Analytics 區域。
  • 如果您使用 一鍵式選項安裝 Apigee，分析資料會儲存在 us-west1 區域。你無法變更這項預設位置。

Analytics 資料的儲存和處理方式如下：

  • 如果數據分析區域不在美國或歐盟，系統會在該區域儲存及處理數據分析資料。
  • 如果是美國或歐盟的 Analytics 區域，資料會分別儲存在美國或歐盟的多區域，以提高可用性。

如何存取數據分析資料？

Apigee API 數據分析提供內建於 Apigee UI 的資料視覺化工具。這些工具包括預先定義的 Analytics 資訊主頁和自訂報表，可透過圖表顯示資料，並讓您深入瞭解依不同維度 (例如 API Proxy、IP 位址或 HTTP 狀態碼) 分組的資料。

您也可以使用 Apigee API 下載數據分析資料。下載後，您就能將資料匯入自己的資料視覺化工具或分析系統。

數據分析資訊主頁

Apigee 使用者介面提供一組預先定義的資訊主頁，可用於查看 Analytics 資料。

Cloud 控制台中的 Apigee

如要開啟 Analytics 資訊主頁 (適用於隨用隨付或訂閱機構)：

  1. 在瀏覽器中開啟 Cloud Console 中的 Apigee 使用者介面。
  2. 選取「Analytics」>「API 指標」。
下圖顯示 API Proxy 效能資訊主頁：

選取下列任一分頁標籤，即可查看資訊主頁：

詳情請參閱「使用數據分析資訊主頁」。

自訂報表

自訂報表可讓您深入瞭解特定 API 指標，並查看所需確切資料。 您可以使用 Apigee 內建的任何分析資料建立自訂報表。

製作自訂報表時，您可以選取要查看的資料 (指標)、以有意義的方式將資料分組 (維度)，並視需要根據資料的特定特徵限制傳回的資料 (篩選)。

您也可以將自訂報表顯示的圖表類型設為柱狀圖或折線圖。 下圖顯示按 API Proxy 分組的每秒交易數圖表範例：

  • 資料欄 - 每個 API 代理都會以不同的資料欄表示：

    自訂直條圖

  • 折線：每條折線代表一個 API Proxy：

    自訂折線圖

詳情請參閱「建立及管理自訂報表」。

Analytics API

使用 Apigee API 下載數據分析資料。舉例來說，您可以使用 API 建構自己的視覺化工具，並嵌入入口網站或自訂應用程式。

以下是擷取 API Proxy 分析資料的 API 呼叫範例：

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/stats/apiproxy?select=sum(message_count)&timeRange=6/24/2022%2000:00~6/25/2022%2023:59&timeUnit=hour" \
  -H "Authorization: Bearer $TOKEN"

這項呼叫會傳回：

  • 每個 API Proxy 的要求總和 (訊息數)
  • 24 小時內
  • 按小時分組

timeRange 查詢參數會以以下格式指定時間範圍：

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

請注意 HH:MM 前的 %20。timeRange 參數需要在 HH:MM 前加上網址編碼的空格字元，或是 + 字元，例如：MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM。

詳情請參閱「使用 Metrics API」。

將數據分析資料匯出至 Google Cloud Platform

您可以使用 Apigee API，將一整天的所有分析資料從 Apigee 匯出至自己的資料存放區，例如 Google Cloud Storage 或 BigQuery。接著，您就能運用 Google Cloud BigQuery 和 TensorFlow 提供的強大查詢和機器學習功能，自行進行資料分析。

詳情請參閱「從 Analytics 匯出資料」一文。

如何與應用程式開發人員分享資料？

將應用程式開發人員視為客戶時，請務必確保他們擁有可用的工具和資訊，以便充分運用您的 API。

應用程式會透過 API Proxy 傳送資料，而應用程式開發人員可透過資料分析，瞭解應用程式的成效。

應用程式開發人員不僅關心應用程式品質，也對您的 API 很有興趣。以 Drupal 為基礎的開發人員入口網站包含選用的「應用程式效能」頁面，可供應用程式開發人員存取應用程式的重要指標。這個頁面提供開發人員下列資訊：

  • 錯誤：我的應用程式發生哪些 API 錯誤？
  • 效能：API 是否速度緩慢？哪些 API 方法通常很慢，或目前很慢？
  • 可用性：API 是否正常運作？
  • 配額：您的 API 是否有配額？身為應用程式開發人員，我目前的配額使用情形如何？

詳情請參閱 Drupal 8 說明文件中的「 監控應用程式」。

此外，您也可以透過下列方式與開發人員分享數據分析：

  • 建立自訂報表，並與應用程式開發人員共用。詳情請參閱「建立及管理自訂報表」。
  • 使用指標 API 擷取較長一段時間的資料，然後離線分享給應用程式開發人員。詳情請參閱「使用指標 API」。

如何產生完整的數據分析資料？

什麼是完整的數據分析？舉例來說，您可以建立 API Proxy，Apigee 會收集該 Proxy 的數據分析資料。但如果是呼叫 API Proxy 的開發人員或應用程式，又該如何取得指標？如果 Apigee 不知道是誰發出 API 呼叫，就無法收集該資料。

您必須完成幾個步驟，Apigee 才能判斷哪些開發人員和開發人員應用程式正在呼叫 API Proxy。以下列出這些步驟，並提供詳細資訊的連結：

  1. 建立一或多個 API 產品，也就是將 API Proxy 與服務方案分組。請參閱「管理 API 產品」。
  2. 向 Apigee 註冊應用程式開發人員。請參閱「註冊應用程式開發人員」。
  3. 註冊應用程式，並為開發人員管理 API 金鑰。請參閱「註冊應用程式及管理 API 金鑰」。
  4. 在 API Proxy 中新增安全政策，驗證 API 金鑰和/或安全權杖。 請參閱下列主題：VerifyAPIKey 政策、OAuthV2 政策和 VerifyJWT 政策。

下列教學課程會逐步說明必要步驟，讓您查看開發人員和應用程式的分析資料：透過要求 API 金鑰保護 API 和使用 OAuth 保護 API。

Apigee Hybrid 需求條件

本節列出 Apigee Hybrid 使用者的重要資訊。

支援資料落地

舊版 Apigee Hybrid 不支援 Apigee API 數據分析。

其他需求

  • 您必須設定 apigee-udca 服務帳戶。請參閱「指定設定覆寫」。
  • 所有同步器節點上的時鐘都應同步，並採用世界標準時間。

更多資訊