Instrumentar os apps Python para o Error Reporting

É possível enviar relatórios de erros para o Error Reporting a partir de aplicativos Python usando a biblioteca do Error Reporting para Python (em inglês). Use a biblioteca do Error Reporting para Python para criar grupos de erros nos seguintes casos:

• Um bucket de registros que contém suas entradas de registro tem chaves de criptografia gerenciadas pelo cliente (CMEK).
• O bucket de registro atende a uma das seguintes condições:
  • O bucket de registros é armazenado no mesmo projeto em que as entradas se originou.
  • As entradas de registro foram roteadas para um projeto, que as armazenou em um bucket de registro.
• Você quer informar eventos de erro personalizados.

O Error Reporting é integrado a alguns serviços do Google Cloud, como Cloud Functions, App Engine, Compute Engine e Google Kubernetes Engine. Essa ferramenta exibe os erros registrados no Cloud Logging por aplicativos em execução nesses serviços. Para mais informações, acesse Executar no Google Cloud nesta página.

Também é possível enviar dados de erros para o Error Reporting usando o Logging. Para mais informações sobre os requisitos de formatação de dados, leia Como formatar mensagens de erro no Logging (em inglês).

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 Error Reporting 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 Error Reporting API .

   Enable the API

8. Prepare o ambiente para o desenvolvimento do Python.

   Acessar o guia de configuração do Python

Instale a biblioteca de cliente

Com a biblioteca do Error Reporting para Python, você consegue monitorar e visualizar os erros relatados por aplicativos Python executados em praticamente qualquer lugar.

1. Instancie um ambiente virtual e use pip para instalar o pacote:

   pip install google-cloud-error-reporting --upgrade
   

2. Importe a biblioteca e instancie um cliente para começar a relatar erros:

   Python

   Para autenticar no Error Reporting, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

   #!/usr/bin/env python
   #
   # Copyright 2022 Google, Inc.
   #
   # Licensed under the Apache License, Version 2.0 (the "License");
   # you may not use this file except in compliance with the License.
   # You may obtain a copy of the License at
   #
   #    http://www.apache.org/licenses/LICENSE-2.0
   #
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   # See the License for the specific language governing permissions and
   # limitations under the License.
   
   
   def report_exception():
       from google.cloud import error_reporting
   
       client = error_reporting.Client()
       try:
           raise Exception("Something went wrong")
       except Exception:
           client.report_exception()
   
   
   
   
   def report_manual_error():
       from google.cloud import error_reporting
   
       client = error_reporting.Client()
       client.report("An error has occurred.")
   
   
   
   
   if __name__ == "__main__":
       report_exception()
       report_manual_error()
   

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

Configurar a biblioteca de cliente

É possível personalizar o comportamento da biblioteca do Error Reporting para Python. Veja exemplos de configuração na documentação da biblioteca de cliente.

Executar apps no Google Cloud

Para criar grupos de erros usando projects.events.report, sua conta de serviço precisa do papel de gravador do Error Reporting (roles/errorreporting.writer).

Alguns serviços do Google Cloud concedem automaticamente Gravador do Error Reporting (roles/errorreporting.writer) ao papel conta de serviço. No entanto, você precisa conceder esse papel à conta de serviço adequada para alguns serviços.

Ambiente flexível do App Engine

O App Engine concede o papel de gravador do Error Reporting (roles/errorreporting.writer) à sua conta de serviço padrão automaticamente.

A biblioteca do Error Reporting para Python pode ser usada sem a necessidade de fornecer credenciais explicitamente.

O Error Reporting é ativado automaticamente para aplicativos do ambiente flexível do App Engine. Nenhuma outra configuração é necessária.

Observação :as entradas de registro de erro gravadas em stderr são processadas automaticamente pelo o Error Reporting, sem precisar usar o biblioteca do Error Reporting para Python diretamente.

Google Kubernetes Engine

Para usar o Error Reporting com o Google Kubernetes Engine, faça o seguinte:

1. Verifique se a conta de serviço a ser usada pelo contêiner foi concedeu o Papel Gravador do Error Reporting (roles/errorreporting.writer).

   Use a conta de serviço padrão do Compute Engine ou uma conta de serviço personalizada.

   Para saber mais sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

2. Crie o cluster e conceda a ele o escopo de acesso cloud-platform.

   Por exemplo, o comando de criação a seguir especifica o escopo de acesso cloud-platform e uma conta de serviço:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Observação: depois de criar um cluster, não é possível mudar a conta de serviço dele.

Compute Engine

Para usar o Error Reporting com instâncias de VM do Compute Engine, faça o seguinte:

1. Verifique se a conta de serviço usada pela instância da VM recebeu o papel de Gravador do Error Reporting (roles/errorreporting.writer).

   É possível usar a conta de serviço padrão do Compute Engine ou uma conta de serviço personalizada.

   Para informações sobre como conceder papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

2. No Console do Google Cloud, acesse a página Instâncias de VM.

   Acessar Instâncias de VM

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

3. Selecione a instância de VM em que você quer receber os escopo de acesso cloud-platform.

4. Clique em Interromper e Editar.

5. Na seção Identidade e acesso à API, selecione uma conta de serviço que tem o papel de Gravador do Error Reporting (roles/errorreporting.writer).

6. Na seção Escopos de acesso, selecione Permitir acesso completo a todas as APIs do Cloud e salve as alterações.

7. Clique em Iniciar / retomar.

Cloud Functions

As funções do Cloud Run concedem o Papel Gravador do Error Reporting (roles/errorreporting.writer) para a conta de serviço padrão.

A biblioteca do Error Reporting para Python pode ser usada sem a necessidade de fornecer credenciais explicitamente.

As funções do Cloud Run são configuradas para usar o Error Reporting automaticamente. As exceções de JavaScript não processadas vão aparecer no Logging e serão processadas pelo Error Reporting sem a necessidade de usar a biblioteca Error Reporting para Python.

Observação :as entradas de registro serão processadas automaticamente se tiverem um stack trace e eles especificarem nenhuma gravidade de registro ou uma gravidade de registro de pelo menos ERROR, sem precisar usar a biblioteca do Error Reporting para Python.

Exemplo

É possível relatar um erro, manualmente, chamando o método report, conforme visto no exemplo a seguir:

Python

Para autenticar no Error Reporting, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação.

#!/usr/bin/env python
#
# Copyright 2022 Google, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


def report_exception():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    try:
        raise Exception("Something went wrong")
    except Exception:
        client.report_exception()




def report_manual_error():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    client.report("An error has occurred.")




if __name__ == "__main__":
    report_exception()
    report_manual_error()

Executar apps em um ambiente de desenvolvimento local

Para usar a biblioteca do Error Reporting para Python em um ambiente de desenvolvimento local, como a execução da biblioteca na sua própria estação de trabalho, você precisa fornecer a biblioteca do Error Reporting para Python com as credenciais padrão do aplicativo local. Para mais informações, consulte Autenticar para o Error Reporting.

Para usar os exemplos Python desta página em um ambiente de desenvolvimento local, instale e inicialize o gcloud CLI e e configure o Application Default Credentials com suas credenciais de usuário.

1. Install the Google Cloud CLI.

2. To initialize the gcloud CLI, run the following command:

   gcloud init

3. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

   gcloud auth application-default set-quota-project PROJECT_ID

Confira mais informações em Set up authentication for a local development environment.

O projects.events.report método também aceita chaves de API. Se você quiser usar chaves de API na autenticação, não será necessário configurar um arquivo local do Application Default Credentials. Confira mais informações em Crie uma chave de API na documentação de autenticação do Google Cloud

Como visualizar relatórios de erros

No console do Google Cloud, acesse a página Error Reporting:

Acessar o Error Reporting

Também é possível encontrar essa página usando a barra de pesquisa.

Para mais informações, consulte Como visualizar erros.