Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
Esta seção compara o monitoramento de APIs com o Edge Analytics. Embora o monitoramento de APIs e o Edge Analytics permitam coletar e visualizar dados de API, eles têm objetivos diferentes:
- O objetivo do monitoramento de APIs é garantir que elas estejam funcionando conforme esperado. Para isso, você quer ver os dados mais recentes disponíveis. O monitoramento de APIs fornece dados quase em tempo real e permite criar alertas que notificam você caso ocorra um problema.
- O objetivo do Edge Analytics é entender o comportamento de longo prazo das suas APIs para garantir que elas atendam aos requisitos da sua empresa ou fazer alterações, se necessário. Para esses fins, é menos importante conferir dados em tempo real. Consequentemente, os dados do Google Analytics são um pouco atrasados, mas geralmente no máximo 10 minutos.
Os dados do monitoramento de API, que estão relacionados principalmente a códigos de erro e latência, são um pequeno subconjunto dos dados do Google Analytics.
Diferenças entre os dados da API Monitoring e do Google Analytics
Esta seção descreve algumas pequenas diferenças entre os dados coletados pelo Edge Analytics e pelo monitoramento de API. Como o Monitoramento de API e o Google Analytics usam pipelines de dados diferentes, talvez você note pequenas diferenças entre os relatórios personalizados gerados pelo Monitoramento e os gerados pelo Analytics. Por exemplo, você pode encontrar discrepâncias nos resultados informados para erros de tempo limite, tanto de back-end (código de status HTTP 504 na solicitação) quanto de tempo limite do cliente (código de status HTTP 499). Elas podem aparecer com o código de status 200 nos relatórios personalizados do Google Analytics, mas vão aparecer com o código de status 504 ou 499 nos relatórios personalizados do Monitoramento.Monitoramento de APIs
O monitoramento de APIs fornece insights em tempo real sobre o desempenho das APIs e ajuda a diagnosticar e corrigir problemas rapidamente para manter as APIs funcionando conforme o esperado.
O API Monitoring possibilita as seguintes abordagens:
- Aumente a disponibilidade da API e reduza o tempo médio para diagnóstico (MTTD, na sigla em inglês).
- Tomar as medidas adequadas com base em alertas contextuais antes que os consumidores sejam afetados.
- Use os códigos de falha da Apigee para acelerar o diagnóstico.
- Isole as áreas problemáticas rapidamente para diagnosticar erros, problemas de desempenho e latência e a origem deles.
Análise de APIs do Edge
A Análise de API do Edge coleta e analisa as informações que fluem pelas APIs. O API Analytics captura informações como:
- Como a tendência do tráfego da API muda ao longo do tempo
- Quais são seus principais apps
- Quem são seus principais desenvolvedores
- Quais métodos de API são mais conhecidos
- Quando o tempo de resposta da API é mais rápido/lento
- Geograficamente, onde você vê a maior parte do tráfego de APIs?
Dados coletados pela API Analytics
A API Analytics coleta e analisa um amplo espectro de dados que fluem entre APIs. Por exemplo, enquanto a API está implantada, o Google Analytics registra constantemente o número de mensagens recebidas, o número de desenvolvedores, os tempos de resposta, erros, o número de apps em uso, o tamanho da solicitação e muitos outros dados.
Para uma boa introdução às métricas e como usá-las, consulte Usar as APIs de métricas para medir o desempenho do programa de API. Para uma lista completa de métricas, consulte a Referência de métricas, dimensões e filtros do Analytics.
Coletar métricas personalizadas
Também é possível coletar métricas personalizadas usando a política StatisticsCollector. A política StatisticsCollector pode gravar informações de cabeçalhos de solicitação, payloads XML/JSON, parâmetros de consulta, URIs e outros locais no servidor do Google Analytics para análise e geração de relatórios.
Acessar dados do Google Analytics
Depois de geradas, você pode acessar as métricas predefinidas e personalizadas usando as ferramentas de visualização da API Analytics, incluindo o Painel, os relatórios personalizados e o GeoMap. Para mais informações sobre as ferramentas de visualização fornecidas pela API Analytics, consulte Painéis do Google Analytics. Para mais informações sobre relatórios personalizados, consulte Criar relatórios personalizados.
Comparar o monitoramento e a análise de APIs
Os desenvolvedores de API usam a API Monitoring e a API Analytics. Uma das principais diferenças entre os dois é o mecanismo de alerta integrado ao monitoramento de API. Os alertas permitem que a equipe de operações responda aos problemas com as APIs em tempo real para garantir que elas estejam disponíveis e funcionando conforme o esperado.
As condições de alerta definem um código de status específico (2xx/4xx/5xx), latência e limites de código de falha que, quando excedidos, acionam alertas visuais na interface e enviam notificações por vários canais, como e-mail, Slack, PagerDuty ou webhooks. Você pode configurar alertas no ambiente, no proxy de API, no serviço de destino ou no nível de região.
Depois que um alerta é acionado, a equipe de operações pode usar a interface da API Monitoring para investigar o problema e identificar a causa raiz. Em seguida, você pode gerar um relatório personalizado que inclui informações predefinidas sobre o alerta, como:
- Tempo total de resposta
- Tempo de resposta do destino
- Erros de proxy
- Erros de destino
- UUID da solicitação
- muitos outros
O API Analytics foi criado para capturar uma ampla variedade de dados que podem ser usados por várias equipes. Exemplo:
- A equipe de operações pode usar os dados do Google Analytics para identificar períodos de tráfego alto ou baixo e aumentar ou diminuir os serviços de acordo com a demanda.
- A equipe de marketing pode usar os dados do Google Analytics para determinar os padrões de uso do cliente identificados por APIs, apps, clientes ou outros dados individuais.
- Todas as equipes podem acessar dados personalizados coletados de uma solicitação para acompanhar informações específicas, como valores de cabeçalho, parâmetros de consulta ou payload de solicitação.