CloudWatch メトリクスを使用した WebSocket API の実行のモニタリング - Amazon API Gateway

CloudWatch メトリクスを使用した WebSocket API の実行のモニタリング

Amazon CloudWatch メトリクスを使用して、WebSocket API をモニタリングできます。この設定は、REST API に使用される設定と似ています。詳細については、「Amazon CloudWatch のメトリクスを使用した REST API の実行のモニタリング」を参照してください。

WebSocket API では、次のメトリクスがサポートされています。

メトリクス 説明
ConnectCount $connect ルート統合に送信されるメッセージの数。
MessageCount クライアントとの間で送受信される、WebSocket API に送信されるメッセージの数。
IntegrationError 統合から 4XX/5XX レスポンスを返すリクエストの数。
ClientError 統合が呼び出される前に API Gateway によって返された 4XX レスポンスを持つリクエストの数。
ExecutionError 統合を呼び出す際に発生したエラー。
IntegrationLatency API Gateway による統合へのリクエストの送信から、API Gateway による統合からのレスポンスの受信までの時間の差。コールバックと Mock 統合では除外されます。

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

ディメンション 説明
ApiId 指定された API ID を持つ API の API Gateway メトリクスをフィルタリングします。
ApiId、ステージ 指定された API ID とステージ ID で、API ステージに対する API Gateway メトリクスがフィルタリングされます。
ApiId、ステージ、ルート

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

詳細な CloudWatch のメトリクスを明示的に有効にしない限り、API Gateway はこれらのメトリクスを送信しません。そのためには、API Gateway V2 REST API の UpdateStage アクションを呼び出して、metricsEnabled プロパティを true に更新します。このようなメトリクスを有効にすることで、アカウントに追加料金が発生します。詳細については、Amazon CloudWatch 料金表をご覧ください。