

# 使用 CloudWatch 指标监控 WebSocket API 执行
<a name="apigateway-websocket-api-logging"></a>

您可以使用 [Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) 指标来监控 WebSocket API。该配置类似于 REST API 使用的配置。有关更多信息，请参阅 [使用 Amazon CloudWatch 指标监控 REST API 执行](monitoring-cloudwatch.md)。

WebSocket API 支持以下指标：


| 指标 | 说明 | 
| --- | --- | 
| ConnectCount | 发送到 \$1connect 路由集成的消息数。 | 
| MessageCount | 从客户端发送到 WebSocket API 的消息数。 | 
| IntegrationError | 从集成返回 4XX/5XX 响应的请求数。 | 
| ClientError | 在调用集成之前由 API Gateway 返回 4XX 响应的请求数。 | 
| ExecutionError | 调用集成时发生的错误。 | 
| IntegrationLatency | API Gateway 向集成发送请求和 API Gateway 从集成接收响应之间的时间差。已对回调和模拟集成禁止。 | 

您可以使用下表中的维度筛选 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](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename.html) 操作，将 `detailedMetricsEnabled` 属性更新为 `true`。或者，您也可以调用 [update-stage](https://docs.aws.amazon.com/cli/latest/reference/apigatewayv2/update-stage.html) AWS CLI 命令，以将 `DetailedMetricsEnabled` 属性更新为 `true`。启用这些指标会对您的账户额外计费。有关定价信息，请参阅 [Amazon CloudWatch 定价](https://aws.amazon.com/cloudwatch/pricing/)。  | 