Monitorar métricas do CloudWatch para APIs HTTP no API Gateway - Amazon API Gateway

Monitorar métricas do CloudWatch para APIs HTTP no API Gateway

É possível monitorar a execução da API usando o CloudWatch, que coleta e processa dados brutos do API Gateway em métricas legíveis, quase em tempo real. Essas estatísticas são registradas para um período de 15 meses, de forma que você possa acessar informações históricas e ganhar uma perspectiva melhor sobre como seu serviço ou aplicativo web está se saindo. Por padrão, os dados de métricas do API Gateway são enviados automaticamente para o CloudWatch em períodos de um minuto. Para monitorar suas métricas, crie um painel do CloudWatch para sua API. Para ter mais informações sobre como criar um painel do CloudWatch, consulte Criar um painel do CloudWatch  no Guia do usuário do Amazon CloudWatch. Para obter mais informações, consulte O que é o Amazon CloudWatch? no Guia do usuário do Amazon CloudWatch.

As métricas a seguir são compatíveis com APIs HTTP. Você também pode habilitar métricas detalhadas para gravar métricas de nível de rota no Amazon CloudWatch.

Métrica Descrição
4xx O número de erros no lado do cliente capturados em um determinado período.
5xx O número de erros do servidor capturados em um período determinado.
Contagem O número total de solicitações de API em um determinado período.
IntegrationLatency O tempo que o API Gateway leva para receber uma resposta do backend depois de retransmitir uma solicitação para o backend.
Latência O tempo que o API Gateway leva para devolver uma resposta para um cliente depois de receber uma solicitação do cliente. A latência inclui a latência de integração e outras despesas gerais do API Gateway.
DataProcessed A quantidade de dados processados em bytes.

É 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.