Dimensões e métricas do Amazon API Gateway
As métricas e dimensões que o API Gateway envia para o Amazon CloudWatch estão listadas abaixo. Para obter mais informações, consulte Monitorar a execução da API REST com métricas do Amazon CloudWatch.
Métricas do API Gateway
O Amazon API Gateway envia dados de métricas para o CloudWatch a cada minuto.
O namespace AWS/ApiGateway
inclui as métricas a seguir.
Métrica | Descrição |
---|---|
4XXError |
O número de erros no lado do cliente capturados em um determinado período. O API Gateway considera os códigos de status de resposta do gateway modificados como erros 4XXError. A estatística Unit: Count |
5XXError |
O número de erros do servidor capturados em um período determinado. A estatística Unit: Count |
CacheHitCount |
O número de solicitações atendidas pelo cache da API em um determinado período. A estatística Unit: Count |
CacheMissCount |
O número de solicitações atendidas pelo backend em um determinado período quando o armazenamento em cache da API está habilitado. A estatística Unit: Count |
Count |
O número total de solicitações de API em um determinado período. A estatística Unit: Count |
IntegrationLatency |
O tempo que o API Gateway leva para receber uma resposta do backend depois de retransmitir uma solicitação para o backend. Unit: Millisecond |
Latency |
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. Unit: Millisecond |
Dimensões para métricas
É possível usar as dimensões na tabela a seguir para filtrar métricas do API Gateway.
nota
O API Gateway remove caracteres não ASCII da dimensão ApiName antes de enviar métricas para o CloudWatch. Se o APIName contiver caracteres ASCII, o API ID será usado como o ApiName.
Dimensão | Descrição |
---|---|
ApiName |
Filtra as métricas do API Gateway para a API REST com o nome de API especificado. |
ApiName, Method, Resource, Stage |
Filtra as métricas do API Gateway para o método de API com o nome, o estágio, o recurso e o método de API especificados. O API Gateway não enviará essas métricas a menos que você tenha habilitado explicitamente métricas detalhadas do CloudWatch. No console, selecione um estágio e, em Logs e rastreamento, selecione Editar. Selecione Métricas detalhadas e, depois, Salvar alterações. Como alternativa, você pode chamar o comando update-stage da AWS CLI para atualizar a propriedade Habilitar 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 |
ApiName, Stage |
Filtra as métricas do API Gateway para o recurso de estágio de API com o nome e o estágio de API especificados. |