HTTP API のメトリクスの使用 - Amazon API Gateway

HTTP API のメトリクスの使用

CloudWatch を使用して API の実行をモニタリングすることで、API Gateway から raw データを収集し、リアルタイムに近い読み取り可能なメトリクスに加工することができます。これらの統計は 15 か月間記録されるため、履歴情報にアクセスしてウェブアプリケーションやサービスの動作をより的確に把握できます。デフォルトでは、API Gateway のメトリクスデータは 1 分間隔で自動的に CloudWatch に送信されます。詳細については、Amazon CloudWatch ユーザーガイドの「Amazon CloudWatch とは」を参照してください。

HTTP API では、次のメトリクスがサポートされています。ルートレベルのメトリクスを Amazon CloudWatch に書き込む詳細メトリクスを有効にすることもできます。

メトリクス 説明
4xx 指定された期間に取得されたクライアント側エラーの数。
5xx 指定された期間に取得されたサーバー側エラーの数。
カウント 指定期間内の API リクエストの合計数。
IntegrationLatency API Gateway がバックエンドにリクエストを中継してから、バックエンドからレスポンスを受け取るまでの時間。
レイテンシー API Gateway がクライアントからリクエストを受け取ってから、クライアントにレスポンスを返すまでの時間。レイテンシーには、統合のレイテンシーおよびその他の API Gateway のオーバーヘッドが含まれます。
DataProcessed 処理されたデータの量 (バイト単位)。

API Gateway のメトリクスをフィルタリングするには、次の表のディメンションを使用できます。

ディメンション 説明
ApiId 指定された API ID を持つ API の API Gateway メトリクスをフィルタリングします。
ApiId、ステージ 指定された API ID とステージ ID で、API ステージに対する API Gateway メトリクスがフィルタリングされます。
ApiId、ステージ、ルート

指定された API ID、ステージ ID、ルート ID で、API メソッドに対する API Gateway メトリクスがフィルタリングされます。

詳細な CloudWatch のメトリクスを明示的に有効にしない限り、API Gateway はこれらのメトリクスを送信しません。そのためには、API Gateway V2 REST API の UpdateStage アクションを呼び出して、metricsEnabled プロパティを true に更新します。このようなメトリクスを有効にすることで、アカウントに追加料金が発生します。詳細については、Amazon CloudWatch 料金表をご覧ください。