Visão geral do monitoramento de APIs

Esta é a documentação da Apigee X.
Veja 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.

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. O vídeo declara incorretamente que o período de retenção é de 60 dias, mas o valor real está sujeito a alterações. Para mais detalhes, consulte Retenção de dados.

Vídeo: confira este vídeo curto para ter uma visão geral do monitoramento de APIs.

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 IU da Apigee seguindo estas etapas:

1. Faça login na IU da Apigee.
2. Alterne para a organização que você quer monitorar.
3. Selecione Analyze > API Monitoring. O submenu exibe links para as duas visualizações principais na IU, conforme mostrado abaixo.
   
   Para acessar a IU, 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