Vista geral da API Apigee do Analytics

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Este tópico apresenta a API Apigee do Analytics.

Melhore a sua API através de estatísticas

O Apigee API Analytics recolhe e calcula uma grande quantidade de informações que fluem através de proxies de API. Pode visualizar estes dados com gráficos na IU do Apigee ou transferir os dados não processados para análise offline através das APIs Apigee.

O Analytics ajuda a responder a perguntas comuns, como:

  • Como está a tendência do meu tráfego da API ao longo do tempo?
  • Que métodos da API são mais populares?
  • Quem são os meus principais programadores?
  • Quando é que o tempo de resposta da API é mais rápido? O mais lento?
  • Geograficamente, onde vejo mais tráfego da API?
  • Que receita geraram as suas transações?

Pode analisar dados de um nome do anfitrião específico ou de um ambiente completo.

As respostas a perguntas como estas ajudam a melhorar as suas APIs, resolver problemas e tomar melhores decisões empresariais relacionadas com o seu programa de APIs.

A API Analytics ajuda todos a melhorar

Através de um processo contínuo de recolha, análise e visualização de dados, o Apigee API Analytics ajuda a sua equipa de APIs a melhorar as APIs e ajuda os programadores de apps a melhorar as respetivas apps:

Os dados fluem das apps através de proxies de API e, em seguida, a análise de dados ajuda a orientar as ações dos programadores de apps, das equipas de API, das equipas de operações e dos proprietários de empresas.
  • Equipa da API: a equipa da API está a explorar sistemas internos para criar APIs interessantes. A equipa da API quer saber como está o programa de APIs em geral, como estão as APIs individuais e como melhorar as respetivas APIs.
  • Programadores de apps: ao partilhar informações de estatísticas com programadores de apps, obtém melhores apps. Estes programadores estão a inovar com a sua API e a criar apps criativas que ajudam a gerar receita para a sua empresa. O Analytics ajuda os programadores de apps a saberem o desempenho das respetivas apps e quanto estão a contribuir para o resultado final da sua empresa. Os programadores de apps querem saber como podem melhorar as respetivas apps.
  • Equipa de operações: a equipa de operações quer compreender os padrões de tráfego e antecipar quando adicionar recursos de back-end ou fazer outros ajustes críticos.
  • Proprietário da empresa: o proprietário da empresa quer ver como o investimento na API está a dar frutos e onde investir dinheiro na API no futuro.

Como posso começar a usar a API Apigee do Analytics?

O tipo de organização do Apigee que usa determina os passos necessários para começar a usar o Apigee API Analytics. Se não tiver a certeza de que está a usar uma organização do Apigee por subscrição ou de pagamento conforme o uso, contacte o administrador da sua organização do Apigee.

Use o Apigee API Analytics com uma organização de subscrição

Se for cliente de uma subscrição do Apigee, o acesso ao Apigee API Analytics está incluído nos seus direitos de subscrição e é ativado automaticamente para cada um dos seus ambientes do Apigee.

Pode aceder aos dados de estatísticas da sua organização de subscrição através da IU do Apigee na consola do Google Cloud ou da API Apigee. Para mais detalhes, consulte Como acedo aos meus dados de estatísticas.

Use o Apigee API Analytics com uma organização de pagamento conforme o uso

Se for cliente do plano Pay-as-you-go, tem de ativar o Apigee API Analytics como um suplemento pago para começar a usar os dados de estatísticas. Para mais informações sobre como ativar o suplemento Apigee API Analytics para os seus ambientes intermédios ou abrangentes do Apigee, consulte o artigo Faça a gestão do suplemento Apigee API Analytics.

Depois de o suplemento Apigee API Analytics ser ativado nos seus ambientes, pode aceder aos dados de estatísticas e gerir o suplemento Apigee API Analytics através da IU do Apigee na consola do Google Cloud ou da API Apigee. Para mais detalhes, consulte Como acedo aos meus dados de estatísticas. Os dados do Analytics e a gestão de suplementos não estão disponíveis na IU do Apigee clássico para organizações com pagamento conforme o uso.

Que tipo de dados são recolhidos e analisados?

O Apigee API Analytics recolhe e analisa um vasto espetro de dados que fluem através de proxies de API, como:

  • Tempo de resposta
  • Latência do pedido
  • Tamanho do pedido
  • Erros de destino
  • Nome do produto API
  • Endereço de email do programador ou ID do grupo de apps
  • Nome da app
  • Receita de transações

Para uma lista completa dos dados recolhidos pela API Google Analytics, consulte o artigo Referência de métricas, dimensões e filtros do Analytics.

Como posso recolher dados de estatísticas personalizados?

O Apigee recolhe nativamente uma grande quantidade de dados. Também pode querer recolher dados de estatísticas personalizados específicos dos seus proxies de API, apps, produtos ou programadores. Por exemplo, pode querer recolher dados de estatísticas de parâmetros de consulta, cabeçalhos de pedidos, corpos de pedidos e respostas ou variáveis que define nas suas APIs.

Pode recolher dados de estatísticas personalizados com a política de DataCapture e, em seguida, usar a interface do utilizador ou a API de estatísticas para examinar os dados recolhidos.

Quando e durante quanto tempo estão disponíveis os meus dados de estatísticas?

Existem dois intervalos de tempo que controlam quando e durante quanto tempo pode ver os seus dados de estatísticas:

  • Intervalo de atraso dos dados: depois de fazer uma chamada a um proxy de API, os dados podem demorar até 10 minutos a ficar acessíveis para apresentação ou através de chamadas API.
  • Disponibilidade do Analytics: o período de retenção de dados do Analytics é de 14 meses.

Retenção do Analytics quando usa o suplemento Apigee API Analytics

Se tiver uma organização de pagamento conforme o uso, pode ativar o suplemento Apigee API Analytics ao nível do ambiente. Depois de o suplemento ser ativado para um ambiente, os dados de estatísticas do ambiente são retidos durante 14 meses. Pode aceder aos dados de estatísticas históricos do ambiente na página Métricas da API na consola, desde que o suplemento esteja ativado.

Se desativar o suplemento Apigee API Analytics para um ambiente numa organização de pagamento conforme o uso, os dados de estatísticas do ambiente são eliminados após 30 dias. Se reativar o suplemento no mesmo ambiente no prazo de 30 dias após a desativação, pode voltar a aceder aos dados de estatísticas do ambiente durante o período de retenção de 14 meses. Não são restaurados dados se o suplemento for reativado para o ambiente após 30 dias.

Se quiser reter dados de estatísticas de qualquer ambiente numa organização de pagamento conforme o uso para além do período de retenção de 14 meses, recomendamos que exporte e guarde os seus dados noutra localização. Também pode exportar os seus dados do Analytics antes de desativar o suplemento Apigee API Analytics ou no período de 30 dias após a desativação. Para mais informações, consulte o artigo Exportar dados do Analytics.

Onde são armazenados e processados os meus dados de estatísticas?

A localização de armazenamento e tratamento dos dados de estatísticas é determinada pela sua região de estatísticas, que especificou quando instalou o Apigee:

  • Se for cliente de subscrição e tiver instalado o Apigee através do assistente de aprovisionamento do Apigee, especificou a sua região de estatísticas no passo 1 de Crie uma organização, quando definiu a região de alojamento das estatísticas.
  • Se for um cliente de pagamento conforme o uso e tiver instalado o Apigee através da Google Cloud consola, especificou a sua região de estatísticas no passo 3 de Criar uma organização, quando definiu a região de alojamento das estatísticas.
  • Se instalou o Apigee a partir da linha de comandos como cliente de subscrição ou de pagamento conforme o uso, especificou a região de estatísticas quando definiu a variável de ambiente ANALYTICS_REGION.
  • Se instalou o Apigee com a opção de um clique, os seus dados de estatísticas são armazenados na região us-west1. Não pode alterar esta localização predefinida.

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

  • Para regiões de estatísticas fora dos EUA ou da UE, os dados de estatísticas são armazenados e tratados na região de estatísticas.
  • Para regiões de estatísticas nos EUA ou na UE, os dados são armazenados na multirregião dos EUA ou da UE, respetivamente, para uma maior disponibilidade.

Como posso aceder aos meus dados de estatísticas?

O Apigee API Analytics fornece ferramentas de visualização de dados incorporadas na IU do Apigee. Estas ferramentas incluem painéis de controlo de estatísticas predefinidos e relatórios personalizados que apresentam dados em gráficos e tabelas, e permitem-lhe analisar detalhadamente os dados agrupados em diferentes dimensões (como por proxy de API, endereço IP ou código de estado HTTP).

Também pode transferir dados de estatísticas através da API Apigee. Depois de transferidos, pode importar esses dados para as suas próprias ferramentas de visualização de dados ou sistema de estatísticas.

Painéis de controlo do Analytics

A IU do Apigee fornece um conjunto de painéis de controlo predefinidos que pode usar para ver dados de estatísticas.

Apigee na Cloud Console

Para abrir os painéis de controlo do Analytics (para organizações com pagamento conforme o uso ou subscrição):

Na Google Cloud consola, aceda à página Analytics > Métricas da API.

Aceda às métricas da API

A imagem seguinte mostra o painel de controlo Desempenho do proxy da API:

Selecione um dos seguintes separadores para ver os painéis de controlo:

Para mais informações, consulte o artigo Usar os painéis de controlo de estatísticas.

Relatórios personalizados

Os relatórios personalizados permitem-lhe analisar detalhadamente métricas específicas da API e ver os dados exatos que quer ver. Pode criar um relatório personalizado com qualquer um dos dados de estatísticas incorporados no Apigee.

Quando cria um relatório personalizado, seleciona os dados que quer ver (métricas), agrupa os dados de formas significativas (dimensões) e, opcionalmente, limita os dados devolvidos com base em caraterísticas específicas dos dados (filtragem).

Também pode definir o tipo de gráfico apresentado no relatório personalizado como um gráfico de colunas ou de linhas. As imagens seguintes mostram exemplos de gráficos para transações por segundo agrupadas por proxy de 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 o artigo Crie e faça a gestão de relatórios personalizados.

API do Analytics

Use a API Apigee para transferir dados de estatísticas. Por exemplo, pode usar a API para criar as suas próprias ferramentas de visualização que pode incorporar em portais ou apps personalizadas.

Segue-se um exemplo de chamada API para obter dados de estatísticas para proxies de 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"

Esta chamada devolve:

  • A soma dos pedidos (contagem de mensagens) por proxy de API
  • Durante um período de 24 horas
  • Agrupado 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

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

Para mais informações, consulte o artigo Usar a API de métricas.

Exporte dados do Analytics para a Google Cloud Platform

Pode usar a API Apigee para exportar todos os dados de estatísticas de um dia inteiro do Apigee para o seu próprio repositório de dados, como o Google Cloud Storage ou o BigQuery. Em seguida, pode tirar partido das poderosas capacidades de consulta e aprendizagem automática oferecidas pelo Google Cloud BigQuery e TensorFlow para realizar a sua própria análise de dados.

Para mais informações, consulte o artigo Exportar dados do Analytics.

Como posso partilhar dados com programadores de apps?

Quando pensa nos programadores de apps como seus clientes, quer certificar-se de que têm as ferramentas e as informações disponíveis para tirar o melhor partido da sua API.

As apps enviam dados através de proxies de API e, em seguida, a análise dos dados ajuda um programador de apps a compreender o desempenho da respetiva app.

Os programadores de apps não se preocupam apenas com a qualidade das respetivas apps, mas também têm muito interesse nas suas APIs. O portal do programador baseado no Drupal inclui uma página Desempenho da app opcional concebida para dar aos programadores de apps acesso a métricas importantes para as respetivas apps. Esta página faculta aos programadores informações sobre:

  • Erros: que erros da API a minha app está a ver?
  • Desempenho: a API é lenta? Que métodos da API são normalmente lentos ou estão lentos neste momento?
  • Disponibilidade: a API está ativa ou inativa?
  • Quota: a sua API tem uma quota? E, como programador da app, como estou a agir em relação à quota?

Para mais informações, consulte o artigo Monitorizar apps na documentação do Drupal 8.

Além disso, pode partilhar as estatísticas com os seus programadores:

  • Criar relatórios personalizados e partilhá-los com os programadores da sua app. Para mais informações, consulte o artigo Crie e faça a gestão de relatórios personalizados.
  • Usar as APIs de métricas para captar dados durante um período mais longo para partilhar offline com os programadores de apps. Para mais informações, consulte o artigo Use a API de métricas.

Como posso gerar dados de análise completos?

O que queremos dizer com estatísticas completas? Por exemplo, pode criar um proxy de API e o Apigee vai recolher dados de estatísticas sobre esse proxy. Mas e as métricas para o programador ou a app que chamou o proxy da API? Se o Apigee não souber quem fez uma chamada à API, não pode recolher esses dados.

São necessários alguns passos para permitir que o Apigee determine que programadores e que apps de programador estão a chamar os seus proxies de API. Segue-se uma lista desses passos com links para informações mais detalhadas:

  1. Crie um ou mais produtos de API, que é um agrupamento de proxies de API juntamente com um plano de serviço. Consulte o artigo Gerir produtos de API.
  2. Registar programadores de apps com o Apigee. Consulte o artigo Registar programadores de apps.
  3. Registar apps e gerir chaves da API para os seus programadores. Consulte o artigo Registe apps e faça a gestão de chaves da API.
  4. Adicione políticas de segurança aos seus proxies de API que validam chaves de API e/ou tokens de segurança. Consulte os seguintes tópicos: VerifyAPIKey policy, OAuthV2 policy e VerifyJWT policy.

Os seguintes tutoriais explicam os passos necessários que lhe permitem ver estatísticas para programadores e apps: Proteja uma API exigindo chaves da API e Proteja uma API com o OAuth.

Requisitos do Apigee Hybrid

Esta secção apresenta informações importantes para os utilizadores do Apigee hybrid.

Suporte para residência dos dados

As versões mais antigas do Apigee hybrid não suportam o Apigee API Analytics.

Outros requisitos

Mais informações