組み込み API ダッシュボードの使用
API Analytics ダッシュボードでは、API の使用状況を監視するチャートが提供され、API の使用状況とパフォーマンスに関するインサイトを得ることができます。
API 自動検出を有効化している場合、Anypoint Monitoring の API Analytics ダッシュボードで API メトリクスを使用できます。
拡張メトリクスビューには、API に関する詳細情報が表示され、チャートは表示されるデータの種別に基づいてダッシュボードで並び替えられます。
Last 1 hour ラベルが表示されているチャートには、現在の時刻から開始して過去 60 分間に収集されたデータが表示されます。
| Gold および Platinum サブスクリプションの場合、Anypoint Monitoring は API Analytics メトリクスデータを 30 日間保持します。API Manager は、API Analytics メトリクスデータを 30 日間保持します。 |
Mule Runtime Engine のサポート対象バージョン
サポート対象の Mule Runtime バージョンで Mule アプリケーションを実行します。サポート対象のバージョンについては、Mule Runtime Release Notesを参照してください。
API Analytics ダッシュボードを表示する
-
Anypoint Monitoring コンテンツへのアクセス権限を持つユーザーアカウントを使用して Anypoint Platform にログインします。
-
[Anypoint Monitoring] に移動します。
-
サイドバーから、[Built-in dashboards (組み込みダッシュボード)] をクリックします。
-
組み込みダッシュボードで、表示する API の [Environment (環境)]、[Resource name (リソース名)]、[Version/Instance (バージョン/インスタンス)] を選択します。
-
[View (表示)] をクリックします。
API Analytics ページが表示され、実行中の管理 API に関する情報が表示されます。
-
統計情報を表示する日時範囲を選択し、[Confirm (確認)] をクリックします。
-
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 秒より長い応答時間の平均。
このチャートは、組織に Anypoint Integration Advanced パッケージまたは Anypoint Platform の 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 では使用できません。
チャートメトリクスの収集 (チャートグループ [Other (その他)] を含む) については、「エンドポイントおよび操作の使用に関するメトリクスを収集する方法」を参照してください。
エンドポイントおよび操作のメトリクスの収集 ([その他] グループ)
Anypoint Monitoring は、各データ収集期間の発生頻度が上位のエンドポイントまたは操作を収集します。発生頻度が上位でないエンドポイントまたは操作は、[Other (その他)] というグループに振り分けられます。
発生頻度が上位のエンドポイントまたは操作はデータ収集期間ごとに異なります。ある期間では発生頻度が上位であっても、次の期間では上位でない可能性があります。
Anypoint Monitoring のチャートおよびテーブルのデータは、複数のデータ収集期間から取得します。そのため、発生頻度が上位のエンドポイントまたは操作は期間によって異なる可能性があるので、ダッシュボードに表示される集計データは推定になります。[Other (その他)] グルーピングが表示されている場合、発生頻度が最も高いエンドポイントまたは操作の概数がテーブルに表示されます。
たとえば、ある期間ではあるエンドポイントが他のエンドポイントよりも頻繁に発生するが、別の期間では頻繁に発生しない場合、Anypoint Monitoring は、最初の期間ではエンドポイントを [Other (その他)] グループに振り分けます。この場合、表示されないメトリクスは [Other (その他)] グループに分類されるため、結果のテーブルには、そのエンドポイントの実際の値よりも低い値が表示されます。
Anypoint Monitoring アーカイブ API
高度な用途および Titanium サブスクリプションランクで利用できる機能 |
Anypoint Monitoring アーカイブ API を介して API Analytics メトリクスデータに直接アクセスできます。この API を使用して、ディレクトリ階層で API メトリクスデータの操作および検出を行うことができます。
Anypoint Monitoring アーカイブ API では、1 つ以上のメトリクスイベントを表す JSON オブジェクトが含まれるファイルをダウンロードできます。API によって収集されたデータを操作するアプリケーションを作成し、各自のシステムに統合できます。
プロパティ 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)」を参照してください。