Como gerar registros de acesso da Apigee

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

Confira a documentação da Apigee Edge.

Os clientes de assinatura da Apigee e pagamento por uso podem ativar os registros de acesso de entrada do Cloud Logging para cada instância da Apigee na organização. Depois de ativado, esse recurso permite visualizar os registros gerados por gateways de entrada na sua infraestrutura da Apigee, como um balanceador de carga de aplicativo externo ou um gateway do Anthos, para ajudar na solução de problemas de chamadas de API da Apigee.

É importante observar que, se esse recurso estiver ativado para uma ou mais instâncias da Apigee, você vai receber cobranças pelos registros enviados para o projeto. Para mais informações sobre as cobranças do Google Cloud pela geração de registros, consulte Preços do Cloud Logging.

Neste tópico, descrevemos como os clientes da Apigee podem ativar e usar os registros de acesso de entrada do Cloud Logging para as instâncias da Apigee na organização.

Antes de começar

Para ativar o recurso, é necessário ter o seguinte papel e permissões:

  • Papéis: administrador da organização da Apigee (roles/apigee.admin)
  • Permissões:
    • apigee.instances.create
    • apigee.instances.update

Verificar os papéis

  1. No console do Google Cloud, abra a página IAM.

    Acessar IAM
  2. Selecione o projeto.

  3. Na coluna Principal, encontre a linha que contém seu endereço de e-mail.

    Caso seu endereço de e-mail não esteja nessa coluna, isso significa que você não tem papéis.

  4. Na coluna Papel da linha com seu endereço de e-mail, verifique se a lista de papéis inclui os papéis necessários.

Conceder os papéis

  1. No console do Google Cloud, abra a página IAM.

    Acessar IAM
  2. Selecione o projeto.
  3. Clique em CONCEDER ACESSO.
  4. No campo Novos participantes, digite seu endereço de e-mail.
  5. Na lista Selecionar um papel, escolha um.
  6. Para conceder outros papéis, clique em Adicionar outro papel e adicione cada papel adicional.
  7. Clique em Salvar.

Ative a geração de registros de acesso de entrada para suas instâncias da Apigee

É possível ativar a geração de registros de acesso de entrada do Cloud Logging ao criar ou editar uma instância da Apigee usando a IU da Apigee no console do Cloud ou a API.

Para ativar o recurso ao criar ou atualizar uma instância da Apigee, siga as instruções em Como gerenciar instâncias para começar a criar ou editar uma instância.

Apigee no console do Cloud

Na seção Logging da página Criar uma instância ou Editar instância:

  1. Clique no botão Ativar geração de registros para ativar o recurso.
  2. Também é possível selecionar um código de resposta HTTP na caixa código de resposta para atuar como um filtro dos registros de acesso.

    Se quiser incluir todos os registros, independentemente do código de resposta HTTP, selecione None (all HTTP responses).

    Para criar um filtro personalizado, selecione Custom e insira o filtro neste formato:

    status_code > XX && status code <= YY

    Exemplo:

    status_code >= 500 && status_code < 504

  3. Depois de fornecer todas as informações necessárias para criar ou editar sua instância, clique em Salvar.

API Apigee

Para atualizar uma instância atual usando a API Apigee, use o seguinte comando: 

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
          "enabled": "true",
          "filter": "status_code >= 0 && status_code < 600 "
        }
      }'

Em que:

  • ORG_NAME é o nome da organização da Apigee;
  • INSTANCE_NAME é o nome da instância da Apigee que você quer editar.

Nesse comando, o valor especificado para a propriedade filter retornará todos os registros. Se você quiser filtrar os registros com base em HTTP ou outros códigos de status, ajuste o valor filter.

Depois que a instância for criada ou atualizada, os registros de acesso de entrada dela estarão disponíveis no projeto em questão de minutos.

Conferir os registros de acesso de entrada

Depois que o recurso é ativado, é possível visualizar os registros de acesso de entrada das instâncias no projeto em poucos minutos usando a Análise de registros no console do Google Cloud.

Para visualizar entradas de registro no Análise de registros:

  1. No console do Google Cloud, selecione Logging > Análise de registros.

    Acessar a ferramenta Análise de registros

  2. Verifique se o projeto do Google Cloud está selecionado.
  3. Na guia Consulta, digite o nome do registro no campo do editor de consulta usando um destes métodos:
    • Para usar a caixa de seleção Nome do registro, faça o seguinte:
      1. Clique na caixa de seleção Nome do registro para abrir o painel Nome do registro.
      2. Digite ingress_instance na caixa Selecionar nomes de registros.
      3. Clique em Aplicar.
      4. O nome do registro aparece no campo do editor de consulta.
    • No campo do editor de consultas, digite o nome do registro diretamente:

      logName="projects/ORG_NAME/logs/apigee.googleapis.com/ingress_instance"

  4. Crie o restante da sua consulta no campo do editor de consultas. Os registros vão aparecer na lista Resultados da consulta.
  5. Clique em qualquer entrada de registro para conferir mais detalhes.

Solução de problemas com registros de acesso de entrada

Depois que o recurso for ativado e os registros estiverem disponíveis na Análise de registros, será possível aproveitar vários recursos do Cloud Logging para ajudar na solução de problemas, incluindo:

  • Como criar consultas usando a linguagem de consulta do Cloud Logging

    Recupere e analise registros ao usar a Análise de registros. Para isso, escreva consultas no campo do editor de consultas e faça seleções nas opções dos menus de filtro incluídas nas entradas de registro. Para saber mais sobre como criar consultas e analisar dados na Análise de registros, consulte Criar e salvar consultas usando a linguagem de consulta do Cloud Logging.

  • Como ativar alertas e métricas com base em registros

    É possível definir sua própria métrica com base em registros para capturar informações específicas das suas instâncias da Apigee. Para mais informações, consulte Visão geral das métricas com base em registros.

    É possível criar uma política de alertas com base em registros na Análise de registros. Para mais informações e etapas detalhadas, consulte Como criar uma política de alertas com base em registros usando a Análise de registros.

  • Como filtrar por códigos de status HTTP

    É possível refinar suas consultas na Análise de registros para filtrar por códigos de status HTTP, mesmo que não tenha optado por filtrar os registros de acesso de entrada por código de status HTTP ao ativar o recurso. Para adicionar esse filtro à sua consulta, use o seguinte formato:

    status_code > XX && status code <= YY

    Exemplo:

    status_code >= 500 && status_code < 504

  • Como filtrar por códigos de status de entrada

    Além de filtrar por códigos de status HTTP, é possível criar uma consulta para filtrar por ingress status_code 0. Esse código geralmente indica um problema de rede ou conectividade que impede o cliente de receber uma resposta do servidor.

Para uma explicação detalhada de toda a funcionalidade disponível na Análise de registros, consulte Visualizar registros usando a Análise de registros.

Desativar o recurso

Depois de concluir a solução de problemas da instância da Apigee, é possível editar a instância para desativar o recurso. Desativar o recurso vai desativar o acesso aos registros do ingress_instance no seu projeto e interromper o faturamento.

É possível editar a instância para desativar o recurso usando a IU da Apigee no console do Cloud ou a API.

Apigee no console do Cloud

Para desativar o recurso usando a Apigee no console do Cloud:

  • Abra a interface da Apigee no console do Cloud no navegador.
  • Selecione Gerenciamento > Instâncias.
  • Clique na instância que você quer editar.
  • Na página Detalhes da instância, clique em Editar.
  • Na página Editar instância, clique no botão Ativar geração de registros para desativar o recurso.
  • Clique em Salvar.

    • API Apigee

    Use o seguinte comando para desativar o recurso na instância: 

    curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
            "enabled": "false"
        }
        }'

    Em que:

    • ORG_NAME é o nome da organização da Apigee;
    • INSTANCE_NAME é o nome da instância da Apigee que você quer editar.