Como configurar o Error Reporting para Python

É 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).

O Error Reporting é integrado a alguns serviços do Google Cloud, como 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, consulte a seção Como executar no Google Cloud Platform 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. Faça login na sua conta do Google.

    Se você ainda não tiver uma, inscreva-se.

  2. No Console do Cloud, na página do seletor de projetos, selecione ou crie um projeto do Cloud.

    Acessar a página do seletor de projetos

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

  4. Ative a Error Reporting API .

    Ative a API

  5. Prepare o ambiente para o desenvolvimento do Python.

    Acessar o guia de configuração do Python

Instalar 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

    def simulate_error():
        from google.cloud import error_reporting
    
        client = error_reporting.Client()
        try:
            # simulate calling a method that's not defined
            raise NameError
        except Exception:
            client.report_exception()

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.

Como 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.

Como relatar erros

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

Python

def report_manual_error():
    from google.cloud import error_reporting

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

if __name__ == '__main__':
    simulate_error()
    report_manual_error()

Como executar no Google Cloud

O uso da biblioteca do Error Reporting para Python exige o papel Gravador do Error Reporting do gerenciamento de identidade e acesso. Por padrão, a maioria das plataformas de computação do Google Cloud concede esse papel.

É possível configurar o Error Reporting para Python nos seguintes ambientes do Google Cloud.

Ambiente flexível do App Engine

O App Engine concede o papel Gravador do Error Reporting (em inglês) por padrão.

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.

Google Kubernetes Engine

No GKE, você precisa adicionar o escopo de acesso cloud-platform ao criar o cluster, como mostra este exemplo de comando:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

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, é possível adicionar o escopo 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 a conta de serviço selecionada, verifique se ela recebeu o papel Gravador do Error Reporting (em inglês) na seção IAM e administrador do Console do Cloud.

Execução local e em outro lugar

Para usar a biblioteca do Error Reporting para Python fora do Google Cloud, incluindo a execução da biblioteca na sua própria estação de trabalho, nos computadores do seu data center ou nas instâncias de VM de outro provedor de nuvem, forneça as credenciais da conta de serviço e o ID do projeto do Google Cloud diretamente para a biblioteca do Error Reporting para Python.

É possível criar e receber credenciais da conta de serviço manualmente. Ao especificar o campo Papel, use o papel de gravador do Error Reporting. Para mais informações sobre os papéis de gerenciamento de identidade e acesso, consulte o Guia de controle de acesso.

Como visualizar relatórios de erros

Após a implantação, é possível visualizar os relatórios de erros no painel do Error Reporting no Console do Cloud.

Acessar o painel do Error Reporting

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