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

每秒的平均交易次數，也就是 API 代理要求。請注意，如果某個時間範圍內的交易次數較低，且平均每秒交易次數小於小數點後兩位，則在 UI 自訂報表中可能會顯示為零。

API 語法：tps

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

API 語法：sum(cache_hit)

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

API 語法：avg(ax_cache_l1_count)

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

政策錯誤通常是設計上的結果。舉例來說，當要求中傳遞無效的 API 金鑰時，VerifyApiKey 政策會擲回錯誤，而當 API 呼叫次數超過政策中定義的限制時，SpikeArrest 政策會擲回錯誤。因此，這個指標很適合用來找出 API 中的潛在問題點。舉例來說，以 developer_app 維度分組的 policy_error 指標，可能會協助您發現特定應用程式的 API 金鑰或 OAuth 權杖已過期；或者，您可能會發現特定 API 代理程式會擲回許多 SpikeArrest 政策錯誤，導致您發現代理程式的尖峰封鎖限制無法解決假日流量增加的問題。

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

錯誤時的政策名稱 (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)

Apigee 處理傳入要求所需的時間 (平均、最小或最大值)，以 毫秒 為單位。時間從要求抵達 Apigee 開始計算，並在 Apigee 將要求轉送至目標服務時結束。

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

API 語法：max(request_processing_latency)

Apigee 收到的要求酬載大小，以位元組為單位。

API 語法：avg(request_size)

在指定時間範圍內執行 ResponseCache 政策的總次數。

由於 ResponseCache 政策會附加在 API Proxy 的兩個位置 (一次在要求中，一次在回應中)，因此通常會在 API 呼叫中執行兩次。快取 GET 和快取 PUT 各自計為一次執行。

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

在偵錯工具中，您可以按一下已執行 API 呼叫中的 ResponseCache 圖示，然後查看 responsecache.executed 流量變數，瞭解是否有快取執行作業 (值為 1)。

API 語法：sum(ax_cache_executed)

Apigee 處理 API 回應所需的時間 (平均、最小或最大值)，以 毫秒 為單位。時間點從 API 代理程式收到目標服務回應開始，到 Apigee 將回應轉寄給原始呼叫端時結束。

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

API 語法：min(response_processing_latency)

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

API 語法：max(response_size)

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

API 語法：sum(target_error)

目標伺服器回應呼叫所需的時間長度 (總和、平均值、最小值或最大值)，以毫秒為單位。這個指標會顯示目標伺服器的效能。時間從 Apigee 將要求轉送至目標服務開始計算，並在 Apigee 收到回應時結束。

請注意，如果 API 呼叫傳回快取的回應 (例如使用 ResponseCache 政策)，則該呼叫將永遠無法到達目標服務，且不會記錄目標回應時間指標。

API 語法：avg(target_response_time)

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

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

API 語法：avg(total_response_time)

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

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

API 語法：sum(message_count)

代表設定費、週期性費用或預付儲值金額。

API 語法：sum(fees)

開發人員在交易收益中的分潤。只有在您在費率方案中啟用收益分潤功能時，Apigee 才會計算開發人員的分潤。

開發人員的收益分配比例會根據下列公式計算：

系統會從費率方案擷取分享百分比的值。

API 語法：sum(x_apigee_mintng_dev_share)

交易的總收益。交易的收益會設為 DataCapture 政策中擷取的 revShareGrossPrice 營利變數值。

API 語法：sum(x_apigee_mintng_price)

乘以此係數 (調節係數) 後，每筆交易的費用就會相應調整。每筆交易費用會在費率方案的以使用量為準的費用中指定。

API 語法：avg(x_apigee_mintng_price_multiplier)

交易的收費率。 系統會使用以下公式計算交易費用：

系統會從費率方案擷取以用量為準的定價費率值，且只有在 DataCapture 政策擷取變數時，perUnitPriceMultiplier 值才會相乘。

API 語法：sum(x_apigee_mintng_rate)

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

  如果不符合上述條件，您會看到 (not set) 值。另請參閱「 數據分析實體值『(未設定)』代表什麼意義？」。

• 在費用指標的情況下，API 產品會對應到應收取設定費或週期性費用的費率方案。預付儲值的值為空白。

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

在偵錯工具中，當您選取從快取讀取或寫入快取的 ResponseCache 政策時，您可以在 responsecache.cachekey 流程變數中看到這個值。

快取名稱，其中包含 ResponseCache 政策使用的鍵/值，前面加上 orgName__envName__。舉例來說，如果組織為 myorgf、環境為 test，且快取名稱為 myCache，ax_cache_name 就是 foo__test__myCache。

在偵錯工具中，選取 ResponseCache 政策後，您可以在 responsecache.cachename 流程變數中看到這個值。

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

在偵錯工具中，選取 ResponseCache 政策後，您可以在 responsecache.cachesource 流程變數中看到這個值。

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

提出 API 呼叫的開發人員應用程式消費者金鑰 (API 金鑰)，無論是在要求中以 API 金鑰的形式傳遞，或是納入 OAuth 權杖，皆適用。

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

如果不符合上述條件，您會看到 (not set) 值。另請參閱「數據分析實體值『(未設定)』代表什麼意義？」。

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

如要取得這個維度，應用程式必須與一或多個包含要呼叫的 API 代理程式的 API 產品建立關聯，且代理程式必須檢查 API 呼叫中傳送的 API 金鑰或 OAuth 權杖。鍵或權杖會標示開發人員應用程式。詳情請參閱「如何產生完整的分析資料？」。

如果不符合上述條件，您會看到 (not set) 值。另請參閱「數據分析實體值『(未設定)』代表什麼意義？」。

• 應用程式發出 API 呼叫的 Apigee 註冊開發人員電子郵件地址。這個欄位不會為 AppGroup 應用程式設定。

  為了取得這個維度，開發人員或 AppGroup 必須有與一或多個 API 產品相關聯的應用程式，這些 API 產品包含要呼叫的 API 代理程式，而代理程式必須檢查 API 呼叫中傳送的 API 金鑰或 OAuth 權杖。金鑰或權杖可識別開發人員應用程式。詳情請參閱「如何產生完整的分析資料？」。

  如果不符合上述條件，您會看到 (not set) 值。另請參閱「數據分析實體值『(未設定)』代表什麼意義？」。

• 在費用指標的情況下，應向開發人員收取設定費、週期性費用或預付儲值金。

以 org_name@@@unique_id 格式呈現的 Apigee 產生專屬開發人員 ID。對於 AppGroups，unique_id 是 AppGroup 名稱。

如要取得這個維度，開發人員的應用程式必須與一或多個含有要呼叫的 API 代理程式的 API 產品相關聯，且代理程式必須檢查 API 呼叫中傳送的 API 金鑰或 OAuth 權杖。金鑰或權杖可識別開發人員。詳情請參閱「如何產生完整的數據分析資料？」。

如果不符合上述條件，您會看到 (not set) 值。另請參閱「數據分析實體值『(未設定)』代表什麼意義？」。

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

在發生錯誤的 API Proxy 中，命名為 flow。例如 PreFlow、PostFlow 或您建立的條件式動態饋給名稱。

請注意，在 Apigee API 中使用的完整名稱是 ax_execution_fault_flow_name，沒有換行符號。

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

發生錯誤的 API Proxy 流程狀態名稱，例如 PROXY_REQ_FLOW 或 TARGET_RESP_FLOW。

請注意，在 Apigee API 中使用的完整名稱為 ax_execution_fault_flow_state，沒有換行符號。

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

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

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

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

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

部署 Proxy 的 API Proxy 類型。指定 Proxy 類型後，系統只會顯示該 Proxy 類型的結果。可能的值為 STANDARD、EXTENSIBLE 或未設定。

資源路徑已新增至 API Proxy 基礎路徑。舉例來說，如果 API 代理程式的基準網址為 https://apigeedocs-test.apigee.net/hello/，且呼叫 https://apigeedocs-test.apigee.net/hello/json，則 pathsuffix 為 /json。

如果未使用 pathsuffix，則值為空白。

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

來源用戶端 IP 位址。這會使用預設的用戶端 IP 位址解析，或是在已設定的用戶端 IP 解析中設定的演算法。

在預設行為中，系統會根據 ax_true_client_ip 和 x_forwarded_for_ip 維度中的值計算 ax_resolved_client_ip 維度的值。

請注意，如果使用 Akamai 等路由產品擷取用戶端的實際 IP 位址，用戶端 IP 會透過 HTTP 標頭 True-Client-IP 傳遞至 Apigee，然後用於設定 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)。

發出呼叫的裝置作業系統版本。

將這個維度與 OS Family (ax_ua_os_family) 搭配使用，做為第二個深入查看維度，即可查看作業系統版本。

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

使用 Akamai 等路由產品擷取用戶端的實際 IP 位址時，用戶端 IP 會透過 HTTP 標頭 True-Client-IP 傳送至 Apigee。這個維度會從該標頭擷取真實的用戶端 IP。

為判斷透過 ax_resolved_client_ip 維度存取的原始用戶端 IP 位址，Apigee 會使用 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) 搭配使用，做為第二個深入查詢維度，以便取得代理程式系列的版本。

目標服務的資源路徑 (不含網域)，不含代理程式 <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，表示要求從未抵達目標服務。當回應由 ResponseCache 政策提供，或要求處理作業發生錯誤時，就會發生這種情況。

這與回應狀態碼 (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 資料流變數覆寫網址。

在Proxy 鏈結中，呼叫 Proxy 中的 target_url 為空值。

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

為判斷透過 ax_resolved_client_ip 維度存取的原始用戶端 IP 位址，Apigee 會使用 ax_true_client_ip 和 x_forwarded_for_ip 維度。

用戶端用來連線至路由器的通訊協定。有效值包括 http 或 https。

根據 24 小時制，API 呼叫發生的 2 位數小時。舉例來說，如果 API 呼叫是在晚上 10 點到 11 點之間發出，則 ax_hour_of_day 會是 22。

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

目前僅適用於 Apigee 組織，不適用於 Apigee Hybrid 組織。

為應用程式開發人員和 API 產品新增費率時的 Unix 時間戳記。

• 交易收益的幣別會設為 DataCapture 政策中擷取的 currency 營利變數值。這個幣別與 revShareGrossPrice 的幣別相關聯。
• 在「費用」指標的情況下，這會是設定費、週期性費用或預付儲值的幣別。

目前僅適用於 Apigee 機構，不適用於 Apigee 混合機構。

應用程式開發人員的營利費率方案。