Esta página se aplica à Apigee e à Apigee híbrida.
Confira a documentação da
Apigee Edge.
O monitoramento de APIs, a análise de APIs 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 das APIs. Cada uma dessas ferramentas oferece insights diferentes e é recomendada para casos de uso distintos. Este documento apresenta 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 API Monitoring fornece dados agregados dos seus proxies de API a cada minuto, permitindo que você monitore de perto a integridade e o desempenho das suas APIs. Use o API Monitoring para configurar alertas quase em tempo real em parâmetros especificados e aproveitar os dados agregados ao resolver problemas.
Com o API Monitoring, você pode:
- Mantenha a disponibilidade das suas APIs.
- Tome medidas com base nos 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 as ferramentas do Cloud Monitoring para oferecer compatibilidade com o monitoramento de APIs. Se você quiser fazer a integração com outros sistemas de monitoramento, recomendamos usar a API Monitoring para extrair métricas.
Dados de latência ao usar o monitoramento de API
Como o monitoramento de API foi projetado para escalonar, ele não registra todas as medições de latência individuais em cada transação. Em vez disso, buckets de distribuição são usados para medir latências. Os intervalos de latência usam intervalos predefinidos para agrupar valores de latência observados.
Para saber mais sobre como usar o API Monitoring nas suas APIs, consulte a visão geral do API Monitoring.
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 Analytics oferece 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 mudanças, se necessário.
Com a análise de APIs da Apigee, você pode 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 com o 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 Looker 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 a precificação por uso, o 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 na análise de API do Apigee usa uma função de agregação de quantil aproximado em registros individuais armazenados no BigQuery. Isso torna os dados resultantes sobre a latência mais precisos em comparação com a lógica de agrupamento usada no API Monitoring. A latência no API Monitoring e no Apigee API Analytics é medida no ambiente de execução da Apigee e não inclui cálculos de latência de hops de rede anteriores, incluindo o Istio.
Para saber mais sobre a análise de APIs da Apigee, consulte Visão geral da análise de APIs da Apigee.
Registros de acesso da Apigee
Os registros de acesso do Apigee podem ser usados para resolver problemas de chamadas de API para o 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 resolver facilmente casos extremos, como um código de status de resposta 0 no Istio.
Para saber mais sobre como usar os registros de acesso da Apigee para resolver problemas nas suas 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 API e o Apigee API Analytics 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 API Monitoring.
Pontualidade e precisão
Em geral, os dados exibidos pela análise de APIs da Apigee 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 API Monitoring, 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: um mês