Esta página se aplica à Apigee e à Apigee híbrida.
Confira a documentação da
Apigee Edge.
O monitoramento de API, a análise de API e os registros de acesso da Apigee são três ferramentas eficientes para coletar, observar e entender seus dados de uso de API. Cada uma dessas ferramentas fornece insights diferentes e é recomendada para casos de uso diferentes. Este documento fornece 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 API fornece dados agregados dos proxies de API a cada minuto, permitindo monitorar de perto a integridade e o desempenho das suas APIs. Você pode usar o monitoramento de API para configurar alertas próximos ao tempo real em parâmetros especificados e aproveitar os dados agregados ao resolver problemas.
Com o monitoramento de API, você pode:
- Mantenha a disponibilidade das suas APIs.
- Agir de acordo com os 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 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 API
Como o monitoramento de API foi projetado intencionalmente para escalar, 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 as latências. Os intervalos de latência usam intervalos predefinidos para agrupar os valores de latência observados.
Para saber mais sobre como usar o monitoramento de APIs para suas APIs, consulte Visão geral do monitoramento de APIs.
Para saber mais sobre como usar o Monitoramento com o Apigee para configurar alertas, consulte Como configurar alertas e notificações.
Análise de APIs da Apigee
O Apigee API 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 alterações, 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 as métricas de API específicas mudam com o tempo.
Os dados de análise capturados são armazenados no BigQuery. É possível usar a API Analytics da Apigee 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 o preço pay-as-you-go, a API Analytics é 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 a Análise de API da Apigee
A latência observada no Apigee API Analytics 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 monitoramento de API. A latência no monitoramento de API e na análise de API da Apigee é 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 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 da Apigee podem ser usados para resolver 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 para a Apigee. Isso permite filtrar registros com base em códigos HTTP específicos e resolver rapidamente 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 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 monitoramento de APIs.
Cronogramas e precisão
Em geral, os dados exibidos pelo Apigee API Analytics são mais precisos, mas podem demorar um pouco mais (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 a 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