共用方式為


API 管理 監視數據參考

適用於:所有 APIM 層

本文包含此服務的所有監視參考資訊。

如需您可以針對 Azure API 管理 收集的數據,以及如何使用它的詳細資訊,請參閱監視 API 管理。

計量

本節列出針對此服務的所有自動收集平台計量。 這些計量也是 Azure 監視器中支援的所有平台計量全域清單的一部分。

如需計量保留的相關資訊,請參閱 Azure 監視器計量概觀

Microsoft.ApiManagement/service 支持的計量

下表列出適用於 Microsoft.ApiManagement/service 資源類型的計量。

  • 所有資料行可能不存在於每個資料表中。
  • 某些資料行可能超出頁面的檢視區域。 選取 [展開資料表] 以檢視所有可用的資料行。

資料表標題

  • 類別 - 計量群組或分類。
  • 計量 - Azure 入口網站中顯示的計量顯示名稱。
  • REST API 中的名稱 - REST API 中所指的計量名稱。
  • 單位 - 測量單位。
  • 彙總 - 預設彙總類型。 有效值:平均值 (Avg)、最小值 (Min)、最大值 (Max)、總計 (Sum)、計數。
  • 維度 - 計量可用的維度
  • 時間精細度 - 取樣計量的間隔。 例如,PT1M 表示計量會每分鐘取樣、每 30 分鐘PT30M、每小時 PT1H,以此類推。
  • DS 匯出 - 計量是否可透過診斷設定,匯出至 Azure 監視器記錄。 如需匯出計量的資訊,請參閱在 Azure 監視器中建立診斷設定
類別 計量 REST API 中的名稱 單位 彙總 維度 時間精細度 DS 匯出
閘道要求 後端要求的持續時間

以毫秒為單位的後端要求持續時間
BackendDuration 毫秒 平均值、最大值、最小值 Location、 、 HostnameApiId PT1M Yes
Capacity 容量

ApiManagement 服務的使用率計量。 注意:對於 Premium 以外的 SKU,'Max' 匯總會將值顯示為 0。
Capacity Percent Average、Maximum Location PT1M Yes
閘道 WebSocket WebSocket 連線嘗試 (預覽)

根據所選來源和目的地的 WebSocket 連線嘗試計數
ConnectionAttempts 計數 總計(總),平均 Location、 、 SourceDestinationState PT1M Yes
Capacity 閘道的CPU百分比

SKUv2 服務的閘道 CPU 百分比
CpuPercent_Gateway Percent Average、Maximum <none> PT1M Yes
閘道要求 閘道要求的整體持續時間

網關要求的整體持續時間,以毫秒為單位
Duration 毫秒 平均值、最大值、最小值 Location、 、 HostnameApiId PT1M Yes
EventHub 事件 已卸除的 EventHub 事件

因為已達到佇列大小限制而略過的事件數目
EventHubDroppedEvents 計數 總計 (總和) Location PT1M Yes
EventHub 事件 拒絕的 EventHub 事件

拒絕的 EventHub 事件數目(設定錯誤或未經授權)
EventHubRejectedEvents 計數 總計 (總和) Location PT1M Yes
EventHub 事件 成功 EventHub 事件

成功的 EventHub 事件數目
EventHubSuccessfulEvents 計數 總計 (總和) Location PT1M Yes
EventHub 事件 節流事件中樞事件

節流事件數目
EventHubThrottledEvents 計數 總計 (總和) Location PT1M Yes
EventHub 事件 逾時 EventHub 事件

逾時 EventHub 事件的數目
EventHubTimedoutEvents 計數 總計 (總和) Location PT1M Yes
EventHub 事件 EventHub 事件的大小

以位元組為單位的 EventHub 事件大小總計
EventHubTotalBytesSent Bytes 總計 (總和) Location PT1M Yes
EventHub 事件 EventHub 事件總數

傳送至 EventHub 的事件數目
EventHubTotalEvents 計數 總計 (總和) Location PT1M Yes
EventHub 事件 失敗的 EventHub 事件

失敗的 EventHub 事件數目
EventHubTotalFailedEvents 計數 總計 (總和) Location PT1M Yes
閘道要求 失敗的閘道要求 (已淘汰)

網關要求中的失敗次數 - 請改用具有 GatewayResponseCodeCategory 維度的多維度要求計量
FailedRequests 計數 總計 (總和) Location, Hostname PT1M Yes
Capacity 閘道的記憶體百分比

SKUv2 服務的閘道記憶體百分比
MemoryPercent_Gateway Percent Average、Maximum <none> PT1M Yes
網路狀態 資源網路連線狀態 (預覽)

API 管理 服務中相依資源類型的網路連線狀態
NetworkConnectivity 計數 總計(總),平均 Location, ResourceType PT1M Yes
閘道要求 其他閘道要求(已淘汰)

其他閘道要求數目 - 請改用具有 GatewayResponseCodeCategory 維度的多維度要求計量
OtherRequests 計數 總計 (總和) Location, Hostname PT1M Yes
閘道要求 要求

具有多個維度的閘道要求計量
Requests 計數 總計(總),最大值,最小值 LocationHostnameLastErrorReasonBackendResponseCodeGatewayResponseCodeBackendResponseCodeCategory、、、 GatewayResponseCodeCategoryApiId PT1M Yes
閘道要求 成功的閘道要求 (已淘汰)

成功的閘道要求數目 - 請改用具有 GatewayResponseCodeCategory 維度的多維度要求計量
SuccessfulRequests 計數 總計 (總和) Location, Hostname PT1M Yes
閘道要求 閘道要求總數(已淘汰)

網關要求數目 - 請改用具有 GatewayResponseCodeCategory 維度的多維度要求計量
TotalRequests 計數 總計 (總和) Location, Hostname PT1M Yes
閘道要求 未經授權的閘道要求(已淘汰)

未經授權的閘道要求數目 - 請改用具有 GatewayResponseCodeCategory 維度的多維度要求計量
UnauthorizedRequests 計數 總計 (總和) Location, Hostname PT1M Yes
閘道 WebSocket WebSocket 訊息 (預覽)

根據所選來源和目的地的 WebSocket 訊息計數
WebSocketMessages 計數 總計(總),平均 Location、 、 SourceDestination PT1M Yes

載入計量維度

如需計量維度是什麼的資訊,請參閱多維度計量

此服務具有下列與其計量相關聯的維度。

  • ApiId
  • BackendResponseCode
  • BackendResponseCodeCategory
  • Destination
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • 主機名稱
  • LastErrorReason
  • Location
  • ResourceType
  • 來源
  • 州/省

資源記錄

本節列出您可以針對此服務收集的資源記錄類型。 該區段會從 Azure 監視器中支援的所有資源記錄類別類型清單提取。

Microsoft.ApiManagement/service 的支持資源記錄

類別 類別顯示名稱 記錄資料表 支援基本記錄計劃 支援擷取時間轉換 範例查詢 匯出的成本
DeveloperPortalAuditLogs 與開發人員入口網站使用量相關的記錄 APIMDevPortalAuditDiagnosticLog

API 管理 開發人員入口網站 API 的診斷記錄。

Yes
GatewayLlmLogs 與產生的 AI 閘道相關的記錄 No Yes
GatewayLogs 與 ApiManagement 閘道相關的記錄 ApiManagementGatewayLogs

Azure ApiManagement 閘道記錄。

Yes Yes 查詢 No
WebSocketConnectionLogs 與 Websocket 連線相關的記錄 ApiManagementWebSocketConnectionLogs

Websocket 連線記錄會針對 API 管理 閘道提供 websocket 連線事件的記錄。 記錄會在要求到達 API 管理 閘道進行交握時開始,直到要求終止為止。 每個要求記錄都可以使用 CorrelationId 唯一識別。

Yes

Microsoft.ApiManagement/service/workspaces 的支持資源記錄

類別 類別顯示名稱 記錄資料表 支援基本記錄計劃 支援擷取時間轉換 範例查詢 匯出的成本
GatewayLogs API 管理 工作區的閘道記錄 No Yes

Azure 監視器記錄資料表

本節列出與此服務相關的 Azure 監視器記錄資料表,並且該資料表可供 Log Analytics 使用 Kusto 查詢進行查詢。 資料表包含資源記錄資料,而且可能包含更多資料,具體取決於所收集及路由傳送至此的內容。

API 管理 Microsoft.ApiManagement/service

活動記錄檔

連結的資料表會列出此服務活動記錄檔中可記錄的操作。 這些操作是活動記錄中的所有可能資源提供者操作的子集。

如需活動記錄項目結構描述的詳細資訊,請參閱活動記錄結構描述