Gerenciar o complemento Apigee API Analytics

Esta página se aplica à Apigee, mas não à Apigee híbrida.

Confira a documentação da Apigee Edge.

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. Para mais informações sobre os tipos de dados que podem ser coletados e analisados com a análise de APIs da Apigee, consulte Visão geral do Apigee Analytics.

Se você é um cliente da Apigee de pagamento por uso, a análise de APIs da Apigee está disponível como um complemento pago. Neste tópico, descrevemos como ativar e gerenciar o complemento de análise da API Apigee para ambientes qualificados de pagamento por uso. Para mais informações sobre como usar os painéis de análise da API Apigee após a ativação do complemento nos ambientes da Apigee, consulte Como usar os painéis de análise.

Disponibilidade

A análise de APIs da Apigee está disponível como um recurso de complemento pago gerenciado para cada ambiente da Apigee na implementação da Apigee. O complemento pode ser ativado em qualquer ambiente intermediário ou completo da Apigee. Não é possível ativar e usar a análise de APIs da Apigee em ambientes Base. Para mais detalhes sobre os recursos do ambiente da Apigee, consulte Comparação de tipos de ambiente.

Papéis e permissões necessárias

Para receber as permissões necessárias para gerenciar o complemento de análise da API Apigee, peça ao administrador para conceder a você o papel de administrador do ambiente da Apigee (apigee.environment.admin) do IAM no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esse papel predefinido contém as permissões necessárias para gerenciar o complemento Apigee API Analytics. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As permissões a seguir são necessárias para gerenciar o complemento de análise da API Apigee:

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Ativar o complemento de análise da API Apigee

É possível ativar o complemento Apigee API Analytics para um ambiente Intermediário ou Abrangente da Apigee usando a IU da Apigee no console do Google Cloud ou usando a API, conforme descrito nas seções a seguir.

Apigee no console do Google Cloud

Para ativar o complemento Apigee API Analytics no console do Google Cloud:

  1. Abra a página Apigee no console.

    Acessar a Apigee

  2. Selecione o projeto com a organização de pagamento por uso e os ambientes que você quer gerenciar.
  3. Selecione Complementos > Analytics para abrir a página Complemento do Analytics.
  4. No painel Gerenciar complemento Apigee API Analytics, marque a caixa de seleção do ambiente (ou ambientes) em que você quer ativar o complemento.
  5. Clique em Ativar selecionadas.
  6. Quando a ativação dos ambientes selecionados for concluída, o Status do ambiente exibirá Ativado.
  7. Para visualizar seus dados de análise da API Apigee, selecione Analytics > Métricas da API para visualizar seus dados de análise. Pode levar até 10 minutos para que os dados de análise sejam exibidos.

API Apigee

Para ativar o complemento Apigee API Analytics usando a API Apigee, digite o seguinte comando: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":true}'

Em que:

  • ORG_NAME é o nome da organização de pagamento por uso da Apigee a que você quer adicionar o Analytics aos ambientes qualificados.
  • ENV_NAME é o nome do ambiente da Apigee em que você quer ativar o complemento de análise da API Apigee.

Quando a ativação for concluída, selecione Analytics > API Metrics para visualizar seus dados de análise de APIs da Apigee. Pode levar até 10 minutos para que os dados de análise apareçam na interface do usuário ou fiquem disponíveis por meio de uma chamada de API.

O processo de ativação do complemento de análise da API Apigee pode levar até 15 minutos. Depois de ativados, os dados de análise do ambiente são retidos por 14 meses. É possível acessar os dados históricos do ambiente na página Métricas da API no console, desde que o complemento esteja ativado.

O faturamento pelo uso do complemento Apigee API Analytics começa quando a ativação do complemento começa.

Desativar o complemento Apigee API Analytics

É possível desativar o complemento Apigee API Analytics para um ambiente Apigee intermediário ou abrangente usando a IU da Apigee no console do Google Cloud ou usando a API, conforme descrito nas seções a seguir.

Se o complemento "Segurança da API avançada" estiver ativado no ambiente, será necessário desativá-lo antes de desativar o complemento "Análise da API da Apigee". Se o complemento Advanced API Security não estiver desativado, qualquer solicitação para desativar a Apigee API Analytics no ambiente vai falhar. Se o complemento Advanced API Security estiver ativado no seu ambiente, ele será exibido na coluna Outros complementos ativados do complemento "Gerenciar análise da API Apigee".

Para desativar o complemento, consulte Desativar o complemento "Segurança avançada da API".

Apigee no console do Cloud

Para desativar o complemento Apigee API Analytics no console do Google Cloud:

  1. Abra a página Apigee no console.

    Acessar a Apigee

  2. Selecione o projeto com a organização de pagamento por uso e os ambientes que você quer gerenciar.
  3. Selecione Complementos > Analytics para abrir a página Complemento do Analytics.
  4. No painel Gerenciar complemento Apigee API Analytics, marque a caixa de seleção do ambiente (ou ambientes) em que você quer desativar o complemento.
  5. Clique em Desativar selecionados.
  6. Quando a desativação for concluída, o Status exibirá Desativado para cada ambiente.

API Apigee

Para desativar o complemento Apigee API Analytics usando a API Apigee, digite o seguinte comando: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":false}'

Em que:

  • ORG_NAME é o nome da organização de pagamento por uso da Apigee a que você quer adicionar o Analytics aos ambientes qualificados.
  • ENV_NAME é o nome do ambiente da Apigee em que você quer ativar o complemento de análise da API Apigee.

Ver o status do complemento de análise da API Apigee em um ambiente

É possível verificar o status do complemento de análise da API Apigee para um ambiente da Apigee intermediário ou abrangente usando a IU da Apigee no console do Google Cloud ou usando a API, conforme descrito nas seções a seguir.

Apigee no console do Google Cloud

Para ver o status do complemento de análise da API Apigee em um ambiente usando o console do Google Cloud:

  1. Abra a página Apigee no console.

    Acessar a Apigee

  2. Selecione o projeto com a organização de pagamento por uso e os ambientes que você quer gerenciar.
  3. Selecione Complementos > Analytics para abrir a página Complemento do Analytics.
  4. No painel Gerenciar complemento Apigee API Analytics, aparece uma lista de ambientes.
  5. Na coluna de status, é possível ver se o complemento está Ativado ou Desativado em cada ambiente intermediário ou abrangente. Os ambientes de base não exibem nenhum status.

API Apigee

Para visualizar o status do complemento Apigee API Analytics em um ambiente usando a API Apigee, digite o seguinte comando: 

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json"

Em que:

  • ORG_NAME é o nome da organização de pagamento por uso da Apigee.
  • ENV_NAME é o nome do ambiente da Apigee.

A resposta retorna um objeto analyticsConfig que representa o status atual do complemento.

Gerenciar seus dados de análise da API Apigee

Depois que o complemento Apigee API Analytics é ativado em 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 de análise da API Apigee em um ambiente, os dados de análise para o 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 após o 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.