API Analytics ダッシュボード
API Analytics ダッシュボードでは、API の使用状況を監視するチャートが提供され、API の使用状況とパフォーマンスに関するインサイトを得ることができます。
API 自動検出を有効化している場合、Anypoint Monitoring の API Analytics ダッシュボードで API メトリクスを使用できます。
API Analytics ダッシュボードには、拡張メトリクスと基本メトリクスの 2 つのビューがあります。 拡張メトリクスビューには、API に関する詳細情報が表示され、グラフは表示されるデータの種別に基づいてダッシュボードで並び替えられます。 Anypoint Monitoring を最大限に活用するためには、拡張メトリクスビューを使用して、API に関連する情報を表示してください。
デフォルトでは、拡張メトリクスビューが選択されています。ビューを切り替えるには、[Switch to classic metrics (クラシックメトリクスに切り替える)] を選択します。クラシックメトリクスビューでは、[Show new metrics view (新しいメトリクスビューを表示)] を選択します。
Last 1 hour ラベルが表示されているグラフには、現在の時刻から開始して過去 60 分間に収集されたデータが表示されます。
| Gold および Platinum サブスクリプションの場合、Anypoint Monitoring は API Analytics メトリクスデータを 30 日間保持します。API Manager は、API Analytics メトリクスデータを 30 日間保持します。 |
Mule Runtime Engine のサポート対象バージョン
次の Mule Runtime Engine バージョンと Anypoint Monitoring を使用してください。
-
Mule 3 バージョン 3.8.7 以降
バージョン 3.8.6 以前はサポートされていません。さらに、-AM サフィックスがあるすべてのランタイムバージョンは非推奨です。
インバウンドおよびアウトバウンドのメトリクスは、Mule Runtime Engine バージョン 3.9.5 以前を使用するハイブリッドプロキシアプリケーションでは使用できません。 -
Mule 4
API Analytics の拡張メトリクスを使用するには、Mule Runtime Engine バージョン 4.1.6 以降を使用してください。
API Analytics ダッシュボードを表示する
-
Anypoint Platform にログインします。
-
ナビゲーションバーまたは Anypoint Platform のメイン画面で [Monitoring (監視)] をクリックします。
-
表示する API の [Environment (環境)]、[Resource name (リソース名)]、[Version/Instance (バージョン/インスタンス)] を選択します。
-
[View (表示)] をクリックします。
API Analytics ページが表示され、実行中の管理 API に関する情報が表示されます。 -
統計情報を表示する日時範囲を選択し、[Confirm (確認)] をクリックします。
ページ上部の詳細パネルに、API に関する情報が表示されます。
-
API Manager で API Analytics メトリクスを表示するには、[View API in API Manager (API Manager で API を表示)] リンクをクリックします。
API Analytics ダッシュボードの拡張メトリクスビュー
API Analytics ダッシュボードでは、さまざまなページからさまざまな種類のチャートを表示できます。
API Analytics の拡張メトリクスビューには、以下のチャートが表示されます。
| API Analytics ダッシュボード | チャート |
|---|---|
|
|
|
|
|
|
|
|
|
概要グラフ
[Overview (概要)] ダッシュボードには以下のグラフが表示されます。
- Request Volume (要求量)
-
選択された時間範囲における特定の API に対する要求数の合計。データは 1 分ごとの増分量となります。
- Failed Requests (失敗した要求数)
-
選択された時間範囲における特定の API に対する失敗した要求数の合計。データは 1 分ごとの増分量となります。
- Total 4xx Errors (4xx エラー合計)
-
選択された時間範囲における特定の API に対する 400 エラー (404、408 など) の合計。
- Total 5xx Errors (5xx エラー合計)
-
選択された時間範囲における特定の API に対する 500 エラー (500、502 など) の合計。
- Policy Violations (ポリシー違反)
-
選択された時間範囲でポリシー違反となった、ポリシー違反 ID 別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
- Average Response Time (平均応答時間)
-
選択された時間範囲における特定の API に対する要求への応答時間の平均。データは 1 分ごとの増分量となります。
要求グラフ
[Requests (要求)] ダッシュボードには以下のグラフが表示されます。
- Requests (要求数)
-
選択された時間範囲における、上位 N 本のパスによってグループ化された要求数の合計。N のデフォルトは 100 です。
-
過去 1 時間以内の時間範囲を選択すると、データは 1 分ごとの増分量となります。
-
昨日の時間範囲を選択すると、データは 10 分ごとの増分量となります。
-
1 日より長い時間範囲を選択すると、データは 1 時間ごとの増分量となります。
このメトリクスは、Flex Gateway でデプロイされた API では使用できません。
-
- Requests by Method (メソッド別要求数)
-
選択された時間範囲における、メソッド別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
- Requests by Response Code (応答コード別要求数)
-
選択された時間範囲における、応答コード別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
- Requests by Request Size (要求サイズ別要求数)
-
選択された時間範囲における、要求サイズ別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
- Requests by Response Size (応答サイズ別要求数)
-
選択された時間範囲における、応答サイズ別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
失敗グラフ
[Failures (失敗)] ダッシュボードには以下のグラフが表示されます。
- Failures (失敗数)
-
選択された時間範囲において失敗した、上位 N 本のパスによってグループ化された要求数の合計。N のデフォルトは 100 です。
-
過去 1 時間以内の時間範囲を選択すると、データは 1 分ごとの増分量となります。
-
昨日の時間範囲を選択すると、データは 10 分ごとの増分量となります。
-
1 日より長い時間範囲を選択すると、データは 1 時間ごとの増分量となります。
このメトリクスは、Flex Gateway でデプロイされた API では使用できません。
-
- Failures (メソッド別失敗数)
-
選択された時間範囲において失敗した、メソッド別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
- Requests by Response Code (応答コード別要求数)
-
選択された時間範囲において失敗した、応答コード別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
- Requests by Request Size (要求サイズ別要求数)
-
選択された時間範囲において失敗した、要求サイズ別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
- Requests by Response Size (応答サイズ別要求数)
-
選択された時間範囲において失敗した、応答サイズ別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
パフォーマンスグラフ
[Performance (パフォーマンス)] ダッシュボードには以下のグラフが表示されます。
- Requests by Performance (line chart) (パフォーマンス別要求数 (折れ線チャート))
-
パス別にグループ化された、要求への平均応答時間。
-
過去 1 時間以内の時間範囲を選択すると、データは 1 分ごとの増分量となります。
-
昨日の時間範囲を選択すると、データは 10 分ごとの増分量となります。
-
1 日より長い時間範囲を選択すると、データは 1 時間ごとの増分量となります。
このメトリクスは、Flex Gateway でデプロイされた API では使用できません。
-
- Requests by Performance (Table) (パフォーマンス別要求数 (テーブル))
-
パス別にグループ化された、要求への平均応答時間。
-
過去 1 時間以内の時間範囲を選択すると、データは 1 分ごとの増分量となります。
-
昨日の時間範囲を選択すると、データは 10 分ごとの増分量となります。
-
1 日より長い時間範囲を選択すると、データは 1 時間ごとの増分量となります。
このメトリクスは、Flex Gateway でデプロイされた API では使用できません。
-
- Slow Requests (低速要求数)
-
パス別にグループ化された、1 秒より長い応答時間の平均。このチャートは、Titanium ユーザーにのみ表示されます。
-
過去 1 時間以内の時間範囲を選択すると、データは 1 分ごとの増分量となります。
-
昨日の時間範囲を選択すると、データは 10 分ごとの増分量となります。
-
1 日より長い時間範囲を選択すると、データは 1 時間ごとの増分量となります。
このメトリクスは、Flex Gateway でデプロイされた API では使用できません。
-
クライアントアプリケーショングラフ
[Client Applications (クライアントアプリケーション)] ダッシュボードには以下のグラフが表示されます。
- Requests by Client ID (クライアント ID 別要求数)
-
指定期間における、クライアント ID 別にグループ化された要求数の合計。データは 1 分ごとの増分量となります。
- Requests by Client IP (クライアント IP 別要求数)
-
指定期間における、クライアント IP アドレス別にグループ化された要求数の合計。
-
過去 1 時間以内の時間範囲を選択すると、データは 1 分ごとの増分量となります。
-
昨日の時間範囲を選択すると、データは 10 分ごとの増分量となります。
-
1 日より長い時間範囲を選択すると、データは 1 時間ごとの増分量となります。
このメトリクスは、Flex Gateway でデプロイされた API では使用できません。
-
- Requests by Location (場所別要求数)
-
指定した期間における国別の要求の合計数。[Requests by Location (場所別要求数)] チャートのデータ保持期間は 1 時間です。
このメトリクスは、Flex Gateway でデプロイされた API では使用できません。
基本メトリクスビュー
API の組み込みダッシュボードの [Overview (概要)] セクションには、以下のグラフが表示されます。
-
Requests (要求)
-
Requests by HTTP response code (HTTP 応答コード別要求数)
-
Requests by method (メソッド別要求数)
-
Requests (Avg) (平均要求数)、Average Size of Requests (要求の平均サイズ)、Average Size of Responses (応答の平均サイズ)
-
Requests by HTTP policy violation (HTTP ポリシー違反別要求数)
-
Requests by failure (失敗別要求数)
基本メトリクスビューは、Flex Gateway でデプロイされた API では使用できません。
Requests by HTTP Response Code (HTTP 応答コード別要求数)
指定した期間の API インスタンスの HTTP 応答コード別要求総数に関する次のようなデータが表示されます。
- Status Code (状況コード)
-
API コールの HTTP 応答コード。
- Sum (合計)
-
要求の総数と対応する応答コード。
列ヘッダーをクリックすると、その列でデータが並び替えられます。
Requests by Method (メソッド別要求数)
API のメソッド別要求数に関する次のようなメトリクスが表示されます。
- Method (メソッド)
-
API のコールに使用されたメソッド。
- Avg (平均)
-
系列内のすべての非 null 値の平均。
- Min (最小)
-
系列内の最小値。
- Max (最大)
-
系列内の最大値。
- Total (合計)
-
系列内のすべての値の合計。
列ヘッダーをクリックすると、その列でデータが並び替えられます。
要求数、要求の平均サイズ、応答の平均サイズ
API の要求および応答サイズに従って以下のメトリクスが表示されます。
- Requests (Avg) (平均要求数)
-
1 分あたりの平均要求数。
- Average Size of Requests (要求の平均サイズ)
-
1 分あたりの要求の平均サイズ (バイト)。
- Average Size of Responses (応答の平均サイズ)
-
1 分あたりの応答の平均サイズ (バイト)。
Anypoint Monitoring アーカイブ API
Titanium ユーザーは、Anypoint Monitoring アーカイブ API を介して API Analytics メトリクスデータに直接アクセスすることもできます。この API を使用して、ディレクトリ階層で API メトリクスデータの操作および検出を行うことができます。
Anypoint Monitoring アーカイブ API では、1 つ以上のメトリクスイベントを表す JSON オブジェクトが含まれるファイルをダウンロードできます。また、API によって収集されたデータを操作するアプリケーションを作成し、各自のシステムに統合することもできます。
Titanium ユーザーは、プロパティ anypoint.platform.config.analytics.agent.api_raw_metrics.enabled=true を設定することで、非集計 API イベントを有効にすることもできます。
これらのイベントには、各 API 呼び出しに関するより詳しい情報が含まれており、raw ファイルの種類で Anypoint Monitoring アーカイブ API を使用してアクセスできます。
この API についての詳細は、Anypoint Exchange の [Anypoint Monitoring Archive API (Anypoint Monitoring アーカイブ API)] ページを参照してください。