次の方法で共有

API Management 監視データ リファレンス

  • [アーティクル]

適用対象: すべての API Management レベル

この記事には、このサービスに関するすべての監視リファレンス情報が含まれています。

Azure API Management 用に収集できるデータとその使用方法の詳細については、 Monitor API Management を参照してください。

メトリック

このセクションには、このサービスに関して自動的に収集されるすべてのプラットフォーム メトリックが一覧表示されています。 これらのメトリックは、Azure Monitor でサポートされているすべてのプラットフォーム メトリックのグローバル リストにも含まれています。

メトリックのリテンション期間の詳細については、「Azure Monitor メトリックの概要」を参照してください。

Microsoft.ApiManagement/service でサポートされているメトリック

次の表に、Microsoft.ApiManagement/service リソースの種類で使用できるメトリックの一覧を示します。

  • すべての列がすべてのテーブルに存在しないことがあります。
  • 一部の列がページの表示領域を超えている場合があります。 [テーブルの展開] を選択すると、使用可能なすべての列が表示されます。

テーブルの見出し

  • カテゴリ - メトリック グループまたは分類。
  • メトリック - Azure Portal に表示されるメトリックの表示名。
  • REST API の名前 - REST API で参照されるメトリック名。
  • 単位 - 測定単位。
  • 集計 - 既定の集計の種類。 有効な値: 平均 (Avg)、最小 (Min)、最大 (Max)、合計 (Sum)、数。
  • ディメンション - メトリックで使用できるディメンション。
  • 時間グレイン - メトリックをサンプリングする間隔。 たとえば、PT1M は、メトリックを 1 分ごとに、PT30Mは 30 分ごとに、PT1H は 1 時間ごとにサンプリングすることを示します。
  • DS エクスポート - メトリックが診断設定を介して Azure Monitor ログにエクスポート可能かどうかを示します。 メトリックのエクスポートについては、「Azure Monitor で診断設定を作成する」を参照してください。
カテゴリ メトリック REST API での名前 出荷単位 集計 Dimensions 期間粒度 DS エクスポート
ゲートウェイ要求数 バックエンド要求の期間

バックエンド要求の期間 (ミリ秒単位)		 BackendDuration MilliSeconds 「平均」「最大」「最小」 Location、 Hostname、 ApiId PT1M はい
容量 容量

ApiManagement サービスの使用率メトリック。 注: Premium 以外の SKU の場合、"Max" 集計では、値は 0 と表示されます。		 Capacity パーセント Average、Maximum Location PT1M はい
ゲートウェイ WebSocket WebSocket 接続試行 (プレビュー)

選択したソースと宛先に基づく WebSocket 接続試行の数		 ConnectionAttempts カウント 合計 (合計)、平均 Location、 Source、 Destination、 State PT1M はい
容量 ゲートウェイの CPU 使用率

SKUv2 サービスのゲートウェイの CPU 使用率		 CpuPercent_Gateway パーセント Average、Maximum <なし> PT1M はい
ゲートウェイ要求数 ゲートウェイ要求の全体的な期間

ゲートウェイ要求の全体の期間 (ミリ秒単位)		 Duration MilliSeconds 「平均」「最大」「最小」 Location、 Hostname、 ApiId PT1M はい
EventHub イベント 破棄された EventHub イベント

キューのサイズ制限に達したためスキップされたイベントの数		 EventHubDroppedEvents カウント 合計 (和) Location PT1M はい
EventHub イベント 拒否された EventHub イベント

拒否された EventHub イベントの数 (誤った構成または未承認)		 EventHubRejectedEvents カウント 合計 (和) Location PT1M はい
EventHub イベント EventHub イベントの成功

成功した EventHub イベントの数		 EventHubSuccessfulEvents カウント 合計 (和) Location PT1M はい
EventHub イベント 調整された EventHub イベント

調整された EventHub イベントの数		 EventHubThrottledEvents カウント 合計 (和) Location PT1M はい
EventHub イベント EventHub イベントのタイムアウト

タイムアウトした EventHub イベントの数		 EventHubTimedoutEvents カウント 合計 (和) Location PT1M はい
EventHub イベント EventHub イベントのサイズ

EventHub イベントの合計サイズ (バイト単位)		 EventHubTotalBytesSent バイト 合計 (和) Location PT1M はい
EventHub イベント EventHub イベントの合計数

EventHub に送信されるイベントの数		 EventHubTotalEvents カウント 合計 (和) Location PT1M はい
EventHub イベント 失敗した EventHub イベント

失敗した EventHub イベントの数		 EventHubTotalFailedEvents カウント 合計 (和) Location PT1M はい
ゲートウェイ要求数 失敗したゲートウェイ要求 (非推奨)

ゲートウェイ要求の失敗数 - 代わりに、GatewayResponseCodeCategory ディメンションで多次元要求メトリックを使用します		 FailedRequests カウント 合計 (和) Location, Hostname PT1M はい
容量 ゲートウェイのメモリの割合

SKUv2 サービスのゲートウェイのメモリの割合		 MemoryPercent_Gateway パーセント Average、Maximum <なし> PT1M はい
ネットワークの状態 リソースのネットワーク接続状態 (プレビュー)

API Management サービスからの依存リソースの種類のネットワーク接続状態		 NetworkConnectivity カウント 合計 (合計)、平均 Location, ResourceType PT1M はい
ゲートウェイ要求数 その他のゲートウェイ要求 (非推奨)

その他のゲートウェイ要求の数 - 代わりに、GatewayResponseCodeCategory ディメンションで多次元要求メトリックを使用します		 OtherRequests カウント 合計 (和) Location, Hostname PT1M はい
ゲートウェイ要求数 要求数

複数のディメンションを持つゲートウェイ要求メトリック		 Requests カウント 合計 (合計)、最大値、最小値 Location、 Hostname、 LastErrorReason、 BackendResponseCode、 GatewayResponseCode、 BackendResponseCodeCategory、 GatewayResponseCodeCategory、 ApiId PT1M はい
ゲートウェイ要求数 ゲートウェイ要求の成功 (非推奨)

成功したゲートウェイ要求の数 - 代わりに、GatewayResponseCodeCategory ディメンションで多次元要求メトリックを使用します		 SuccessfulRequests カウント 合計 (和) Location, Hostname PT1M はい
ゲートウェイ要求数 ゲートウェイ要求の合計数 (非推奨)

ゲートウェイ要求の数 - 代わりに、GatewayResponseCodeCategory ディメンションで多次元要求メトリックを使用します		 TotalRequests カウント 合計 (和) Location, Hostname PT1M はい
ゲートウェイ要求数 未承認のゲートウェイ要求 (非推奨)

未承認ゲートウェイ要求の数 - 代わりに、GatewayResponseCodeCategory ディメンションで多次元要求メトリックを使用します		 UnauthorizedRequests カウント 合計 (和) Location, Hostname PT1M はい
ゲートウェイ WebSocket WebSocket メッセージ (プレビュー)

選択したソースと宛先に基づく WebSocket メッセージの数		 WebSocketMessages カウント 合計 (合計)、平均 Location、 Source、 Destination PT1M はい

メトリック ディメンション

メトリック ディメンションについては、「多次元メトリック」を参照してください。

このサービスでは、次のディメンションがそのメトリックに関連付けられています。

  • ApiId
  • BackendResponseCode
  • BackendResponseCodeCategory
  • 宛先
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • hostname
  • LastErrorReason
  • Location
  • ResourceType
  • ソース
  • 都道府県

リソース ログ

このセクションでは、このサービス用に収集できるリソース ログの種類を一覧表示します。 このセクションでは、Azure Monitor でサポートされているすべてのリソース ログ カテゴリの種類のリストからプルされます。

Microsoft.ApiManagement/service でサポートされているリソース ログ

カテゴリ カテゴリの表示名 ログ テーブル 基本ログ プランをサポート インジェスト時間変換をサポート クエリの例 エクスポートするコスト
DeveloperPortalAuditLogs 開発者ポータルの使用状況に関連するログ APIMDevPortalAuditDiagnosticLog

API Management 開発者ポータル API の診断ログ。

 はい いいえ はい
GatewayLlmLogs 生成 AI ゲートウェイに関連するログ いいえ 番号 はい
GatewayLogs ApiManagement Gateway に関連するログ ApiManagementGatewayLogs

Azure ApiManagement ゲートウェイ ログ。

 はい はい クエリ いいえ
WebSocketConnectionLogs Websocket 接続に関連するログ ApiManagementWebSocketConnectionLogs

Websocket 接続ログは、API Management Gateway の Websocket 接続イベントに関するログを提供します。 ログ記録は、要求がハンドシェイクのために API Management Gateway に到着したときに開始され、要求が終了するまで開始されます。 すべての要求ログは CorrelationId で一意に識別できます。

 はい いいえ はい

Microsoft.ApiManagement/service/workspaces でサポートされているリソース ログ

カテゴリ カテゴリの表示名 ログ テーブル 基本ログ プランをサポート インジェスト時間変換をサポート クエリの例 エクスポートするコスト
GatewayLogs API Management ワークスペースのゲートウェイ ログ いいえ 番号 はい

Azure Monitor ログ テーブル

このセクションでは、Kusto クエリを使用した Log Analytics によるクエリに使用できる、このサービスに関連するすべての Azure Monitor ログ テーブルを一覧表示します。 テーブルにはリソース ログ データが含まれており、収集されルーティングされる内容によっては、さらに多くのデータが含まれる場合があります。

API Management Microsoft.ApiManagement/service

アクティビティ ログ

リンクされたテーブルには、このサービスのアクティビティ ログに記録できる操作が一覧表示されます。 これらの操作は、アクティビティ ログで使用可能なすべてのリソース プロバイダー操作のサブセットです。

アクティビティ ログ エントリのスキーマの詳細については、「アクティビティ ログのスキーマ」を参照してください。

関連するコンテンツ