Amazon API Gateway
開発者ガイド

AWS のモニタリングツール

AWS では、API Gateway のモニタリングに使用できるさまざまなツールを提供しています。これらのツールの中には、自動モニタリングを設定できるものもあれば、手操作を必要とするものもあります。モニタリングタスクをできるだけ自動化することをお勧めします。

AWS の自動モニタリングツール

以下の自動化されたモニタリングツールを使用して、API Gateway をモニタリングし、問題が発生したときにレポートできます。

  • [Amazon CloudWatch アラーム] – 指定した期間にわたって単一のメトリクスを監視し、複数の期間にわたり既定のしきい値に関連するメトリクス値に基づいて 1 つ以上のアクションを実行します。アクションは、Amazon Simple Notification Service (Amazon SNS) トピックまたは Amazon EC2 Auto Scaling ポリシーに送信される通知です。CloudWatch アラームは、単に特定の状態にあるというだけではアクションを呼び出しません。状態が変わり、それが指定した数の期間にわたって持続する必要があります。詳細については、「Amazon CloudWatch を使用した API 実行のモニタリング」を参照してください。

  • Amazon CloudWatch Logs – AWS CloudTrail またはその他のソースのログファイルをモニタリング、保存、およびアクセスします。詳細については、Amazon CloudWatch ユーザーガイド の「ログファイルのモニタリング」を参照してください。

  • Amazon CloudWatch Events – イベントを照合し、1 つまたは複数のターゲット関数またはストリームにルーティングして変更を行い、状態情報を取得し、修正措置を行います。詳細については、Amazon CloudWatch ユーザーガイド の「Amazon CloudWatch Events とは」を参照してください。

  • [AWS CloudTrail ログモニタリング] – アカウント間でログファイルを共有する、CloudWatch Logs にログタイムを送信してリアルタイムで CloudTrail ログファイルをモニタリングする、Java でログ処理アプリケーションを書き込む、そして CloudTrail による配信後にログファイルに変更がないことを検証します。詳細については、AWS CloudTrail User Guide の「CloudTrail ログファイルの操作」を参照してください。

手動モニタリングツール

API Gateway のモニタリングでもう 1 つ重要な点は、CloudWatch アラームの対象外の項目を手動でモニタリングすることです。API Gateway、CloudWatch、およびその他の AWS コンソールダッシュボードには、AWS 環境の状態が一目でわかるビューが表示されます。API 実行のログファイルを確認することもお勧めします。

  • API Gateway ダッシュボードは、指定した期間中の特定の API ステージに関する次の統計情報を示します。

    • API 呼び出し

    • キャッシュヒット、API キャッシュが有効になっている場合のみ。

    • キャッシュミス、API キャッシュが有効になっている場合のみ。

    • レイテンシー

    • 統合のレイテンシー

    • 4XX エラー

    • 5XX エラー

  • CloudWatch ホームページに表示されます。

    • 現在のアラームとステータス

    • アラームとリソースのグラフ

    • サービス状態ステータス

    さらに、CloudWatch を使用して次のことが行えます。

    • 重視するサービスをモニタリングするためのカスタマイズしたダッシュボードを作成する

    • メトリクスデータをグラフ化して、問題のトラブルシューティングを行い、傾向を確認する

    • AWS リソースのすべてのメトリクスを検索して、参照する

    • 問題があることを通知するアラームを作成/編集する

API Gateway をモニタリングする CloudWatch アラームの作成

CloudWatch アラームを作成できます。これは、アラームの状態が変わったときに Amazon SNS メッセージを送信します。アラームは、指定期間にわたって単一のメトリクスを監視し、その値と複数期間に対するしきい値との比較結果に基づいて 1 つ以上のアクションを実行します。アクションは、Amazon SNS トピックまたは Auto Scaling ポリシーに送信される通知です。アラームは、持続している状態変化に対してのみアクションを呼び出します。CloudWatch アラームは、単に特定の状態にあるというだけでアクションを呼び出すわけではありません。状態が変わり、それが指定した数の期間にわたって持続している必要があります。