Você está lendo 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 o esperado. Para isso, você precisa dos dados mais recentes disponíveis. O monitoramento de APIs fornece dados muito próximos do tempo real e permite criar alertas que notificam você em caso de problemas.
- O objetivo do Edge Analytics é entender o comportamento de longo prazo das APIs para garantir que elas atendam aos requisitos de negócios ou fazer mudanças, se necessário. Para esses fins, não é tão importante ver dados em tempo real. Consequentemente, os dados do Analytics são ligeiramente atrasados, embora geralmente em no máximo 10 minutos.
Os dados de monitoramento de APIs, que estão relacionados principalmente a códigos de erro e latência, são um pequeno subconjunto de dados do Analytics.
Diferenças entre os dados de monitoramento de APIs e os dados do Analytics
Esta seção descreve algumas pequenas diferenças entre os dados coletados pelo Edge Analytics e o monitoramento de APIs. Como o monitoramento de APIs e o Analytics usam pipelines de dados diferentes, pode haver pequenas diferenças entre os relatórios personalizados gerados pelo monitoramento e os relatórios gerados pelo Analytics. Por exemplo, você pode encontrar discrepâncias nos resultados informados para erros de tempo limite: tempos limite de back-end (código de status HTTP 504 na solicitação) e tempos limite do cliente (código de status HTTP 499). Eles podem aparecer com o código de status 200 nos relatórios personalizados do Analytics, mas vão aparecer com o código de status 504 ou 499 nos relatórios personalizados de monitoramento.Monitoramento de APIs
O monitoramento de APIs fornece insights em tempo real sobre a performance das APIs e ajuda você a diagnosticar e corrigir problemas rapidamente para manter as APIs funcionando conforme o esperado.
O monitoramento de APIs permite:
- Aumentar a disponibilidade da API e reduzir o tempo médio de detecção (MTTD, na sigla em inglês).
- Tomar as medidas adequadas com base em alertas contextuais antes que os consumidores sejam afetados.
- Usar os códigos de falha da Apigee para acelerar o diagnóstico.
- Isole as áreas do problema rapidamente para diagnosticar erros, problemas de desempenho e latência e a origem deles.
Edge API Analytics
O Edge API Analytics coleta e analisa informações que fluem pelas APIs. O API Analytics captura informações como:
- Como o tráfego da API está evoluindo 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
- Onde você vê a maior parte do tráfego de APIs
Dados coletados pelo API Analytics
O API Analytics coleta e analisa uma ampla variedade de dados que fluem pelas APIs. Por exemplo, enquanto a API está implantada, o Analytics registra constantemente o número de mensagens recebidas, o número de desenvolvedores, os tempos de resposta, os 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 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 Analytics para análise e geração de relatórios.
Acessar dados do Analytics
Depois de geradas, é possível acessar métricas predefinidas e personalizadas usando as ferramentas de visualização do API Analytics, incluindo o painel, relatórios personalizados e o GeoMap. Para mais informações sobre as ferramentas de visualização fornecidas pelo API Analytics, consulte Painéis do Analytics. Para mais informações sobre relatórios personalizados, consulte Criar relatórios personalizados.
Comparar o monitoramento de APIs e o API Analytics
Os desenvolvedores de API usam o monitoramento de APIs e o API Analytics. Uma das principais diferenças entre os dois é o mecanismo de alerta integrado ao monitoramento de APIs. Os alertas permitem que a equipe de operações responda a 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 de monitoramento de APIs para investigar o problema e analisar a causa raiz. Em seguida, é possível gerar um relatório personalizado que inclua 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
- muito mais
O API Analytics foi projetado para capturar uma ampla variedade de dados para uso por várias equipes. Por exemplo:
- A equipe de operações pode usar os dados do Analytics para identificar períodos de tráfego alto ou baixo, para que possam aumentar ou diminuir a escala dos serviços para atender às demandas em mudança.
- A equipe de marketing pode usar os dados do Analytics para determinar 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 rastrear informações específicas, como valores de cabeçalho, parâmetros de consulta ou payload de solicitação.