Monitorar a execução de APIs de WebSocket com métricas do CloudWatch - Amazon API Gateway

Monitorar a execução de APIs de WebSocket com métricas do CloudWatch

É possível usar as métricas do Amazon CloudWatch para monitorar as APIs WebSocket. A configuração é semelhante à usada para APIs REST. Para obter mais informações, consulte Monitorar a execução da API REST com métricas do Amazon CloudWatch.

As métricas a seguir são compatíveis com APIs WebSocket:

Métrica Descrição
ConnectCount O número de mensagens enviadas à integração de rotas $connect.
MessageCount O número de mensagens enviadas à API WebSocket do cliente e vice-versa.
IntegrationError O número de solicitações que retornam uma resposta 4XX/5XX da integração.
ClientError O número de solicitações que têm uma resposta 4XX retornada pelo API Gateway antes de a integração ser invocada.
ExecutionError Erros que ocorreram durante a chamada da integração.
IntegrationLatency A diferença de hora entre o envio da solicitação para integração por parte do API Gateway e o recebimento da resposta da integração por parte do API Gateway. Supressão para retornos de chamada e integrações simuladas.

É possível usar as dimensões na tabela a seguir para filtrar métricas do API Gateway.

Dimensão Descrição
ApiId Filtra as métricas do API Gateway para uma API com o ID de API especificado.
ID da API, estágio Filtra métricas do API Gateway para um estágio de API com o ID da API especificada e o ID do estágio.
ApiId, método, recurso, estágio

Filtra métricas do API Gateway para um método de API com o ID da API especificada, ID do estágio, caminho do recurso e ID da rota.

O API Gateway não enviará essas métricas a menos que você tenha habilitado explicitamente métricas detalhadas do CloudWatch. Isso pode ser feito ao chamar a ação UpdateStage da API REST V2 do API Gateway para atualizar a propriedade detailedMetricsEnabled como true. Como alternativa, você pode chamar o comando update-stage da AWS CLI para atualizar a propriedade DetailedMetricsEnabled para true. Permitir essas métricas incorrerá em cobranças adicionais na conta. Para obter informações de definição de preço, consulte Definição de preço do Amazon CloudWatch.