Recolha dados de erros através do Error Reporting

Este documento indica os ambientes suportados pelo Error Reporting e inclui links para guias específicos do idioma para programadores de aplicações. Recomendamos que use as bibliotecas cliente específicas do idioma ou que confie nas entradas de registo recolhidas automaticamente. No entanto, pode escrever dados de erros com a API Cloud Logging ou a API Error Reporting. Por exemplo, se usar o Cloud Run, as exceções escritas em stderr são enviadas automaticamente para o Cloud Logging.

Os Relatórios de erros são um serviço global criado no Cloud Logging e podem analisar entradas de registo quando todas as seguintes condições são verdadeiras:

  • Os Assured Workloads estão desativados. Para mais informações, consulte o artigo Vista geral dos Assured Workloads.
  • As chaves de encriptação geridas pelo cliente (CMEK) estão desativadas em todos os contentores de registos que armazenam a entrada de registo. Os relatórios de erros não podem armazenar entradas de registo em contentores de registos com a CMEK ativada. Para obter informações sobre como determinar a configuração da CMEK para um contentor de registos, consulte Verifique a ativação da chave.
  • O contentor de registos cumpre um dos seguintes requisitos:
    • O contentor de registos é armazenado no mesmo projeto onde as entradas de registo tiveram origem.
    • As entradas de registo foram encaminhadas para um projeto e, em seguida, esse projeto armazenou essas entradas de registo num contentor de registos que lhe pertence.

Apoio técnico da nuvem virtual privada

O Error Reporting é um serviço suportado pela nuvem virtual privada (VPC).

Para reduzir o risco de exfiltração de dados, use os VPC Service Controls para criar um perímetro de serviço em torno dos serviços geridos pela Google. Para ver informações sobre o VPC Service Controls e como criar um parâmetro de serviço, consulte a documentação do VPC Service Controls.

Configure ambientes para comunicar automaticamente dados de erros

Para informações sobre os requisitos de configuração específicos do ambiente, consulte os seguintes guias:

Instrumente apps através de bibliotecas de cliente

Para informações sobre como configurar a sua aplicação para enviar relatórios de erros, consulte os guias de configuração específicos do idioma:

Escreva dados de erro através de uma API

Pode comunicar eventos de erro ao seu Google Cloud projeto executando o método da API Error Reporting report ou o método da API Cloud Logging write.

  • Se precisar de autenticação baseada em chaves de API, tem de usar a API Error Reporting. Para comunicar um evento de erro através da API Error Reporting, execute o método report e formate o corpo do pedido do método como um objeto ReportedErrorEvent.

    Quando usa a API Error Reporting, as entradas de registo com mensagens de erro formatadas corretamente são geradas e escritas automaticamente no Cloud Logging. Estas entradas de registo são escritas num registo cujo logName está formatado da seguinte forma:

    projects/PROJECT_ID/clouderrorreporting.googleapis.com%2Freported_errors

    Uma vez que as entradas de registo são geradas por chamadas para report, pode incorrer em custos de carregamento do Cloud Logging. Para controlar que entradas de registo são carregadas, consulte os filtros de exclusão.

    Se comunicar eventos de erro através da API Error Reporting, o resto deste documento não se aplica.

  • Se quiser usar a API Cloud Logging, tem de formatar o objeto LogEntry de modo a incluir um rastreio de pilha ou um objeto ReportedErrorEvent. Para mais informações acerca dos requisitos de formatação, consulte Erros de formato nos registos.