Como configurar o Cloud Logging para Python

É possível gravar registros no Cloud Logging por aplicativos Python usando o gerenciador de registros padrão do Python ou o Biblioteca de cliente da API Cloud Logging para Python diretamente. Quando você usar o gerenciador de registros padrão do Python, será preciso anexar um do Cloud Logging ao gerenciador raiz do Python. Este documento ilustra essa abordagem.

Antes de começar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

4. Enable the Cloud Logging API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

7. Enable the Cloud Logging API.

   Enable the API

8. Prepare o ambiente para o desenvolvimento do Python.

   Acessar o guia de configuração do Python

Instalar a biblioteca

Para instalar a biblioteca do Cloud Logging para Python, consulte Instale a biblioteca de cliente para Python. Essa biblioteca permite anexar um gerenciador do Cloud Logging ao Gerenciador de raiz do Python. Também é possível usar essa biblioteca para enviar para o Cloud Logging.

Para mais informações sobre a instalação, consulte a documentação da biblioteca do Cloud Logging para Python (em inglês). Além disso, use o rastreador de problemas (em inglês) para informá-los.

Gravar registros com o gerenciador padrão do Python

Para enviar todas as entradas de registro gravadas com o padrão Gerenciador de raiz do Python para o Cloud Logging, faça o seguinte:

1. Anexe o gerenciador do Cloud Logging ao registrador raiz do Python chamando O método setup_logging:

   # Imports the Cloud Logging client library
   import google.cloud.logging
   
   # Instantiates a client
   client = google.cloud.logging.Client()
   
   # Retrieves a Cloud Logging handler based on the environment
   # you're running in and integrates the handler with the
   # Python logging module. By default this captures all logs
   # at INFO level and higher
   client.setup_logging()

   Para informações sobre como configurar o gerenciador de geração de registros, consulte Integração com a biblioteca padrão de geração de registros.

2. Grave dados de registro usando o registrador raiz do Python:

   # Imports Python standard library logging
   import logging
   
   # The data to log
   text = "Hello, world!"
   
   # Emits the data using the standard logging module
   logging.warning(text)

   Por padrão, qualquer registro com nível de gravidade de pelo menos INFO que seja gravados pelo aplicativo é enviado ao Cloud Logging.

   Se as mensagens forem registradas no Logging pelo App Engine ou Google Kubernetes Engine, o gerenciador as envia para o ambiente respectivos tipos de recursos Caso contrário, os registros serão listados no registro python Tipo de recurso Global.

Gravar registros com a biblioteca de cliente do Cloud Logging

Para mais informações sobre como usar a biblioteca de cliente do Cloud Logging para Python, consulte Bibliotecas de cliente do Cloud Logging.

Executar no Google Cloud

Para que um aplicativo grave registros usando a biblioteca do Cloud Logging para Python, a a conta de serviço do recurso subjacente precisa ter o Gravador de registros (roles/logging.logWriter) papel do IAM. A maioria dos ambientes do Google Cloud configura automaticamente conta de serviço para ter esse papel.

App Engine

O Cloud Logging é ativado automaticamente para o App Engine, e a conta de serviço padrão do aplicativo tem as permissões do IAM por padrão para gravar entradas de registro.

Para mais informações, consulte Como gravar e visualizar registros do Terraform.

Google Kubernetes Engine (GKE)

O GKE concede automaticamente a conta de serviço o papel do IAM Gravador de registros (roles/logging.logWriter). Se você usar Federação de identidade da carga de trabalho para GKE com essa conta de serviço padrão para permitir que cargas de trabalho acessem APIs do Google Cloud, nenhuma outra configuração é necessária. No entanto, se você usar a federação de identidade da carga de trabalho para o GKE com um conta de serviço do IAM personalizada e garanta que o serviço personalizado tem o papel de Gravador de registros (roles/logging.logWriter).

Se necessário, também é possível usar o seguinte comando para adicionar o escopo de acesso logging.write ao criar o cluster:

gcloud container clusters create example-cluster-name \
    --scopes https://www.googleapis.com/auth/logging.write

Compute Engine

Observação: para usar a biblioteca do Cloud Logging para Python em uma instância de VM do Compute Engine, não é necessário instalar o agente do Cloud Logging.

Ao usar instâncias de VM do Compute Engine, adicione o escopo de acesso cloud-platform a cada instância. Ao criar uma nova instância por meio do Console do Google Cloud, faça isso na seção Identidade e acesso à API. do painel Criar instância. Use a conta de serviço padrão do Compute Engine ou outra de sua escolha e selecione Permitir acesso completo a todas as APIs do Cloud na seção Identidade e acesso à API. Seja qual for o serviço da conta selecionada, verifique se ela recebeu o Papel Gravador de registros no IAM e Admin da console do Google Cloud.

Execute localmente e em outro lugar

Para usar a biblioteca do Cloud Logging para Python fora do Google Cloud, faça o seguinte: incluindo a execução da biblioteca em sua própria estação de trabalho, no sistema computadores ou nas instâncias de VM de outro provedor de nuvem, é preciso informe o ID do projeto do Google Cloud e as permissões conta de serviço as credenciais diretamente para a biblioteca do Cloud Logging para Python.

Para contas de serviço atuais, faça o seguinte:

1. Conceda à conta de serviço o IAM Papel do IAM Gravador de registros (roles/logging.logWriter). Para mais informações sobre o IAM, consulte Controle de acesso.

2. Configure o Application Default Credentials.

Se você não tiver uma conta de serviço, crie uma. Para informações sobre processo, consulte Criar contas de serviço.

Para informações gerais sobre os métodos que você pode usar para autenticação, consulte Terminologia: contas de serviço.

Visualize os registros

No console do Google Cloud, acesse a página Análise de registros:

Acessar a Análise de registros

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Logging.

No Explorador de registros, é preciso especificar um ou mais recursos, mas a escolha deles pode não ser óbvia. Veja a seguir algumas dicas para ajudar você a começar:

• Se você estiver implantando seu aplicativo no App Engine ou usando as bibliotecas específicas dele, defina seu recurso como Aplicativo do GAE.

• Se você estiver implantando seu aplicativo no Compute Engine, defina o recurso como Instância de VM do GCE.

• Se você estiver implantando seu aplicativo no Google Kubernetes Engine, a configuração de geração de registros do cluster determinará o tipo de recurso das entradas de registro. Para um discussão sobre a observabilidade do Google Cloud legado e a observabilidade soluções do Kubernetes Monitoring e como elas afetam tipo de recurso, consulte Como migrar para o Google Cloud Observability Kubernetes Monitoring (em inglês).

• Se o aplicativo estiver usando a API Cloud Logging diretamente, o recurso dependerá da API e da configuração. Por exemplo, no seu aplicativo, é possível especificar um recurso ou usar um recurso padrão.

• Se você não vir registros no Explorador de registros, alterne para o modo de consulta avançada e use uma consulta vazia para ver todas as entradas de registro.

  1. Se quiser alternar para o modo de consulta avançada, clique no menu (▾) na parte superior do Explorador de registros e selecione Converter para filtro avançado.
  2. Limpe o conteúdo que aparece na caixa de filtro.
  3. Clique em Enviar filtro.

  É possível examinar as entradas individuais para identificar seus recursos.

Para mais informações, consulte Como usar a Análise de registros.