Esta página se aplica a Apigee e à Apigee híbrida.
Confira
Apigee Edge documentação.
O monitoramento de APIs da Apigee, o Apigee API Analytics e os registros de acesso da Apigee são três ferramentas eficientes que podem ser usadas para coletar, observar e entender os dados de uso da API. Cada uma dessas ferramentas oferece insights diferentes e é recomendada para casos de uso distintos. Este documento oferece uma breve visão geral da finalidade de cada ferramenta e do uso recomendado, conforme descrito nas seções a seguir:
Monitoramento de APIs
O objetivo do monitoramento de APIs é fornecer insights em tempo real sobre o desempenho das APIs para que você possa diagnosticar e corrigir problemas rapidamente e manter as APIs funcionando conforme o esperado.
O monitoramento de APIs fornece dados agregados dos proxies de API a cada minuto, permitindo que você monitore de perto a integridade e o desempenho das APIs. É possível usar o monitoramento de APIs para configurar alertas quase em tempo real sobre parâmetros especificados e aproveitar os dados agregados na solução de problemas.
O monitoramento de APIs permite:
- Mantenha a disponibilidade das suas APIs.
- Agir em alertas antes que os consumidores sejam afetados.
- Use os códigos de falha da Apigee para acelerar o diagnóstico de problemas.
- Isole as áreas problemáticas rapidamente para diagnosticar a origem dos problemas de desempenho e latência.
Os clientes da Apigee também podem usar Cloud Monitoring ferramentas para oferecer suporte ao monitoramento de APIs. Se você quiser fazer a integração com outros sistemas de monitoramento, recomendamos usar a API Monitoring para extrair as métricas.
Dados de latência ao usar o monitoramento de APIs
Como o monitoramento de APIs foi projetado intencionalmente para ser escalonável, ele não registra cada medição de latência individual em cada transação. Em vez disso, os buckets de distribuição são usados para medir latências. Os buckets de latência usam intervalos predefinidos para agrupar os valores de latência observados.
Para saber mais sobre como usar o monitoramento de APIs, consulte Visão geral do monitoramento de APIs.
Para saber mais sobre como usar o Monitoring com a Apigee para configurar alertas, consulte Como configurar alertas e notificações.
Apigee API Analytics
O Apigee API Analytics fornece análise de tendências históricas e relatórios detalhados para metadados de chamadas de API. O objetivo do Apigee Analytics é ajudar você a entender as tendências de longo prazo do tráfego da sua API para garantir que as APIs atendam aos requisitos da sua empresa ou para fazer alterações, se necessário.
Com o Apigee API Analytics, é possível escolher entre aproximadamente 50 dimensões disponíveis que especificam os dados que você quer capturar para cada chamada de API processada por um proxy. Em seguida, é possível criar relatórios personalizados para determinar como métricas de API específicas mudam ao longo do tempo.
Os dados de análise capturados são armazenados no BigQuery. É possível usar o Apigee API Analytics para criar relatórios personalizados no Data Studio, configurar jobs de relatórios personalizados assíncronos, ou exportar dados de análise para seu próprio Google Cloud repositório de armazenamento, como o BigQuery.Se você começar com o preço de pagamento por uso, o Apigee API Analytics será um complemento opcional.
Veja a seguir algumas tendências que você pode identificar usando o Apigee Analytics:
- Qual é a tendência do tráfego da API ao longo do tempo?
- Quais são seus principais apps?
- Quem são os principais desenvolvedores?
- Quando o tempo de resposta da API é mais rápido ou mais lento?
- Quais regiões geográficas têm mais tráfego de API?
Dados de latência ao usar o Apigee API Analytics
A latência observada no Apigee API Analytics usa uma função de agregação de quantis aproximada em registros individuais armazenados no BigQuery. Isso torna os dados resultantes em torno da latência mais precisos em comparação com a lógica de bucket usada no monitoramento de APIs. A latência no monitoramento de APIs e no Apigee API Analytics é medida no ambiente de execução da Apigee e não inclui cálculos de latência de saltos de rede anteriores, incluindo o Istio.
Para saber mais sobre o Apigee API Analytics, consulte Visão geral do Apigee API Analytics.
Registros de acesso da Apigee
Os registros de acesso da Apigee podem ser usados para solucionar problemas de chamadas de API para a Apigee e identificar quais APIs estão retornando códigos de resposta HTTP específicos.
Os registros de acesso da Apigee capturam registros por transação no gateway de entrada da Apigee. Isso permite filtrar registros com base em códigos HTTP específicos e solucionar problemas de casos extremos, como um código de status de resposta de 0 no Istio.
Para saber mais sobre como usar os registros de acesso da Apigee para solucionar problemas nas APIs, consulte Registros de acesso da Apigee.
Diferenças entre os dados exibidos pelos dados da API Monitoring e pelo Google Analytics
O monitoramento de APIs e a análise de APIs da Apigee usam pipelines diferentes para acessar dados de API. Como resultado, talvez você note algumas discrepâncias entre os dados exibidos pelos painéis do Apigee API Analytics e os dados disponíveis no monitoramento de APIs.
Pontualidade e precisão
Em geral, os dados exibidos pelo Apigee API Analytics são mais precisos, mas podem ter um pequeno atraso (menos de uma hora) em comparação com os dados exibidos pelo monitoramento de APIs.
Retenção de dados
O Apigee API Analytics retém dados por um período mais longo do que o monitoramento de APIs, o que o torna mais adequado para análise de tendências de longo prazo.
Os períodos de armazenamento de dados para o Google Analytics e a API Monitoring são os seguintes:
Análise
- Padrão: 60 dias
- Empresa: 90 dias
- Enterprise +: 14 meses
Monitoramento de API: 1 mês