Configurar o Cloud Logging para Python

Pode escrever registos no Cloud Logging a partir de aplicações Python usando o controlador de registo Python padrão ou usando diretamente a biblioteca cliente da API Cloud Logging para Python. Quando usa o controlador de registo do Python padrão, tem de anexar um controlador do Cloud Logging ao controlador 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.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Logging API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Cloud Logging API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

    8.
  8. Prepare o seu ambiente para o desenvolvimento em Python.

    Aceda ao guia de configuração do Python

    9. Instale a biblioteca

    Para instalar a biblioteca Cloud Logging para Python, consulte o artigo Instale a biblioteca cliente para Python. Esta biblioteca permite-lhe anexar um controlador do Cloud Logging ao controlador raiz padrão do Python. Também pode usar esta biblioteca para enviar pedidos de API para o Cloud Logging.

    Para mais informações sobre a instalação, consulte a documentação da biblioteca Cloud Logging para Python. Também pode comunicar problemas através do relatório de erros.

    Escreva registos com o controlador de registo padrão do Python

    Para enviar todas as entradas de registo escritas com o controlador de raiz padrão do Python para o Cloud Logging, faça o seguinte:

    1. Anexe o controlador do Cloud Logging ao registador 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 obter informações sobre como configurar o controlador de registo, consulte o artigo Integração com a biblioteca padrão de registo.

      Para obter informações sobre os parâmetros da função setup_logging, aceda ao cliente do Cloud Logging e pesquise setup_logging. Por exemplo, esta página descreve como configurar os níveis de registo.

    2. Escreva dados de registo usando o registador 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 predefinição, qualquer registo cujo nível de gravidade seja, pelo menos, INFO escrito pela sua aplicação é enviado para o Cloud Logging.

      Se as mensagens forem registadas no Logging a partir do App Engine ou do Google Kubernetes Engine, o controlador envia-as para os tipos de recursos respetivos desses ambientes. Caso contrário, os registos são apresentados no registo python no tipo de recurso Global.

    Escreva registos com a biblioteca de cliente do Cloud Logging

    Para ver informações sobre a utilização da biblioteca cliente do Cloud Logging para Python diretamente, consulte o artigo Bibliotecas cliente do Cloud Logging.

    Executar em Google Cloud

    Para que uma aplicação escreva registos através da biblioteca Cloud Logging para Python, a conta de serviço do recurso subjacente tem de ter a função Escritor de registos (roles/logging.logWriter) do IAM. A maioria dos Google Cloud ambientes configura automaticamente a conta de serviço predefinida para ter esta função.

    App Engine

    O Cloud Logging é ativado automaticamente para o App Engine, e a conta de serviço predefinida da sua app tem as autorizações de IAM predefinidas para escrever entradas de registo.

    Para mais informações, consulte o artigo Escrever e ver registos.

    Google Kubernetes Engine (GKE)

    O GKE concede automaticamente à conta de serviço predefinida a função do IAM Logs Writer (roles/logging.logWriter). Se usar a Workload Identity Federation para o GKE com esta conta de serviço predefinida para permitir que as cargas de trabalho acedam a Google Cloud APIs específicas, não é necessária nenhuma configuração adicional. No entanto, se usar a Workload Identity Federation para o GKE com uma conta de serviço do IAM personalizada, certifique-se de que a conta de serviço personalizada tem a função de escritor de registos (roles/logging.logWriter).

    Se necessário, também pode usar o seguinte comando para adicionar o logging.write âmbito de acesso ao criar o cluster:

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

    Compute Engine

    Quando usar instâncias de VM do Compute Engine, adicione o cloud-platform âmbito de acesso a cada instância. Quando cria uma nova instância através da Google Cloud consola, pode fazê-lo na secção Identidade e acesso à API do painel Criar instância. Use a conta de serviço predefinida do Compute Engine ou outra conta de serviço à sua escolha e selecione Permitir acesso total a todas as APIs Cloud na secção Identidade e acesso à API. Qualquer que seja a conta de serviço que selecionar, certifique-se de que lhe foi concedida a função Logs Writer na secção IAM e administrador daGoogle Cloud consola.

    Executar localmente e noutro local

    Para usar a biblioteca Cloud Logging para Python fora do Google Cloud, incluindo a execução da biblioteca na sua própria estação de trabalho, nos computadores do seu centro de dados ou nas instâncias de VM de outro fornecedor de nuvem, tem de configurar as Credenciais predefinidas da aplicação (ADC) no seu ambiente local para se autenticar na biblioteca Cloud Logging para Python.

    Para mais informações, consulte o artigo Configure o ADC para um ambiente no local ou outro fornecedor de nuvem.

    Ver os registos

    Na Google Cloud consola, aceda à página Explorador de registos:

    Aceda ao Explorador de registos

    Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cuja legenda é Registo.

    No Explorador de registos, tem de especificar um ou mais recursos, mas a seleção de recursos pode não ser óbvia. Seguem-se algumas sugestões para ajudar a começar:

    • Se estiver a implementar a sua aplicação no App Engine ou a usar as bibliotecas específicas do App Engine, defina o seu recurso como Aplicação GAE.

    • Se estiver a implementar a sua aplicação no Compute Engine, defina o recurso como GCE VM Instance.

    • Se estiver a implementar a sua aplicação no Google Kubernetes Engine, a configuração de registo do cluster determina o tipo de recurso das entradas de registo. Para uma discussão detalhada sobre o Google Cloud Observability antigo e as soluções de monitorização do Kubernetes do Google Cloud Observability, e como essas opções afetam o tipo de recurso, consulte o artigo Migrar para a monitorização do Kubernetes do Google Cloud Observability.

    • Se a sua aplicação estiver a usar a API Cloud Logging diretamente, o recurso depende da API e da sua configuração. Por exemplo, na sua aplicação, pode especificar um recurso ou usar um recurso predefinido.

    • Se não vir registos no Explorador de registos, para ver todas as entradas de registo, mude para o modo de consulta avançado e use uma consulta vazia.

      1. Para mudar para o modo de consulta avançado, clique no menu (▾) na parte superior do Explorador de registos e, em seguida, selecione Converter em filtro avançado.
      2. Limpar o conteúdo apresentado na caixa de filtro.
      3. Clique em Enviar filtro.

      Pode examinar as entradas individuais para identificar os seus recursos.

    Para mais informações, consulte o artigo Usar o Explorador de registos.