Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Esta seção compara o Monitoramento de API com o Edge Analytics. Embora a API Monitoring e o Edge Analytics permitam coletar e ver dados da API, eles têm objetivos diferentes:
- O objetivo do monitoramento de APIs é garantir que suas APIs estejam funcionando conforme o esperado. Para isso, você quer ver os dados mais recentes disponíveis. O monitoramento de APIs fornece dados muito próximos ao tempo real e permite criar alertas que notificam caso surja um problema.
- O objetivo do Edge Analytics é entender o comportamento das suas APIs a longo prazo para garantir que elas atendam aos seus requisitos de negócios ou fazer mudanças, se necessário. Para essas finalidades, é menos importante ver dados em tempo real. Consequentemente, os dados do Analytics têm um pequeno atraso, embora geralmente atrase, no máximo, 10 minutos.
Os dados da API Monitoring, que estão relacionados principalmente a códigos de erro e latência, são um pequeno subconjunto de dados do Google Analytics.
Diferenças entre os dados do monitoramento da API e do Google Analytics
Nesta seção, descrevemos algumas pequenas diferenças entre os dados coletados pelo Edge Analytics e pelo monitoramento da API. Como o monitoramento e a análise de APIs usam pipelines de dados diferentes, pode haver pequenas diferenças entre os relatórios personalizados gerados pelo Monitoring e os gerados pelo Analytics. Por exemplo, você pode ver discrepâncias nos resultados informados de erros de tempo limite, tanto de tempo limite de back-end (código de status HTTP 504 na solicitação) quanto de clientes (código de status HTTP 499). Eles podem aparecer com o código de status 200 nos relatórios personalizados do Analytics, mas com o código de status 504 ou 499 nos relatórios personalizados do Monitoring.Monitoramento de APIs
O Monitoramento de APIs fornece insights em tempo real sobre o desempenho da API, além de ajudar a diagnosticar e corrigir problemas rapidamente para manter suas 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 problemas de erro, desempenho e latência e a origem deles.
Análise da API Edge
O Edge API Analytics coleta e analisa informações que fluem por APIs. A API Analytics captura informações como:
- Tendência do tráfego da API ao longo do tempo
- Quais são seus principais apps
- Quem são seus principais desenvolvedores?
- Quais métodos de API são mais usados
- Quando o tempo de resposta da API é mais rápido/mais lento?
- Geograficamente onde você vê a maior parte do tráfego de API
Dados coletados pela API Analytics
A API Analytics coleta e analisa um amplo espectro de dados que fluem pelas APIs. Por exemplo, enquanto sua API está implantada, o Google Analytics registra constantemente o número de mensagens recebidas, o número de desenvolvedores, os tempos de resposta, os erros, o número de aplicativos em uso, o tamanho da solicitação e muitos outros dados.
Para uma boa introdução às métricas e como elas podem ser usadas, consulte Usar as APIs de métricas para medir o desempenho do programa de APIs. Para uma lista completa de métricas, consulte a Referência de métricas, dimensões e filtros do Google Analytics.
Coletar métricas personalizadas
Também é possível coletar métricas personalizadas usando a política StatisticsCollector. A política StatisticsColeor pode gravar informações de cabeçalhos de solicitação, payloads XML/JSON, parâmetros de consulta, URIs e outros locais no servidor de análise para análise e geração de relatórios.
Acessar dados do Google Analytics
Depois de gerado, você pode acessar métricas predefinidas e personalizadas usando as ferramentas de visualização de 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 os painéis do Analytics. Para mais informações sobre relatórios personalizados, consulte Criar relatórios personalizados.
Compare o monitoramento e a análise de APIs
Os desenvolvedores de API usam o monitoramento e a análise de APIs. Uma das principais diferenças entre os dois é o mecanismo de alerta integrado ao API Monitoring. Os alertas permitem que sua 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 o código de status específico (2xx/4xx/5xx), a latência e os 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, sua equipe de operações pode usar a IU da API Monitoring para investigar o problema e detalhar 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
- Solicitar UUID
- muitos outros
As análises de APIs foram projetadas 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 Analytics para identificar períodos de tráfego alto ou baixo e, assim, aumentar ou reduzir seus serviços de acordo com as mudanças nas demandas.
- 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 os dados personalizados coletados de uma solicitação para rastrear informações específicas, como valores de cabeçalho, parâmetros de consulta ou payload da solicitação.