Use o CloudMonitor para configurar alertas em APIs publicadas no API Gateway. Assim, você acompanha o status operacional dos seus serviços de API e garante a estabilidade deles.
1. Associar recursos
O recurso de monitoramento e alertas do API Gateway atende a diversos requisitos de negócios. O API Gateway oferece suporte às seguintes métricas de monitoramento:
HttpStatusCode
Tempo de resposta da API
Total de solicitações da API
Tráfego de entrada
Tráfego de saída
Utilize um dos métodos abaixo para criar uma regra de alerta e associá-la a uma ou mais APIs:
Associe manualmente uma ou mais APIs. Este método é ideal para aplicar a mesma regra de alerta a APIs específicas. A regra permanece inalterada mesmo se a configuração da API for modificada.
Associe um grupo de APIs. Essa opção aplica a mesma regra de alerta a todas as APIs do grupo para monitorar o status das chamadas. Se você adicionar, excluir ou modificar APIs no grupo, a regra de alerta será sincronizada automaticamente.
Associe todos os recursos. Aplica a regra a todas as APIs no API Gateway da sua conta. Recomendado para cenários com poucas APIs gerenciadas.
Ao usar o primeiro ou segundo método, selecione um ambiente específico para criar a regra de alerta e configurar o monitoramento e os alertas das APIs. Por exemplo, escolha um ambiente de produção (RELEASE), pré-produção (PRE) ou teste (TEST).
2. Configurar níveis e métodos de alerta
O CloudMonitor dispara alertas Crítico, Aviso ou Informação, dependendo do intervalo do limiar. Cada nível envia notificações por canais diferentes. Para obter detalhes sobre notificações de alerta, consulte Visão geral.
Crítico: Chamada telefônica + mensagem SMS + e-mail + chatbot do DingTalk (recurso pago).
Aviso: Mensagem SMS + e-mail + chatbot do DingTalk.
Informação: E-mail + chatbot do DingTalk.
Por exemplo, defina uma regra de alerta para disparar uma notificação se a contagem de códigos de status 2XX ultrapassar 200 por minuto durante cinco minutos consecutivos.
3. Associar uma regra de alerta a uma ou mais APIs
Para obter detalhes sobre como configurar modelos de alerta, regras de alerta, contatos de notificação e notificações de alerta, consulte Visão geral.
Faça login no console do API Gateway e selecione uma região. No painel de navegação à esquerda, escolha e localize a API à qual deseja adicionar uma regra de alerta.
Na API List, clique em nome da API para abrir a página de detalhes. No painel de navegação à esquerda, clique em Monitoring. Em seguida, clique em Alert no canto superior direito para abrir o console do CloudMonitor.
Na página Alert Rules, clique em Create Alert Rule. Na página Create Alert Rule, defina Product como API Gateway e Resource Range como Instance. Clique em Add Instance logo abaixo. Na caixa de diálogo Add Instance, selecione as APIs que deseja adicionar.
4. Associar uma regra de alerta a um grupo de APIs
Para aplicar a mesma regra de alerta a todas as APIs de um grupo, acesse a página de detalhes do grupo e clique em Enable CloudMonitor no canto superior direito.
Ao configurar o CloudMonitor para um grupo de APIs pela primeira vez, uma caixa de diálogo solicitará a criação de uma função vinculada ao serviço AliyunServiceRoleForApiGatewayMonitoring.
Após clicar em OK, uma mensagem indicará que o CloudMonitor está ativado e fornecerá o nome do grupo de aplicativos correspondente no CloudMonitor. Com sua autorização, o API Gateway cria esse grupo de aplicativos para espelhar o grupo de APIs atual. O nome segue o formato
APIGATEWAY_${region}_${groupId}, onderegioné a região do grupo de APIs egroupIdé o seu ID.Depois de ativar o CloudMonitor, clique em Go to CloudMonitor to Configure na página de detalhes do grupo para configurar diretamente as regras de alerta do grupo de aplicativos atual.
5. Associar uma regra de alerta a todas as APIs
O procedimento é o mesmo descrito em Criar uma regra de alerta para uma ou mais APIs, exceto que você deve definir o Resource Range como "All Resources". Após essa configuração, a mesma regra de alerta se aplica a todas as APIs em todas as regiões do API Gateway da sua conta. Com este método, não é possível selecionar APIs específicas.
6. Regras de alerta compatíveis com o API Gateway
Configure alertas com base nas cinco métricas fornecidas pelo API Gateway: HttpStatusCode, tempo de resposta da API, total de solicitações da API, tráfego de entrada e tráfego de saída.
Tempo de resposta de uma API: refere-se ao tempo de resposta de um serviço de backend.
Número total de solicitações de uma API: quantidade total de solicitações recebidas pelo API Gateway para uma API específica, provenientes de clientes dentro de um período determinado.
Tráfego de entrada: volume de tráfego das solicitações recebidas pelo API Gateway, originadas de clientes em um período específico.
Tráfego de saída: volume de tráfego das solicitações enviadas aos serviços de backend pelo API Gateway dentro de um período específico.
Código de status HTTP: códigos de status retornados pelo API Gateway. Os seguintes códigos de status HTTP são compatíveis:
-Código de status HTTP 2XX: A solicitação da API foi recebida. Observação: Uma solicitação recebida não indica necessariamente que a operação pretendida foi bem-sucedida.
-Código de status HTTP 4XX: Ocorreu um erro no cliente, como um erro de parâmetro.
-Código 5XX: Indica um erro no lado do servidor. Desenvolvedores de API devem monitorar esses erros de perto.
7. Notas de uso
Configure uma regra de alerta com base no ambiente onde sua API está publicada. Caso uma regra de alerta configurada para uma API publicada em uma VPC não entre em vigor, recomendamos executar as seguintes operações: faça login no console do API Gateway, localize a API e clique em nome dela para acessar a página de detalhes. Na árvore de navegação à esquerda, clique em Monitoring. Na página Monitoring Data, verifique se é possível consultar os dados de monitoramento da API por ambiente. Se não conseguir consultar os dados de monitoramento por ambiente, envie um ticket para atualizar a versão da sua instância do API Gateway.