API platformダッシュボード ​

API platformダッシュボードを使用すると、API platformの所有者は、エンドポイントおよびAPIコレクションに関連するリアルタイムデータを一目で可視化できます。

APIダッシュボードタブ

API platform全体のパフォーマンスを監視することも、特定のエンドポイントコレクションまたはリクエストを行っている顧客に関する詳細データを取得することもできます。

成功したリクエストとエラーは、APIエンドポイントの健全性の全体像を示します。

ポリシー違反メトリクスを使用して、異常なAPI呼び出しを生成している主要なクライアントまたはコレクションを特定します。 APIアクセス ポリシーの詳細については、こちらを参照してください。

フィルター ​

フィルターパラメータを使用して、APIダッシュボードビューを調整します。 デフォルトでは、ダッシュボードに過去30日間、すべてのクライアント、すべてのコレクションのデータが表示されます。 フィルターを変更して、目的に合ったダッシュボードビューを見つけることができます。 ページを離れるとフィルターはリセットされます。

APIダッシュボードフィルター

ダッシュボードの結果は、次の条件でフィルターできます。

• 期間: 過去30日間やカスタム範囲などの時間枠を選択します。
• ステータス: APIリクエストのステータスに基づいてフィルターします。
• クライアント: 1つ以上のAPIクライアントのメトリクスを表示します。
• ゲートウェイ: CloudまたはEdgeを選択して、特定のゲートウェイ経由でルーティングされたトラフィックをフィルターします。 コレクションフィルターでは、Edgeを選択した場合、エッジゲートウェイにデプロイされたAPIプロキシコレクションのみが表示されます。
• コレクション: 特定のAPIコレクションまたはエンドポイントで結果を絞り込みます。

APIアクティビティ ​

APIアクティビティグラフには、処理されたすべてのAPIリクエストの概要が表示されます。 この可視化により、API利用状況の傾向、急増、または減少を特定し、高アクティビティの期間やAPIの潜在的な問題を把握できます。

APIアクティビティ

ピーク時の同時APIリクエスト ​

ピーク時の同時APIリクエストグラフには、同時に処理されたAPIリクエストのピーク数の概要が表示されます。 バーの高さは、アクティビティが最も高い時点での同時リクエスト数を示します。

ピーク時の同時APIリクエスト

このセクションでは、任意の時点におけるAPI負荷を把握できます。 ピーク利用状況の時間帯を特定するのに役立ちます。これは、キャパシティプランニングや、高負荷時にもインフラストラクチャがパフォーマンス低下なしに対応できることを確保するうえで重要です。

上位リクエスト数 ​

リクエスト数別上位クライアントグラフとリクエスト数別上位エンドポイントグラフでは、最もアクティブなAPIコンシューマーと最も人気のあるエンドポイントを可視化します。 この表示は、選択したフィルターに応じて変わります。

上位リクエスト数

各エンドポイントリクエストの詳細を確認するには、ログタブに移動します。