メニュー
Amazon API Gateway
開発者ガイド

Amazon API Gateway のディメンションおよびメトリクス

API Gateway が Amazon CloudWatch に送信するメトリクスおよびディメンションは以下のとおりです。詳細については、「Amazon CloudWatch で API execution をモニタリングする」を参照してください。

API Gateway メトリクス

Amazon API Gateway は、CloudWatch にメトリクスデータを毎分送信します。

AWS/ApiGateway 名前空間には、次のメトリクスが含まれます。

メトリクス 説明

4XXError

指定された期間に取得されたクライアント側エラーの数。

Sum 統計は、このメトリクス、つまり、指定された期間内の 4XXError エラーの合計数を表します。Average 統計は、4XXError のエラー率、つまり 4XXError エラーの合計数をその期間のリクエストの合計数で割ったものです。分母は Count メトリクス (下記) に対応します。

単位: 個

5XXError

指定された期間に取得されたサーバー側エラーの数。

Sum 統計は、このメトリクス、つまり、指定された期間内の 5XXError エラーの合計数を表します。Average 統計は、5XXError のエラー率、つまり 5XXError エラーの合計数をその期間のリクエストの合計数で割ったものです。

単位: 個

CacheHitCount

指定された期間内に API キャッシュから配信されたリクエストの数。

Sum 統計は、このメトリクス、つまり、指定された期間内のキャッシュヒットの合計数を表します。Average 統計は、キャッシュヒット率、つまりキャッシュヒットの合計数をその期間のリクエストの合計数で割ったものです。

単位: 個

CacheMissCount

API キャッシュが有効になっている特定の期間における、バックエンドから提供されたリクエストの数。

Sum 統計は、このメトリクス、つまり、指定された期間内のキャッシュミスの合計数を表します。Average 統計は、キャッシュミス率、つまりキャッシュミスの合計数をその期間のリクエストの合計数で割ったものです。

単位: 個

カウント

指定期間内の API リクエストの合計数。

SampleCount 統計は、このメトリクスを表します。

単位: 個

IntegrationLatency

API Gateway がバックエンドにリクエストを中継してから、バックエンドからレスポンスを受け取るまでの時間。

単位: ミリ秒

レイテンシー

API Gateway がクライアントからリクエストを受け取ってから、クライアントにレスポンスを返すまでの時間。レイテンシーには、統合のレイテンシーおよびその他の API Gateway オーバーヘッドが含まれます。

単位: ミリ秒

メトリクスのディメンション

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

ディメンション 説明

ApiName

指定された API 名の API に対する API Gateway メトリクスがフィルタリングされます。

ApiName、メソッド、リソース、ステージ

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

API Gateway は、明示的に詳細な CloudWatch メトリクスを有効にしていない場合、そのようなメトリクスを送信しません。 この操作は、[Settings] タブで、[Enable CloudWatch Metrics] を選択することにより、コンソールで行うことができます。 または、API Gateway REST API の stage:update アクションを呼び出して、metricsEnabled プロパティを true に更新できます。

このようなメトリクスを有効にすることで、アカウントに追加料金が発生します。 料金表については、「Amazon CloudWatch 料金表」を参照してください。

ApiName、ステージ

指定された API とステージの API ステージに対する API Gateway メトリクスがフィルタリングされます。