Visão geral da análise de APIs da Apigee

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Este tópico apresenta a análise de APIs da Apigee.

Vídeo: assista a um vídeo curto para uma visão geral dos serviços do Apigee API Analytics.

Melhore sua API com análises

A análise da API Apigee coleta e calcula diversas informações que fluem por meio de proxies da API. É possível visualizar esses dados com gráficos na IU da Apigee ou fazer o download dos dados brutos para análise off-line usando as APIs da Apigee.

O Analytics ajuda você a responder a perguntas comuns, como as mostradas a seguir:

  • Qual é a tendência do tráfego da API ao longo do tempo?
  • Quais métodos de API são mais conhecidos?
  • Quem são meus principais desenvolvedores?
  • Quando o tempo de resposta da API é mais rápido? Mais lento?
  • Geograficamente, onde estou vendo a maior parte do tráfego de APIs?
  • Qual foi a receita gerada pelas suas transações?

Você pode analisar os dados para um nome de host específico ou para um ambiente inteiro.

As respostas a perguntas como essas ajudam a melhorar as APIs, resolver problemas e tomar decisões de negócios melhores relacionadas ao programa da API.

A APIs Analytics ajuda todos a melhorar

Por meio de um processo contínuo de coleta, análise e visualização de dados, o Apigee API Analytics ajuda sua equipe a melhorar as APIs e os desenvolvedores a melhorar os apps:

Os dados fluem de aplicativos por meio de proxies de API e, em seguida, a análise de dados ajuda a orientar ações de desenvolvedores de aplicativos, equipes de API, equipes de operações e proprietários de empresas.
  • Equipe de API: usa os sistemas internos para criar APIs interessantes. Essa equipe quer saber como está o desempenho do programa e das APIs individuais. Além disso, eles têm interesse em melhorar as APIs.
  • Desenvolvedores de aplicativos: ao compartilhar informações de análise com esses desenvolvedores, você recebe aplicativos melhores. Eles estão inovando com sua API e gerando apps criativos que ajudam a gerar receita para sua empresa. Com o Analytics, os desenvolvedores sabem o desempenho dos apps e quanto estão contribuindo para os resultados da sua empresa. Os desenvolvedores querem saber como eles podem melhorar seus aplicativos.
  • Equipe de operações: essa equipe quer entender os padrões de tráfego e prever quando adicionar recursos de back-end ou fazer outros ajustes importantes.
  • Proprietário da empresa: o proprietário quer ver se o investimento na API é válido e onde investir o dinheiro no futuro.

Como faço para começar a usar a análise de APIs da Apigee?

O tipo de organização da Apigee que você usa determinará as etapas necessárias para começar a usar o Apigee API Analytics. Se você não tiver certeza se está usando uma organização da Apigee por assinatura ou pagamento por uso, entre em contato com o administrador da Apigee.

Usar o Apigee API Analytics com uma organização de assinatura

Se você é um cliente de assinatura da Apigee, o acesso ao Apigee API Analytics está incluso nos seus direitos de assinatura e é ativado automaticamente para cada um dos seus ambientes da Apigee.

É possível acessar dados de análise da sua organização de assinatura usando a interface da Apigee, a interface da Apigee no console do Cloud ou a API Apigee. Para mais detalhes, consulte Como acessar meus dados de análise.

Usar o Apigee API Analytics com uma organização de pagamento por uso

Se você é um cliente de Pay-as-you-go, precisa ativar o Apigee API Analytics como um complemento pago para começar a usar os dados de análise. Para mais informações sobre como ativar o complemento de análise da API Apigee para seus ambientes da Apigee intermediário ou abrangente, consulte Gerenciar o complemento Apigee API Analytics.

Depois que o complemento Apigee API Analytics for ativado nos seus ambientes, será possível os dados de análise e gerenciar o complemento Apigee API Analytics usando a interface da Apigee no console do Cloud ou a API Apigee. Para mais detalhes, consulte Como acessar meus dados de análise. Os dados de análise e o gerenciamento de complementos não estão disponíveis na interface clássica da Apigee para organizações de pagamento por uso.

Quais tipos de dados são coletados e analisados?

O Apigee API Analytics coleta e analisa uma ampla variedade de dados que fluem entre proxies da API, como estes:

  • Tempo de resposta
  • Latência da solicitação
  • Tamanho da solicitação
  • Erros de destino
  • Nome do produto da API
  • Endereço de e-mail do desenvolvedor ou ID do AppGroup
  • Nome do app
  • Receita das transações

Para ver uma lista completa dos dados coletados pelo API Analytics, consulte Referência de métricas, dimensões e filtros do Analytics.

Como faço para coletar dados de análise personalizados?

A Apigee coleta nativamente diversos dados. Também é possível coletar dados de análise personalizados específicos para seus proxies, apps, produtos ou desenvolvedores de API. Por exemplo, pode ser útil coletar dados de análise com base parâmetros de consulta e solicitações de cabeçalhos, corpos ou gerais, ou variáveis definidas em suas APIs.

É possível coletar dados de análise personalizados com a política do DataCapture e usar a IU ou a API de análise para examinar os dados coletados.

Quando e por quanto tempo meus dados de análise estarão disponíveis?

Há dois intervalos de tempo que controlam quando e por quanto tempo é possível visualizar seus dados de análise:

  • Intervalo de atraso de dados: após uma chamada ser feita a um proxy de API, pode levar até 10 minutos para que os dados fiquem acessíveis para exibição ou por chamadas de API.
  • Disponibilidade do Analytics: o tempo que os dados de análise (que incluem dados de monetização e Sense, se aplicável) são disponibilizados pelos fatores por plano da Apigee. Dependendo do seu plano, os dados de análise podem ficar disponíveis por 30 dias, 90 ou 14 meses.

Retenção do Analytics ao usar o complemento Apigee API Analytics

Se você tiver uma organização de pagamento por utilização, poderá ativar o complemento de análise da API Apigee no nível do ambiente. Depois que o complemento é ativado para um ambiente, os dados de análise dele são retidos por 14 meses. É possível acessar os dados históricos de análise do ambiente na página Métricas da API no console, desde que o complemento esteja ativado.

Se você desativar o complemento do Analytics da API Apigee para um ambiente em uma organização de pagamento por utilização, os dados de análise do ambiente serão excluídos após 30 dias. Se você reativar o complemento no mesmo ambiente até 30 dias após a desativação, poderá recuperar o acesso aos dados de análise do ambiente durante o período de armazenamento de 14 meses. Nenhum dado será restaurado se o complemento for reativado para o ambiente após 30 dias.

Se você quiser reter dados de análise de qualquer ambiente em uma organização de pagamento por utilização além do período de armazenamento de 14 meses, recomendamos exportar e salvar os dados em outro local. Também é possível exportar seus dados do Analytics antes de desativar o complemento de análise da API Apigee ou dentro do período de 30 dias após a desativação. Para mais informações, consulte Exportar dados do Google Analytics.

Onde meus dados de análise são armazenados e processados?

O local em que os dados de análise são armazenados e processados é determinado pela região de análise, que você especificou quando instalou a Apigee:

  • Se você é um cliente de assinatura e instalou a Apigee usando o assistente de provisionamento da Apigee, você especificou sua região de análise em Criar uma organização na etapa 1, ao definirRegião de hospedagem do Google Analytics de dois minutos.
  • Se você é um cliente de pagamento por uso e instalou a Apigee pelo console do Google Cloud, você especificou sua região de análise na etapa 3 Criar uma organização, quando você define a região de hospedagem do Google Analytics.
  • Se você instalou a Apigee pela linha de comando como um cliente de assinatura ou pagamento por uso, você especificou sua região de análise aodefiniu a variável de ambienteANALYTICS_REGION de dois minutos.

Os dados do Analytics são armazenados e processados da seguinte maneira:

  • Para regiões de análise que não estão nos EUA ou na UE, os dados de análise são armazenados e processados na região de análise.
  • Para regiões de análise nos EUA ou na UE, os dados são armazenados na multirregião dos EUA ou da UE, respectivamente, para maior disponibilidade.

Como faço para acessar meus dados de análise?

O Apigee Analytics fornece ferramentas de visualização de dados incorporadas à IU da Apigee. Essas ferramentas incluem painéis de análise predefinidos e relatórios personalizados que exibem dados em gráficos e permitem que você analise os dados agrupados em diferentes dimensões de forma detalhada, por exemplo, proxy de API, endereço IP ou código de status HTTP.

Você também pode fazer o download dos dados de análise usando a API Apigee. Depois de fazer o download, é possível importar esses dados para suas próprias ferramentas de visualização ou sistema de análise.

Painéis de análise

A interface da Apigee fornece um conjunto de painéis predefinidos usados para visualizar os dados de análise.

Apigee no console do Cloud

Para abrir os painéis do Analytics (para organizações de pagamento por uso ou de assinatura):

  1. Abra a interface da Apigee no Console do Cloud em um navegador.
  2. Selecione Analytics > Métricas da API.
A seguinte imagem mostra o painel Desempenho do proxy de API:

Selecione uma destas guias para conferir os painéis:

Para mais informações, consulte Como usar os painéis do Analytics.

Apigee clássica

Para abrir os painéis do Analytics (somente para organizações de assinatura):

  1. Abra a interface da Apigee em um navegador.
  2. Selecione Analisar > Métricas da API.
  3. Selecione um dos seguintes painéis:

Além desses painéis, também é possível usar os seguintes:

Para mais informações, consulte Como usar os painéis do Analytics.

Relatórios personalizados

Com os relatórios personalizados, é possível visualizar detalhes de métricas específicas da API e os dados exatos que desejar. É possível criar um relatório personalizado usando qualquer um dos dados de análise incorporados à Apigee.

Ao criar um relatório personalizado, você seleciona os dados que quer ver (métricas), agrupando os dados de formas significativas (dimensões) e, se quiser, limitando os dados retornados com base em características específicas (filtro).

Também é possível definir o tipo de gráfico exibido no relatório personalizado como uma coluna ou gráfico de linhas. As imagens a seguir mostram exemplos de gráficos para transações por segundo agrupadas pelo proxy da API:

  • Coluna: cada proxy de API é representado por uma coluna diferente:

    Gráfico de colunas personalizado

  • Linha: cada proxy de API é representado por uma linha diferente:

    Gráfico de linhas personalizado

Para mais informações, consulte Como criar e gerenciar relatórios personalizados.

Analytics API

Use a API Apigee para fazer o download de dados de análise. Por exemplo, é possível usar a API para criar suas próprias ferramentas de visualização que podem ser incorporadas em portais ou aplicativos personalizados.

Veja um exemplo de chamada de API para recuperar dados de análise para proxies da API:

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/stats/apiproxy?select=sum(message_count)&timeRange=6/24/2022%2000:00~6/25/2022%2023:59&timeUnit=hour" \
  -H "Authorization: Bearer $TOKEN"

O resultado da chamada é este:

  • Ela retorna a soma das solicitações (contagem de mensagens) por proxy de API.
  • Isso é feito por um período de 24 horas
  • O agrupamento é feito por hora.

O parâmetro de consulta timeRange especifica o período no formato:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Observe o %20 antes de HH:MM. O parâmetro timeRange requer um caractere de espaço codificado por URL antes de HH:MM, ou um caractere +, como em: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Para mais informações, consulte Como usar a API Metrics.

Exportar dados de análise para o Google Cloud Platform

É possível usar a API Apigee para exportar todos os dados de análise de um dia inteiro da Apigee para seu próprio repositório de dados, como o Google Cloud Storage ou o BigQuery. Em seguida, aproveite os recursos avançados de consulta e machine learning oferecidos pelo Google Cloud BigQuery e pelo TensorFlow para realizar sua própria análise de dados.

Para mais informações, consulte Como exportar dados da análise.

Como posso compartilhar dados com desenvolvedores de apps?

Ao pensar nos desenvolvedores de aplicativos como clientes, certifique-se de que eles têm as ferramentas e as informações disponíveis para aproveitar ao máximo sua API.

Os apps enviam dados por meio de proxies de API. Em seguida, a análise dos dados ajuda um desenvolvedor a entender o desempenho do aplicativo.

Os desenvolvedores não estão apenas preocupados com a qualidade dos aplicativos, eles também estão interessados nas APIs. Os portais do desenvolvedor baseados em Drupal incluem uma página opcional de desempenho do app, criada para dar aos desenvolvedores acesso a métricas importantes dos aplicativos. Esta página fornece aos desenvolvedores informações sobre os seguintes tópicos:

  • Erros: quais erros da API meu aplicativo está vendo?
  • Desempenho: a API está lenta? Quais métodos de API estão lentos no momento?
  • Disponibilidade:a API está ativa ou inativa?
  • Cota: a API tem uma cota? Como desenvolvedor do aplicativo, como estou na cota?

Para mais informações, consulte Monitorar apps (em inglês) na documentação do Drupal 8.

Além disso, é possível compartilhar análises com seus desenvolvedores das seguintes formas:

Como gerar dados de análise completos?

O que significa análise completa? É possível, por exemplo, criar um proxy de API para que a Apigee colete dados de análise sobre esse proxy. Mas e as métricas para o desenvolvedor ou o aplicativo que chamaram o proxy da API? Se a Apigee não souber quem fez uma chamada de API, ela não poderá coletar esses dados.

Algumas etapas são necessárias para permitir que a Apigee descubra quais desenvolvedores e quais apps de desenvolvedor estão chamando seus proxies de API. Veja uma lista dessas etapas com links para informações mais detalhadas:

  1. Crie um ou mais produtos de API, que são um agrupamento de proxies de API com um plano de serviço. Consulte Como gerenciar produtos de API.
  2. Registre desenvolvedores de apps com a Apigee. Consulte Como registrar desenvolvedores de aplicativos.
  3. Registre aplicativos e gerencie chaves de API para seus desenvolvedores. Consulte Registrar apps e gerenciar chaves de API.
  4. Adicione políticas de segurança aos seus proxies de API que verificam as chaves de API e/ou os tokens de segurança. Consulte os seguintes tópicos: Política Verify API Key, Política de OAuthV2 e Política Verify JWT.

Os seguintes tutoriais orientam você nas etapas necessárias que permitem ver as análises para desenvolvedores e aplicativos: Proteger uma API exigindo chaves de API e Proteger uma API com OAuth.

Requisitos da Apigee híbrida

Esta seção lista informações importantes para usuários da Apigee híbrida.

Suporte à residência de dados

As versões mais antigas da Apigee híbrida não são compatíveis com a Análise de API da Apigee.

Outros requisitos

Mais informações