Colete dados de erro usando o Error Reporting

Neste documento, você encontra uma lista dos ambientes compatíveis com o Error Reporting, além de links para guias específicos por linguagem para desenvolvedores de aplicativos. Recomendamos que você use as bibliotecas de cliente específicas da linguagem ou dependa de registros coletados automaticamente. No entanto, é possível gravar dados de erro com a API Cloud Logging ou a API Error Reporting. Por exemplo, se você usar o Cloud Run, as exceções gravadas em stderr serão enviadas automaticamente para o Cloud Logging.

O Error Reporting é um serviço global que analisa automaticamente os registros no projeto do Google Cloud para identificar erros. No entanto, o Error Reporting só pode analisar entradas de registro armazenadas em buckets do Cloud Logging que estejam na região global, em que os projetos de origem e de destino do Google Cloud são os mesmos e as chaves de criptografia gerenciadas pelo cliente (CMEK) estão desativadas. Se você rotear registros para um projeto diferente do Google Cloud, buckets regionalizados ou ativar a CMEK, o Error Reporting não capturará e analisará esses registros. Para informações sobre como verificar a configuração dos buckets de registros, consulte Solução de problemas.

Suporte à nuvem privada virtual

O Error Reporting é um serviço compatível com a nuvem privada virtual (VPC, na sigla em inglês).

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 relatar dados de erro automaticamente

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

Instrumentar aplicativos 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 erro usando uma API

É possível relatar eventos de erro ao seu projeto do Google Cloud executando 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 são gravadas em um registro com 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, é possível que você incorra em custos de ingestão do Cloud Logging. Para controlar quais registros são ingeridos, consulte Filtros de exclusão.

    Se você relatar eventos de erro usando a API Error Reporting, o restante deste documento não se aplica.

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