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

API の管理と呼び出しを追跡する

API 実行の場合、API Gateway は API およびステージレベルで API の実行メトリクスを Amazon CloudWatch に自動的にレポートします。ただし、アカウントの IAM ロールで、CloudWatch にログを書き込むためのアクセス権限が設定されている必要があります。

API Gateway コンソールを使用するか、API Gateway REST API またはその SDK の 1 つを呼び出すことで、API Gateway にオプトインして、メソッドレベルの CloudWatch メトリクスに送ることもできます。このメトリクスに基づいて、API のパフォーマンスの問題をトラブルシューティングするための CloudWatch カスタムアラームを設定できます。

CloudWatch メトリクスには、キャッシュ、レイテンシー、検出されたエラーに関する統計が含まれます。CloudWatch ログを調べて、API の実装や実行のトラブルシューティングを行うことができます。この作業には、API Gateway コンソールの API ダッシュボードを使用するか、CloudWatch コンソールを使用します。CloudWatch の詳細については、「Amazon CloudWatch ユーザーガイド」を参照してください。

API 管理作業用に、AWS CloudTrail 証跡を作成して、API Gateway REST API 呼び出しに関連するイベントのログ記録に使用できます。この証跡は CloudTrail コンソールで作成できます。

そのログを使用して、API の作成、デプロイ、更新に関するトラブルシューティングができます。 また、Amazon CloudWatch を使用して、CloudTrail ログをモニタリングすることもできます。 CloudTrail の詳細については、「AWS CloudTrail ユーザーガイド」を参照してください。

注記

CloudTrail ログの API Gateway REST API は、apigateway コンポーネントに対して作成された API 開発者または所有者を呼び出し、CloudWatch ログの API は、API Gateway の execute-api コンポーネントに対して作成された API カスタマーまたはクライアントを呼び出します。