Amazon API Gateway のディメンションとメトリクス
API Gateway が Amazon CloudWatch に送信するメトリクスとディメンションを以下に示します。詳細については、「Amazon CloudWatch のメトリクスを使用して REST API の実行をモニタリングする」を参照してください。
API Gateway のメトリクス
Amazon API Gateway は、メトリクスデータを 1 分ごとに CloudWatch に送信します。
AWS/ApiGateway 名前空間には、次のメトリクスが含まれます。
| メトリクス | 説明 |
|---|---|
|
4XXError |
指定された期間に取得されたクライアント側エラーの数。 API Gateway は、変更されたゲートウェイのレスポンスステータスコードを 4xxError エラーとしてカウントします。
Unit: Count |
|
5XXError |
指定された期間に取得されたサーバー側エラーの数。
Unit: Count |
|
CacheHitCount |
指定された期間内に API キャッシュから配信されたリクエストの数。
Unit: Count |
|
CacheMissCount |
API キャッシュが有効になっている特定の期間における、バックエンドから提供されたリクエストの数。
Unit: Count |
|
Count |
指定期間内の API リクエストの合計数。
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 はこれらのメトリクスを送信しません。コンソールでステージを選択し、[ログとトレース] で [編集] を選択します。[詳細なメトリクス]、[変更を保存] の順に選択します。update-stage AWS CLI コマンドを呼び出して これらのメトリクスを有効にすることで、アカウントに追加料金が発生します。詳細については、Amazon CloudWatch 料金表 |
|
ApiName, Stage |
指定した API 名とステージを使用して、API Gateway の API のステージリソースのメトリクスをフィルタリングします。 |
