Visão geral do monitoramento de APIs

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Depois de criar e lançar suas APIs na Apigee, você precisa garantir que elas estejam disponíveis e funcionando conforme o esperado para manter o serviço ininterrupto. O monitoramento de APIs da Apigee permite que você rastreie suas APIs para garantir que elas estejam funcionando corretamente. O monitoramento de APIs fornece insights quase em tempo real sobre o tráfego e o desempenho da API para ajudar você a diagnosticar e resolver problemas rapidamente conforme eles surgem.

O API Monitoring possibilita as seguintes abordagens:

• Crie alertas para notificar você sobre mudanças no tráfego da API para que possa realizar uma ação apropriada antes que os clientes sejam afetados.
• Aumentar a disponibilidade da API e reduzir o tempo médio para diagnóstico (MTTD, na sigla em inglês) ao investigar rapidamente problemas com as APIs.
• Aproveitar os códigos de falha para acelerar o diagnóstico.
• Isole as áreas do problema rapidamente para diagnosticar erros, problemas de desempenho e latência e a origem deles.

Como cliente da Apigee, também é possível usar as ferramentas do Cloud Monitoring para oferecer compatibilidade com o monitoramento de APIs.

Sobre a retenção de dados: os registros do monitoramento de APIs capturam dados de parâmetros de consulta e de user agent. Como esses dados podem conter informações de identificação pessoal (PII), eles são retidos por 6 semanas e depois excluídos de acordo com a Política de Privacidade do Google. Para mais detalhes, consulte Retenção de dados.

Usuários da Apigee híbrida: não desative as métricas na configuração híbrida se você quiser visualizar os dados da API Monitoring. As métricas precisam estar ativadas na configuração híbrida para que os dados da API Monitoring sejam exibidos. As métricas são ativadas para o modo híbrido por padrão.

Papéis do monitoramento da API

Para acessar o monitoramento de API, você precisa receber os seguintes papéis:

• roles/apigee.readOnlyAdmin
• roles/monitoring.viewer

Consulte os papéis da Apigee para mais informações sobre quais papéis são apropriados para usar o monitoramento de APIs.

Como acessar o monitoramento da API

É possível acessar o monitoramento da API por meio da interface da Apigee seguindo estas etapas:

Observação: há uma nova versão da IU da Apigee, que está integrada ao console do Google Cloud. A nova interface é chamada de Apigee no console do Cloud. As instruções nas duas primeiras guias abaixo explicam como usar a Apigee no console do Cloud ou a Apigee clássica.

Apigee no console do Cloud

1. Faça login na interface da Apigee no console do Cloud.
2. Selecione Desenvolvimento de proxy > Monitoramento de API.

Apigee clássica

1. Faça login na interface da Apigee.

2. Selecione uma das seguintes visualizações:

   • Analisar > Monitoramento de APIs > Cronograma
   • Analisar > Monitoramento de APIs > Investigar
   • Analisar > Monitoramento de APIs > Recente

Isso exibe a visualização principal do monitoramento da API. No menu Visualização, selecione uma das seguintes visualizações:

• Cronograma: exibe cronogramas de dados de tráfego recente da API.
• Investigar: exibe tabelas de dados de tráfego da API, como código de falha por região.
• Recente: exibe mapas de árvore de dados em que cada proxy é representado por um retângulo, cujo tamanho é proporcional à quantidade de tráfego da API para o proxy e cujas cores indicam o tamanho relativo das métricas relacionadas.

As seções a seguir descrevem essas visualizações em detalhes:

• Cronograma
• Investigar
• Recente