Registo de registos de acesso do Apigee

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

Veja a documentação do Apigee Edge.

Pré-visualização

Este produto ou funcionalidade está sujeito aos "Termos de Ofertas de Pré-GA" na secção Termos Gerais do Serviço dos Termos Específicos do Serviço. Os produtos e as funcionalidades pré-GA estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

Os clientes com subscrição e pagamento conforme o uso do Apigee podem ativar os registos de acesso de entrada do Cloud Logging para cada instância do Apigee na respetiva organização. Depois de ativada, esta funcionalidade permite-lhe ver os registos gerados por gateways de entrada na sua infraestrutura do Apigee, como um equilibrador de carga de aplicações externo ou um gateway do Anthos, para ajudar na resolução de problemas de chamadas API do Apigee.

É importante ter em atenção que, se esta funcionalidade estiver ativada para uma ou mais das suas instâncias do Apigee, os registos enviados para o seu projeto são cobrados. Para mais informações sobre as Google Cloud cobranças de registo, consulte os preços do Cloud Logging.

Este tópico descreve como os clientes do Apigee podem ativar e usar os registos de acesso de entrada do Cloud Logging para as instâncias do Apigee na respetiva organização.

Antes de começar

Para ativar a funcionalidade, tem de ter a seguinte função e autorizações:

• Funções: administrador da organização do Apigee (roles/apigee.admin)
• Autorizações:
  • apigee.instances.create
  • apigee.instances.update

Verifique as funções

1. Na Google Cloud consola, aceda à página IAM.

   Aceda ao IAM
2. Selecione o projeto.

3. Na coluna Principal, encontre a linha que tem o seu endereço de email.

   Se o seu endereço de email não estiver nessa coluna, significa que não tem funções.

4. Na coluna Função da linha com o seu endereço de email, verifique se a lista de funções inclui as funções necessárias.

Conceda as funções

1. Na Google Cloud consola, aceda à página IAM.

   Aceda ao IAM
2. Selecione o projeto.
3. Clique em Conceder acesso.
4. No campo Novos membros, introduza o seu endereço de email.
5. Na lista Selecionar uma função, selecione uma função.
6. Para conceder funções adicionais, clique em Adicionar outra função e adicione cada função adicional.
7. Clique em Guardar.

Ative o registo de acesso de entrada para as suas instâncias do Apigee

Pode ativar o registo de acesso de entrada do Cloud Logging quando cria ou edita uma instância do Apigee através da IU do Apigee na Cloud Console ou da API.

Para ativar a funcionalidade quando criar ou atualizar uma instância do Apigee, siga as instruções em Gerir instâncias para começar a criar ou editar uma instância.

Apigee na Cloud Console

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

1. Clique no botão de ativar/desativar Ativar registo para ativar a funcionalidade.
2. Opcionalmente, selecione um código de resposta HTTP na caixa código de resposta para atuar como um filtro para os registos de acesso.

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

   Para criar um filtro personalizado, selecione Custom e introduza o filtro no seguinte formato:

   status_code > XX && status code <= YY

   Por exemplo:

   status_code >= 500 && status_code < 504

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

API Apigee

Para atualizar uma instância existente através da 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 "
        }
      }'

Onde:

• ORG_NAME é o nome da sua organização do Apigee.
• INSTANCE_NAME é o nome da instância do Apigee que quer editar.

Tenha em atenção que, neste comando, o valor especificado para a propriedade filter devolve todos os registos. Se quiser filtrar os registos com base em códigos de estado HTTP ou outros, pode ajustar o valor de filter.

Assim que a instância for criada ou atualizada com êxito, os registos de acesso de entrada dessa instância devem estar disponíveis no seu projeto em poucos minutos.

Veja os registos de acesso de entrada

Assim que a funcionalidade estiver ativada, pode ver os registos de acesso de entrada para instâncias no seu projeto em minutos através do Explorador de registos na Google Cloud consola.

Para ver entradas do registo no Explorador de registos:

1. Na Google Cloud consola, selecione Registo > Explorador de registos.

   Aceda ao Explorador de registos

2. Certifique-se de que o Google Cloud projeto está selecionado.
3. No separador Consulta, introduza o nome do registo no campo do editor Consulta através de um dos seguintes métodos:
   • Para usar a caixa de seleção Nome do registo:
     1. Clique na caixa de seleção Nome do registo para abrir o painel Nome do registo.
     2. Introduza ingress_instance na caixa Selecionar nomes de registos.
     3. Clique em Aplicar.
     4. O nome do registo aparece no campo do editor Query.
   • No campo do editor Consulta, introduza o nome do registo diretamente:

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

4. Crie o resto da consulta no campo do editor Consulta. Os registos são apresentados na lista Resultados da consulta.
5. Clique em qualquer entrada do registo para ver mais detalhes.

Resolução de problemas com registos de acesso de entrada

Depois de ativar a funcionalidade e os registos estarem disponíveis no Explorador de registos, pode tirar partido de várias funcionalidades do Cloud Logging para ajudar na resolução de problemas, incluindo:

• Criar consultas com a linguagem de consulta do Cloud Logging

  Pode obter e analisar registos quando usa o Explorador de registos escrevendo consultas no campo do editor de consultas e fazendo seleções nas opções dos menus de filtros incluídos nas entradas de registos. Para saber como criar consultas e analisar dados no Explorador de registos, consulte o artigo Crie e guarde consultas com a linguagem de consulta do Cloud Logging.

• Ativar métricas e alertas baseados em registos

  Pode definir a sua própria métrica baseada em registos para capturar informações específicas das suas instâncias do Apigee. Para mais informações, consulte o artigo Vista geral das métricas baseadas em registos.

  Pode criar uma política de alertas baseada em registos a partir do Explorador de registos. Para mais informações e passos detalhados, consulte o artigo Criar uma política de alertas baseada em registos através do Explorador de registos.

• Filtrar por códigos de estado HTTP

  Pode refinar as suas consultas no Explorador de registos para filtrar por códigos de estado HTTP, mesmo que não tenha optado por filtrar os registos de acesso de entrada por código de estado HTTP quando ativou a funcionalidade. Para adicionar este filtro à sua consulta, use o seguinte formato:

  status_code > XX && status code <= YY

  Por exemplo:

  status_code >= 500 && status_code < 504

• Filtrar por códigos de estado de entrada

  Além de filtrar por códigos de estado HTTP, pode criar uma consulta para filtrar por ingress status_code 0. Este código indica frequentemente um problema de rede ou de conetividade que impede o cliente de receber uma resposta do servidor.

Para uma explicação detalhada de todas as funcionalidades disponíveis no Explorador de registos, consulte o artigo Veja registos através do Explorador de registos.

Desative a funcionalidade

Depois de terminar a resolução de problemas da sua instância do Apigee, pode editar a instância para desativar a funcionalidade. Se desativar a funcionalidade, desativa o acesso aos registos do ingress_instance no seu projeto e interrompe a faturação.

Pode editar a instância para desativar a funcionalidade através da IU do Apigee na Google Cloud Console ou da API.

Apigee na Cloud Console

Para desativar a funcionalidade através do Apigee na Cloud Console:

1. Na Google Cloud consola, aceda à página Gestão > instâncias.

   Aceda a Instâncias

2. Clique na instância que quer editar.
3. Na página Detalhes da instância, clique em Editar.
4. Na página Editar instância, clique no botão Ativar registo para desativar a funcionalidade.
5. Clique em Guardar.

API Apigee

Use o seguinte comando para desativar a funcionalidade na sua 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"
        }
        }'

Onde:

• ORG_NAME é o nome da sua organização do Apigee.
• INSTANCE_NAME é o nome da instância do Apigee que quer editar.