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 アクションを呼び出して、 |
