數據分析指標、維度和篩選器參考資料

每秒的平均交易數，也就是 API Proxy 要求數。 請注意，如果時間範圍內的交易次數相對較少，且小於兩位小數，則使用者介面自訂報表中的每秒平均交易次數可能會顯示為零。

API 語法：tps

使用回應快取而非目標服務回應的成功 API 要求數量。

API 語法：sum(cache_hit)

傳回指定時間範圍內，每筆交易的 L1 (記憶體內) 快取元素數量。舉例來說，如果您選擇 max 做為一天中的時間範圍，且特定交易在該時間範圍內快取中的元素數量最多為 12 個，則計數為 12。以 avg 為例，如果您查詢的時間範圍內有三筆交易，且快取計數分別為 5、6 和 7，則平均值為 6。如「快取內部機制」一文所述，L1 快取是記憶體內快取，而非 L2 資料庫快取。

API 語法：avg(ax_cache_l1_count)

指定時間範圍內的政策錯誤總數。

政策錯誤通常是設計上的問題。舉例來說，如果要求中傳遞的 API 金鑰無效，Verify API Key 政策就會擲回錯誤；如果 API 呼叫次數超過政策中定義的限制，Spike Arrest 政策就會擲回錯誤。因此，這項指標有助於找出 API 中的潛在問題點。舉例來說，依據 developer_app 維度分組的 policy_error 指標，可能有助於您發現特定應用程式的 API 金鑰或 OAuth 權杖已過期；或者您可能會發現特定 API 代理伺服器會擲回大量 Spike Arrest 錯誤，進而發現代理伺服器的尖峰流量限制未考量到節慶流量增加。

只有在政策錯誤導致 API Proxy 失敗時，系統才會在 Analytics 中記錄這項錯誤。 舉例來說，如果政策的 continueOnError 屬性設為 true，即使政策失敗，API Proxy 仍會繼續處理要求。在這種情況下，系統不會在 Analytics 中記錄政策錯誤。

「發生錯誤時的政策名稱 (ax_execution_fault_policy_name)」維度可依政策名稱分組政策錯誤，非常實用。

目標失敗 (例如 404 或 503) 不算政策失敗。這些都會計為 API Proxy 失敗 (is_error)。

API 語法：sum(policy_error)

指定時間範圍內 API Proxy 失敗的總次數。如果政策失敗或發生執行階段錯誤 (例如目標服務傳回 404 或 503)，就可能發生 Proxy 失敗。

Proxy (apiproxy) 維度有助於依 Proxy 將 API Proxy 失敗分組。

API 語法：sum(is_error)

Edge 處理傳入要求所需的時間 (平均、最短或最長)，以毫秒為單位。時間從要求抵達 Edge 開始，到 Edge 將要求轉送至目標服務為止。

您可以運用不同維度，依 API Proxy、開發人員應用程式、區域等檢查要求處理延遲時間。

API 語法：max(request_processing_latency)

Edge 收到的要求酬載大小 (以位元組為單位)。

API 語法：avg(request_size)

在指定時間範圍內，執行回應快取政策的總次數。

由於 Response Cache 政策會附加至 API Proxy 的兩個位置 (要求和回應各一次)，因此通常會在 API 呼叫中執行兩次。快取「get」和快取「put」各算一次執行作業。

不過，如果政策中的 <SkipCacheLookup> 元素評估結果為 true (在要求中)，回應快取執行次數為 0；如果政策中的 <SkipCachePopulation> 元素評估結果為 true (在回應中)，回應快取執行次數也為 0。

在 追蹤工具 中，您可以點選已執行的 API 呼叫中的「回應快取」圖示，並查看 responsecache.executed 流程變數，瞭解是否執行快取 (值為 1)。

API 語法：sum(ax_cache_executed)

Edge 處理 API 回應所需的時間 (平均、最短或最長)，以毫秒為單位。時間從 API Proxy 收到目標服務回應開始，到 Apigee 將回應轉送給原始呼叫端為止。

您可以使用不同維度，依 API Proxy、區域等檢查回應處理延遲時間。

API 語法：min(response_processing_latency)

傳回用戶端的回應酬載大小 (以位元組為單位)。

API 語法：max(response_size)

目標服務的 5xx 回應總數。這些是目標服務錯誤，並非由 Apigee 造成。

API 語法：sum(target_error)

目標伺服器回應呼叫所需的時間量 (總和、平均值、最小值或最大值)，以毫秒為單位。這項指標可顯示目標伺服器的效能。時間從 Edge 將要求轉送至目標服務開始，到 Edge 收到回應為止。

請注意，如果 API 呼叫從快取傳回回應 (例如使用「回應快取」政策)，呼叫就不會連線至目標服務，也不會記錄任何目標回應時間指標。

API 語法：avg(target_response_time)

從 Edge 接收用戶端要求到 Edge 將回應傳回給用戶端之間的時間量 (總和、平均值、最小值或最大值)，以毫秒為單位。這段時間包括網路額外負荷 (例如負載平衡器和路由器執行作業所需的時間)、要求處理延遲時間、回應處理延遲時間，以及目標回應時間 (如果回應是從目標服務而非快取提供)。

您可以使用不同維度，依 API Proxy、開發人員應用程式、區域等檢查處理延遲。

API 語法：avg(total_response_time)

Edge 在指定時間範圍內處理的 API 呼叫總數。

使用維度，以對您最有意義的方式將流量計數分組。

API 語法：sum(message_count)

包含所呼叫 API Proxy 的 API 產品名稱。如要取得這個維度，進行呼叫的開發人員應用程式必須與一或多個包含 API Proxy 的 API 產品建立關聯，且呼叫的 Proxy 必須檢查 API 呼叫傳送的 API 金鑰或 OAuth 權杖。金鑰或權杖與 API 產品相關聯。詳情請參閱「首先：如何產生完整的數據分析資料」。

如未符合上述條件，系統會顯示「(not set)」值。另請參閱「 數據分析實體值『(not set)』代表什麼意義？」。

包含所存取 Response Cache 值的鍵。如要進一步瞭解如何建構回應快取的鍵，請參閱「回應快取政策」。

在追蹤工具中，選取從快取讀取或寫入快取的 Response Cache 政策時，您可以在 responsecache.cachekey flow 變數中看到這個值。

包含 Response Cache 政策所用鍵/值的快取名稱，並以 orgName__envName__ 為前置字元。舉例來說，如果機構是「foo」、環境是「test」，而快取名稱是「myCache」，則 ax_cache_name 為 foo__test__myCache。

在「追蹤工具」中，選取「回應快取」政策時，您可以在responsecache.cachename 流程變數中查看這個值。

擷取回應快取的快取層級 (「L1」記憶體內或「L2」資料庫)。如果回應是從目標而非快取 (且回應快取已使用目標回應重新整理) 傳送，或要求中的快取鍵無效，這個維度也會顯示「CACHE_MISS」。快取金鑰大小上限為 2 KB。

在「追蹤工具」中，選取「回應快取」政策時，您可以在 responsecache.cachesource 流程變數中看到這個值。

如要進一步瞭解快取層級，請參閱「快取內部機制」。

發出 API 呼叫的開發人員應用程式的用戶端金鑰 (API 金鑰)，無論是做為 API 金鑰傳遞至要求，還是納入 OAuth 權杖。

如要取得這個維度，接收呼叫的 Proxy 必須設定為檢查有效的 API 金鑰或 OAuth 權杖。在 Edge 中註冊應用程式時，開發人員應用程式會取得 API 金鑰，可用於產生 OAuth 權杖。詳情請參閱「首先：如何產生完整的數據分析資料」。

如未符合上述條件，系統會顯示「(not set)」值。另請參閱「What does an analytics entity value "(not set)" mean?」。

發出 API 呼叫的 Edge 註冊開發人員應用程式。

如要取得這個維度，應用程式必須與一或多個 API 產品建立關聯，這些產品包含要呼叫的 API Proxy，且 Proxy 必須檢查 API 呼叫傳送的 API 金鑰或 OAuth 權杖。這個金鑰或權杖會識別開發人員應用程式。詳情請參閱「首要步驟：如何產生完整的數據分析資料」。

如未符合上述條件，系統會顯示「(not set)」值。另請參閱「What does an analytics entity value "(not set)" mean?」。

應用程式發出 API 呼叫時，在 Edge 註冊的開發人員電子郵件地址。

如要取得這個維度，開發人員必須將應用程式與一或多個 API 產品建立關聯，這些產品包含要呼叫的 API Proxy，且 Proxy 必須檢查 API 呼叫傳送的 API 金鑰或 OAuth 權杖。這個金鑰或權杖會識別開發人員應用程式。詳情請參閱「第一步：如何產生完整的數據分析資料」。

如未符合上述條件，系統會顯示「(not set)」值。另請參閱「What does an analytics entity value "(not set)" mean?」。

Edge 產生的專屬開發人員 ID，格式為 org_name@@@unique_id。

如要取得這個維度，開發人員必須讓應用程式與一或多個 API 產品建立關聯，這些產品包含要呼叫的 API Proxy，且 Proxy 必須檢查 API 呼叫傳送的 API 金鑰或 OAuth 權杖。這個金鑰或權杖是用來識別開發人員。詳情請參閱「第一步：如何產生完整的數據分析資料」。

如未符合上述條件，系統會顯示「(not set)」值。另請參閱「What does an analytics entity value "(not set)" mean?」。

錯誤的錯誤代碼。例如： messaging.adaptors.http.flow.GatewayTimeout

API Proxy 中引發錯誤的已命名流程。例如「PreFlow」、「PostFlow」或您建立的條件流程名稱。

請注意，管理 API 中使用的完整名稱為 ax_execution_fault_flow_name， 不含換行符。

如果沒有發生錯誤，您會看到「(not set)」值。

引發錯誤的 API Proxy 流程名稱，例如「PROXY_REQ_FLOW」或「TARGET_RESP_FLOW」。

請注意，管理 API 中使用的完整名稱是 ax_execution_fault_flow_state，沒有換行符。

導致 API 呼叫失敗並擲回錯誤的政策名稱。

請注意，管理 API 中使用的完整名稱為 ax_execution_fault_policy_name，沒有換行符。

如果政策擲回錯誤，但政策根屬性 continueOnError 設為 true，API Proxy 流程會繼續執行，不會失敗，且政策失敗不會計入這個維度。

在 API Proxy ProxyEndpoint 上設定的 BasePath。基本路徑不包含 API 代理網址的網域和連接埠部分。舉例來說，如果 API Proxy 的基準網址是 https://apigeedocs-test.apigee.net/releasenotes/，則基準路徑為 /releasenotes。

這個值也會儲存在 proxy.basepath 流程變數中。

新增至 API Proxy 底層路徑的資源路徑。舉例來說，如果 API Proxy 的基準網址為 https://apigeedocs-test.apigee.net/hello/，且呼叫是傳送至 https://apigeedocs-test.apigee.net/hello/json，則路徑尾碼為 /json。

如果未使用任何路徑後置字串，這個值會是空白。

這個值也會儲存在 proxy.pathsuffix 流程變數中。

內含來源用戶端 IP 位址。ax_resolved_client_ip 維度的值是根據 ax_true_client_ip 和 x_forwarded_for_ip 維度的值計算而來。

請注意，使用 Akamai 等路由產品擷取用戶端的真實 IP 位址時，用戶端 IP 會在 HTTP 標頭 True-Client-IP 中傳遞至 Edge，然後用於設定 ax_true_client_ip 維度。

ax_resolved_client_ip 維度的值計算方式如下：

1. 如果 ax_true_client_ip 不是空值，且不包含本機 IP 位址，請將 ax_resolved_client_ip 設為 ax_true_client_ip。
2. 否則，請將 ax_resolved_client_ip 設為 x_forwarded_for_ip 中的第一個非本機 IP 位址。
3. 如果 ax_true_client_ip 和 x_forwarded_for_ip 都只包含本機 IP 位址，請將 ax_resolved_client_ip 設為 x_forwarded_for_ip 中的第一個本機 IP 位址。
4. 如果 ax_true_client_ip 和 x_forwarded_for_ip 皆為空值，請將 ax_resolved_client_ip 設為 (not set)。
5. 如果 ax_true_client_ip 是本機 IP 位址，且 x_forwarded_for_ip 為空值，請將 ax_resolved_client_ip 設為 (not set)。

撥號裝置的作業系統版本。

建議您將這個維度與作業系統系列 (ax_ua_os_family) 搭配使用，做為第二個「向下鑽取」維度，查看作業系統版本。

呼叫端用戶端的 IP 位址，儲存在 proxy.client.ip 流程變數中。 這通常是來電的 X-Forwarded-For 位址，也就是 Edge 從最後一次外部 TCP 交握收到的 IP 位址。這可能是呼叫端用戶端或負載平衡器。如果 X-Forwarded-For 標頭中有多個 IP，這就是列出的最後一個 IP。

使用 Akamai 等路由產品擷取用戶端的真實 IP 位址時，用戶端 IP 會在 HTTP 標頭 True-Client-IP 中傳遞至 Edge。這個維度會從該標頭擷取這些真實用戶端 IP。

如要判斷原始用戶端 IP 位址 (透過 ax_resolved_client_ip 維度存取)，Edge 會使用 ax_true_client_ip 和 x_forwarded_for_ip 維度。

目標服務的資源路徑 (不含網域)，不包括查詢參數。

舉例來說，Apigee 範例目標 http://mocktarget.apigee.net 包含多個資源，包括 /user，可傳回問候語。無論 API Proxy 如何呼叫 http://mocktarget.apigee.net/user，request_path 都是 /user。

目標服務的資源路徑 (不含網域)，包括查詢參數。

舉例來說，Apigee 範例目標 http://mocktarget.apigee.net 包含多個資源，包括 /user?user={name} 資源和查詢參數，可根據提供的名稱傳回自訂問候語。無論 API Proxy 如何呼叫 http://mocktarget.apigee.net/user?user=Dude，request_uri 都是 /user?user=Dude。

用於發出 API 呼叫的使用者代理程式或軟體代理程式名稱。 範例：

• Pixel XL 透過 Chrome 撥打電話：Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36
• 透過 Chrome 撥打電話的 iPad：Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1
• 透過終端機使用 cURL：curl/7.51.0

使用者代理程式的版本。

建議您將這個維度與使用者代理程式系列 (ax_ua_agent_family) 搭配使用，做為第二個「向下鑽取」維度，取得代理程式系列的相關版本。

目標服務的資源路徑 (不含網域)，不包括查詢參數，也就是在 Proxy 的 <TargetEndpoint> 中定義的路徑。

舉例來說，假設 API Proxy 呼叫下列目標：

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

在本範例中，target_basepath 為 /user。

如果目標是：

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net</URL>
</HTTPTargetConnection>

target_basepath 會是空值。

在「追蹤工具」中，當您選取流程圖結尾的 AX 圖示時，target.basepath 流程變數會對應至 target_basepath 維度。

目標服務傳回給 API Proxy 的 HTTP 回應狀態碼，例如 200、404、503 等。

如果值為「null」，表示要求從未送達目標服務。如果回應是由「回應快取」政策提供，或要求處理失敗，就會發生這種情況。

這與回應狀態碼 (response_status_code) 維度不同。

API Proxy TargetEndpoint 中定義的目標服務完整網址。

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

在本範例中，target_url 為 http://mocktarget.apigee.net/user?user=Dude。

請注意，您也可以在 API Proxy 處理期間，使用 target.url flow 變數覆寫網址。

在Proxy 鏈結和使用指令碼目標 (Node.js) 時，呼叫 Proxy 中的 target_url 為空值。

X-Forwarded-For 標頭中的 IP 位址清單。

如要判斷原始用戶端 IP 位址 (透過 ax_resolved_client_ip 維度存取)，Edge 會使用 ax_true_client_ip 和 x_forwarded_for_ip 維度。

以 24 小時制為準，API 呼叫發生的時間 (以 2 位數表示)。舉例來說，如果在晚上 10 點到 11 點之間發出 API 呼叫，ax_hour_of_day 會是 22。

時間值以世界標準時間為準。