組み込み 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 Platform のメイン画面で [Monitoring (監視)] をクリックします。
-
組み込みダッシュボードで、表示する 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 では使用できません。
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)] ページを参照してください。
平均応答時間の非アクティブのチャート化
チャートが途切れることなく連続してプロットされるように、すべての平均応答時間チャートでは、アプリケーションまたは API の非アクティブ期間の前にある最後の使用可能値と、次の使用可能値を直線で結びます。平均応答時間チャートのアクティビティを理解するため、要求数などの関連チャートでの動作を考慮して、API やアプリケーションのアクティビティの全体像を描いてください。