Apigee API Analytics 簡介

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

本主題將介紹 Apigee API Analytics。

透過數據分析改善 API

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

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

• API 流量隨著時間的變化趨勢為何？
• 哪些 API 方法最受歡迎？
• 我的前幾名開發人員是誰？
• 何時 API 回應速度最快？最慢？
• 從地理區域來看，哪些地區的 API 流量最多？
• 交易產生的收益是多少？

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

這些問題的答案有助於您改善 API、排除問題，並做出與 API 計畫相關的更佳業務決策。

API 數據分析有助於所有人改善

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

• API 團隊：API 團隊會利用內部系統來建立有趣的 API。API 團隊想瞭解 API 計畫的整體表現、個別 API 的表現，以及如何改善 API。
• 應用程式開發人員：與應用程式開發人員分享數據分析資訊，即可獲得更優質的應用程式。這些開發人員會運用您的 API 進行創新，並開發出有助於為企業創造收益的創意應用程式。Analytics 可協助應用程式開發人員瞭解應用程式的表現，以及對企業帶來多少效益。應用程式開發人員想知道如何改善應用程式。
• 營運團隊：營運團隊想瞭解流量模式，並預測何時應新增後端資源或進行其他重要調整。
• 業務主管：業務主管想瞭解 API 投資的效益，以及日後應在哪些地方投資 API 廣告。

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

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

在訂閱機構中使用 Apigee API Analytics

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

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

使用即付即用機構搭配 Apigee API Analytics

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

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

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

Apigee API Analytics 會收集及分析 API Proxy 中流動的各種資料，例如：

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

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

如何收集自訂分析資料？

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

您可以使用 DataCapture 政策收集自訂的數據分析資料，然後使用數據分析 UI 或 API 檢查所收集的資料。

分析資料何時可供使用？保留多久？

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

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

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

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

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

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

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

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

• 如果您是訂閱客戶，並使用 Apigee 佈建精靈設定 Apigee，則在設定Analytics 託管區域時，您會在建立組織步驟 1 中指定 Analytics 區域。
• 如果您是預付費客戶，且使用 Google Cloud 控制台安裝 Apigee，則在設定Analytics 託管區域時，您會在建立組織第 3 步驟中指定 Analytics 區域。
• 如果您是訂閱或預付客戶，並透過指令列安裝 Apigee，則在定義環境變數 ANALYTICS_REGION 時，您已指定 Analytics 區域。
• 如果您使用 按一下選項安裝 Apigee，數據分析資料會儲存在 us-west1 區域。您無法變更這個預設位置。

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

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

如何存取數據分析資料？

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

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

數據分析資訊主頁

Apigee UI 提供一組預先定義的資訊主頁，方便您查看數據分析資料。

自訂報表

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

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

您也可以將自訂報表中顯示的圖表類型設為長條圖或折線圖。下圖顯示每秒交易數的圖表範例，按 API 代理程式分組：

• 欄：每個 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，將整天 Analytics 資料從 Apigee 匯出至自己的資料存放區，例如 Google Cloud Storage 或 BigQuery。接著，您就能利用 Google Cloud BigQuery 和 TensorFlow 提供的強大查詢和機器學習功能，自行執行資料分析。

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

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

將應用程式開發人員視為客戶時，您會希望確保他們能取得所需工具和資訊，以便充分運用 API。

應用程式開發人員不僅關心應用程式的品質，也非常重視 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 代理程式中加入安全性政策，驗證 API 金鑰和/或安全性權杖。請參閱下列主題：VerifyAPIKey 政策、OAuthV2 政策 和 VerifyJWT 政策。

您可以參閱下列教學課程，瞭解如何透過必要步驟查看開發人員和應用程式的數據分析：透過要求 API 金鑰保護 API和使用 OAuth 保護 API。

Apigee Hybrid 需求

本節列出 Apigee 混合式使用者須知的重要資訊。

支援資料落地

• 如果您有新建立的 Apigee hybrid v1.13.1 組織，且已啟用資料儲存地點，請按照「使用 Apigee hybrid 的資料儲存地點」中的步驟操作。
• 所有 Synchronizer 節點的時間都應同步，並以世界標準時間為準。

舊版 Apigee hybrid 不支援 Apigee API Analytics。

其他需求

• 您必須先設定 apigee-udca 服務帳戶。請參閱「指定設定值覆寫值」。
• 所有 Synchronizer 節點的時間都應同步，並以世界標準時間為準。

更多資訊

• 使用數據分析資訊主頁
• 建立及管理自訂報表
• 使用 Metrics API