Faça a gestão do suplemento Apigee API Analytics

Esta página aplica-se ao Apigee, mas não ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

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. Para mais informações sobre os tipos de dados que pode recolher e analisar com o Apigee API Analytics, consulte o artigo Vista geral do Apigee Analytics.

Se for cliente do Apigee com pagamento conforme o uso, o Apigee API Analytics está disponível como um suplemento pago. Este tópico descreve como ativar e gerir o suplemento Apigee API Analytics para ambientes de pagamento conforme o uso elegíveis. Para mais informações sobre a utilização dos painéis de controlo do Apigee API Analytics depois de o suplemento ser ativado nos seus ambientes do Apigee, consulte o artigo Usar os painéis de controlo de estatísticas.

Disponibilidade

A Apigee API Analytics está disponível como uma capacidade suplementar paga que é gerida para cada ambiente do Apigee na sua implementação do Apigee. O suplemento pode ser ativado em qualquer ambiente Intermédio ou Abrangente do Apigee. Não pode ativar nem usar o Apigee API Analytics em ambientes Base. Para mais detalhes sobre as capacidades do ambiente do Apigee, consulte a Comparação de tipos de ambientes.

Funções e autorizações necessárias

Para receber as autorizações de que precisa para gerir o suplemento Apigee API Analytics, peça ao seu administrador para lhe conceder a função do IAM Administrador do ambiente do Apigee (apigee.environment.admin) no projeto. Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

Esta função predefinida contém as autorizações necessárias para gerir o suplemento Apigee API Analytics. Para ver as autorizações exatas que são necessárias, expanda a secção Autorizações necessárias:

Autorizações necessárias

São necessárias as seguintes autorizações para gerir o suplemento Apigee API Analytics:

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

Também pode conseguir estas autorizações com funções personalizadas ou outras funções predefinidas.

Ative o suplemento API Apigee do Analytics

Pode ativar o suplemento Apigee API Analytics para um ambiente do Apigee intermédio ou abrangente através da IU do Apigee na Google Cloud consola ou através da API, conforme descrito nas secções seguintes.

Apigee na Google Cloud consola

Para ativar o suplemento Apigee API Analytics na Google Cloud consola:

  1. Abra a página Apigee na consola.

    Aceder ao Apigee

  2. Selecione o projeto com a organização e os ambientes de pagamento conforme o uso que quer gerir.
  3. Selecione Suplementos > Analytics para abrir a página do suplemento do Analytics.
  4. No painel Gerir suplemento Apigee API Analytics, selecione a caixa de verificação do ambiente (ou ambientes) onde quer ativar o suplemento.
  5. Clique em Ativar selecionados.
  6. Quando a ativação estiver concluída para os ambientes selecionados, o Estado do ambiente apresenta Ativado.
  7. Para ver os dados do Apigee API Analytics, selecione Analytics > Métricas da API para ver os dados de estatísticas. A apresentação dos dados de estatísticas pode demorar até 10 minutos.

API Apigee

Para ativar o suplemento Apigee API Analytics através da API Apigee, introduza 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}'

Onde:

  • ORG_NAME é o nome da organização do Apigee com pagamento conforme o uso onde quer adicionar o Analytics a ambientes elegíveis.
  • ENV_NAME é o nome do ambiente do Apigee onde quer ativar o suplemento Apigee API Analytics.

Assim que a ativação estiver concluída, selecione Analytics > Métricas da API para ver os dados do Apigee API Analytics. Os dados de estatísticas podem demorar até 10 minutos a serem apresentados na IU ou a ficarem disponíveis através de uma chamada API.

O processo de ativação do suplemento Apigee API Analytics pode demorar até 15 minutos. Depois de ativados, os dados de estatísticas da propriedade são retidos durante 14 meses. Pode aceder aos dados históricos do ambiente na página Métricas da API na consola, desde que o suplemento esteja ativado.

A faturação da utilização do suplemento Apigee API Analytics começa assim que a ativação do suplemento é iniciada.

Desative o suplemento API Apigee do Analytics

Pode desativar o suplemento Apigee API Analytics para um ambiente intermédio ou abrangente do Apigee através da IU do Apigee na Google Cloud consola ou através da API, conforme descrito nas secções seguintes.

Se tiver o suplemento de segurança avançada da API ativado no ambiente, tem de desativar o suplemento de segurança avançada da API antes de poder desativar o suplemento Apigee API Analytics. Se o suplemento Advanced API Security não estiver desativado, qualquer pedido para desativar o Apigee API Analytics no ambiente vai falhar. Se o suplemento de segurança avançada da API estiver ativado no seu ambiente, é apresentado na coluna Outros suplementos ativados do painel Gerir suplemento Apigee API Analytics.

Para desativar o suplemento, consulte o artigo Desative o suplemento de segurança avançada da API.

Apigee na Cloud Console

Para desativar o suplemento Apigee API Analytics na Google Cloud consola:

  1. Abra a página Apigee na consola.

    Aceder ao Apigee

  2. Selecione o projeto com a organização e os ambientes de pagamento conforme o uso que quer gerir.
  3. Selecione Suplementos > Analytics para abrir a página do suplemento do Analytics.
  4. No painel Gerir suplemento Apigee API Analytics, selecione a caixa de verificação do ambiente (ou ambientes) onde quer desativar o suplemento.
  5. Clique em Desativar selecionados.
  6. Quando a desativação estiver concluída, o Estado apresenta Desativado para cada ambiente.

API Apigee

Para desativar o suplemento Apigee API Analytics através da API Apigee, introduza 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}'

Onde:

  • ORG_NAME é o nome da organização do Apigee com pagamento conforme o uso onde quer adicionar o Analytics a ambientes elegíveis.
  • ENV_NAME é o nome do ambiente do Apigee onde quer ativar o suplemento Apigee API Analytics.

Veja o estado do suplemento da API Apigee do Analytics num ambiente

Pode verificar o estado do suplemento Apigee API Analytics para um ambiente Apigee intermédio ou abrangente através da IU do Apigee na Google Cloud consola ou através da API, conforme descrito nas secções seguintes.

Apigee na Google Cloud consola

Para ver o estado do suplemento Apigee API Analytics num ambiente através da Google Cloud consola:

  1. Abra a página Apigee na consola.

    Aceder ao Apigee

  2. Selecione o projeto com a organização e os ambientes de pagamento conforme o uso que quer gerir.
  3. Selecione Suplementos > Analytics para abrir a página do suplemento do Analytics.
  4. No painel Gerir suplemento Apigee API Analytics, é apresentada uma lista de ambientes.
  5. Na coluna de estado, pode ver se o suplemento está Ativado ou Desativado em cada ambiente intermédio ou abrangente. Os ambientes base não apresentam nenhum dos estados.

API Apigee

Para ver o estado do suplemento Apigee API Analytics num ambiente através da API Apigee, introduza 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"

Onde:

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

A resposta devolve um objeto analyticsConfig que representa o estado atual do suplemento.

Faça a gestão dos seus dados do Apigee API Analytics

Depois de o suplemento Apigee API Analytics 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 num ambiente, 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 para além do período de retenção de 14 meses, recomendamos que exporte e guarde os seus dados noutro local. 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.