次の方法で共有


Azure API Management で API 分析を取得する

適用対象: 開発者 | Basic | Basic v2 | Standard | Standard v2 | Premium

Azure API Management では、API の使用状況とパフォーマンスを分析できるように、API の分析が提供されます。 API の高レベルの監視とトラブルシューティングを行うために分析を使用します。 診断と監査のためのほぼリアルタイムのメトリックとリソース ログを含む、その他の監視機能については、チュートリアル: 公開された API の監視に関するページを参照してください。

ポータルの API 分析のスクリーンショット。

Note

現在、この機能はワークスペースでは使用できません。

API 分析について

  • API Management では、Azure Monitor ベースのダッシュボードを使用した分析が提供されます。 ダッシュボードは、Azure Log Analytics ワークスペース内のデータを集計します。

  • 従来の API Management サービス レベルでは、API Management インスタンスには Azure portal の従来の組み込み分析も含まれており、API Management REST API を使用して分析データにアクセスできます。 ほとんど同様のデータが Azure Monitor ベースのダッシュボードと組み込み分析内に表示されます。

重要

  • Azure Monitor ベースのダッシュボードは、分析データへのアクセスに推奨される方法です。
  • 組み込み (クラシック) 分析は、v2 レベルでは利用できません。

API 分析では、次のような複数のディメンションにわたる、API Management インスタンスでの API の使用状況とパフォーマンスを分析します。

  • 時刻
  • [地理的な場所]
  • API
  • API 操作
  • 製品
  • サブスクリプション
  • ユーザー
  • Requests

Note

  • API 分析によって、要求 (失敗した要求や承認されていない要求を含む) に関するデータが提供されます。
  • 地理的な場所の値は、IP アドレス マッピングに基づく近似値です。
  • 分析データの可用性に 15 分以上の延期期間が発生する場合があります。

Azure Monitor ベースのダッシュボード

Azure Monitor ベースのダッシュボードを使用するには、API Management ゲートウェイ ログのデータ ソースとして Log Analytics ワークスペースが必要になります。

構成する必要がある場合は、ゲートウェイ ログを Log Analytics ワークスペースに送信するための次の簡単な手順に従ってください。 詳細については、「チュートリアル: 発行された APIの監視」を参照してください。 これは 1 回限りの作業です。

  1. Azure portal で、API Management インスタンスに移動します。
  2. 左側のメニューの [監視] で、[診断設定]>[+ 診断設定を追加する] を選択します。
  3. 診断設定にわかりやすい名前を付けます。
  4. [ログ] で、[ApiManagement Gateway に関連するログ] を選択します。
  5. [宛先の詳細] で、[Log Analytics への送信] を選択し、同じサブスクリプションまたは別のサブスクリプションにある Log Analytics ワークスペースを選択します。 ワークスペースを作成する必要がある場合は、Log Analytics ワークスペースの作成に関する記事を参照してください。
  6. ターゲット テーブルで [Resource specific] (リソース固有) が選択されていることを確認します。
  7. [保存] を選択します。

ダッシュボードにアクセスする

Log Analytics ワークスペースを構成したら、Azure Monitor ベースのダッシュボードにアクセスして、API の使用状況とパフォーマンスを分析します。

  1. Azure portal で、API Management インスタンスに移動します。
  2. 左側のメニューで、 [監視] の下から [分析] を選択します。 分析ダッシュボードが開きます。
  3. データの時間の範囲を選択します。
  4. [タイムライン][地理的な場所] など、分析データのレポート カテゴリを選択します。

レガシ組み込み分析

特定の API Management サービス レベルでは、Azure portal 内で ("レガシ分析" または "クラシック分析" とも呼ばれる) 組み込み分析も利用でき、分析データには API Management REST API を使用してアクセスできます。

組み込みの分析 - ポータル

Azure portal で組み込み (クラシック) 分析にアクセスするには:

  1. Azure portal で、API Management インスタンスに移動します。
  2. 左側のメニューで、[監視] の下から [分析 (クラシック)] を選択します。
  3. データの時間範囲を選択するか、カスタムの時間範囲を入力します。
  4. [タイムライン][地理的な場所] など、分析データのレポート カテゴリを選択します。
  5. 必要に応じて、1 つ以上の追加のカテゴリでレポートをフィルター処理します。

分析 - REST API

API Management REST API のレポート操作を使用して、API Management インスタンスの分析データを取得し、フィルター処理します。

使用可能な操作は、API、地理的な場所、API 操作、製品、要求、サブスクリプション、時間、またはユーザーごとにレポート レコードを返します。