Amazon API Gateway のディメンションとメトリクス - Amazon API Gateway

Amazon API Gateway のディメンションとメトリクス

API Gateway が Amazon CloudWatch に送信するメトリクスとディメンションを以下に示します。詳細については、「Amazon CloudWatch のメトリクスを使用した REST API の実行のモニタリング」を参照してください。

API Gateway のメトリクス

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

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

メトリクス 説明

4XXError

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

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

Unit: Count

5XXError

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

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

Unit: Count

CacheHitCount

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

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

Unit: Count

CacheMissCount

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

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

Unit: Count

Count

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

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

Unit: Count

IntegrationLatency

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

Unit: Millisecond

Latency

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

Unit: Millisecond

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

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

注記

API Gateway は、メトリクスを CloudWatch に送信する前に、ApiName ディメンションから ASCII 以外の文字を削除します。APIName に ASCII 文字が含まれていない場合、API ID は ApiName として使用されます。

ディメンション 説明

ApiName

指定した API 名を使用して、API Gateway の REST API のメトリクスをフィルタリングします。

ApiName, Method, Resource, Stage

指定した API 名、ステージ、リソース、メソッドを使用して、API Gateway の API のメソッドのメトリクスをフィルタリングします。

詳細な CloudWatch のメトリクスを明示的に有効にしない限り、API Gateway はこれらのメトリクスを送信しません。この操作は、[Settings (設定)] タブで、[Enable CloudWatch Metrics (CloudWatch メトリクスの有効化)] を選択することにより、コンソールで行うことができます。または、AWS CLI コマンドの update-stage を呼び出して metricsEnabled プロパティを true に更新することもできます。

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

ApiName, Stage

指定した API 名とステージを使用して、API Gateway の API のステージリソースのメトリクスをフィルタリングします。