Coletar dados de erros usando o Error Reporting

Este documento lista os ambientes compatíveis com o Error Reporting e links para guias específicos de linguagem para desenvolvedores de aplicativos. Recomendamos que você use as bibliotecas de cliente específicas de linguagem ou confie em entradas de registro coletadas automaticamente. No entanto, é possível gravar dados de erro com a API Cloud Logging ou a API Error Reporting. Por exemplo, se você usa o Cloud Run, as exceções gravadas em stderr são enviadas automaticamente para o Cloud Logging.

O Error Reporting é um serviço global criado no Cloud Logging e pode analisar entradas de registro quando todas as condições a seguir são verdadeiras:

  • O Assured Workloads está desativado. Para mais informações, consulte Visão geral do Assured Workloads.
  • As chaves de criptografia gerenciadas pelo cliente (CMEK) estão desativadas em todos os buckets de registros que armazenam a entrada de registro. O Error Reporting não pode armazenar entradas de registro em buckets com a CMEK ativada. Para saber como determinar a configuração da CMEK de um bucket de registros, consulte Verificar a ativação da chave.
  • O bucket de registros atende a uma das seguintes condições:
    • O bucket de registros é armazenado no mesmo projeto em que as entradas de registro foram criadas.
    • As entradas de registro foram encaminhadas para um projeto, que as armazenou em um bucket de registros de propriedade dele.

Suporte à nuvem privada virtual

O Error Reporting é um serviço compatível com a nuvem privada virtual (VPC).

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

Configurar ambientes para informar dados de erros automaticamente

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

Instrumentar apps usando bibliotecas de cliente

Para informações sobre como configurar seu aplicativo para enviar relatórios de erros, consulte os guias de configuração específicos de linguagem:

Gravar dados de erros usando uma API

Para informar eventos de erro ao seu projeto Google Cloud , execute o método da API Error Reporting report ou o método da API Cloud Logging write.

  • Se você precisar de autenticação baseada em chave de API, use a API Error Reporting. Para relatar um evento de erro usando a API Error Reporting, execute o método report e formate o corpo da solicitação do método como um objeto ReportedErrorEvent.

    Quando você usa a API Error Reporting, as entradas de registro com mensagens de erro formatadas corretamente são geradas e gravadas automaticamente no Cloud Logging. Essas entradas de registro são gravadas em um registro cujo logName é formatado da seguinte maneira:

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

    Como as entradas de registro são geradas por chamadas para report, você pode ter custos de ingestão do Cloud Logging. Para controlar quais entradas de registro são ingeridas, consulte Filtros de exclusão.

    Se você relatar eventos de erro usando a API Error Reporting, o restante deste documento não será aplicável.

  • Se você quiser usar a API Cloud Logging, formate o objeto LogEntry para incluir um stack trace ou um objeto ReportedErrorEvent. Para mais informações sobre os requisitos de formatação, consulte Erros de formatação em registros.