Instrumentar apps Python para o Error Reporting

A biblioteca Error Reporting para Python permite enviar eventos de erro diretamente dos seus aplicativos Python para o Error Reporting, para que você possa diagnosticar e monitorar falhas de execução. A instrumentação do aplicativo com a biblioteca permite informar eventos de erro personalizados e capturar erros mesmo quando os buckets de registros usam chaves de criptografia gerenciadas pelo cliente (CMEK).

Para aplicativos executados em serviços integrados do Google Cloud , incluindo funções do Cloud Run, App Engine, Compute Engine e Google Kubernetes Engine, o Error Reporting também pode inferir eventos de erro automaticamente do Cloud Logging sem a biblioteca do Error Reporting para Python. Para que o Error Reporting infira eventos de erro dos registros, as entradas de registro precisam seguir os requisitos de formatação de erros e ser armazenadas em um bucket de registros sem CMEK pertencente ao projeto de origem ou ao projeto de destino para onde os registros foram encaminhados.

Antes de começar

Faça login na sua conta do Google Cloud . Se você começou a usar o Google Cloud, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

1. Prepare o ambiente para o desenvolvimento do Python.

   Acessar o guia de configuração do Python

Instale a biblioteca de cliente

A biblioteca Error Reporting para Python permite monitorar e visualizar eventos de erro informados por aplicativos Python executados em quase 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 Gravador do Error Reporting (roles/errorreporting.writer).

Alguns serviços do Google Cloud concedem automaticamente o papel de gravador do Error Reporting (roles/errorreporting.writer) à conta de serviço apropriada. No entanto, é necessário conceder esse papel à conta de serviço apropriada para alguns serviços.

Cloud Run e Cloud Run Functions

A conta de serviço padrão usada pelo Cloud Run tem as permissões do papel de gravador do Error Reporting (roles/errorreporting.writer).

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

O Cloud Run é configurado para usar o Error Reporting automaticamente. Exceções JavaScript não processadas vão aparecer no Logging e serão processadas pelo Error Reporting sem que seja preciso usar a biblioteca desse produto para Python.

Observação: o Error Reporting cria automaticamente um evento de erro quando uma entrada de registro contém um stack trace e o nível de gravidade da entrada de registro não está definido ou está definido como pelo menos ERROR.

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 erros gravadas em stderr são processadas automaticamente pelo Error Reporting, sem que seja preciso usar a biblioteca do Error Reporting para Python de forma direta.

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 que será usada pelo contêiner recebeu o papel 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 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 a ser usada pela instância de VM recebeu o papel 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 saber mais sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

2. No Google Cloud console, 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 que vai receber o escopo de acesso do cloud-platform.

4. Clique em Parar e em Editar.

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

6. Na seção Escopos de acesso, selecione Permitir acesso total a todas as APIs do Cloud e salve as mudanças.

7. Clique em Iniciar / retomar.

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 Error Reporting para Python em um ambiente de desenvolvimento local, como executar a biblioteca na sua própria estação de trabalho, forneça à biblioteca Error Reporting para Python as credenciais padrão do aplicativo local. Para mais informações, consulte Autenticar no Error Reporting.

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

1. Instale a CLI do Google Cloud.

2. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

3. Se você estiver usando um shell local, crie credenciais de autenticação local para sua conta de usuário:

   gcloud auth application-default login

   Não é necessário fazer isso se você estiver usando o Cloud Shell.

   Observação:se a CLI gcloud exibir um aviso de que sua conta não tem a permissão serviceusage.services.use, alguns comandos da CLI gcloud e bibliotecas de cliente podem não funcionar. Peça a um administrador para conceder a você o papel do IAM de consumidor do Service Usage (roles/serviceusage.serviceUsageConsumer) e execute o seguinte comando:

   gcloud auth application-default set-quota-project PROJECT_ID

   Se um erro de autenticação for retornado e você estiver usando um provedor de identidade (IdP) externo, confirme se você fez login na CLI gcloud com sua identidade federada.

Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

O método projects.events.report 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. Para mais informações, consulte Criar uma chave de API na documentação de autenticação do Google Cloud .

Ver grupos de erros

No console 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 Ver e filtrar grupos de erros.