Coletar dados de erros usando o Error Reporting

Você pode enviar exceções de aplicativos e eventos de erro para o Error Reporting para que ele possa analisar os dados de erro no seu projeto doGoogle Cloud . Dependendo do seu ambiente de computação, linguagem de programação e requisitos de autenticação, é possível coletar dados de erros das seguintes maneiras:

  • Coleta automática de registros: os ambientes de computação compatíveis enviam automaticamente dados de erros ao Cloud Logging para análise do Error Reporting. Por exemplo, o Cloud Run envia automaticamente exceções gravadas em stderr para o Logging.
  • Bibliotecas de cliente: é possível instrumentar o código do aplicativo com bibliotecas de cliente específicas da linguagem para enviar relatórios de erros diretamente do app.
  • APIs REST: é possível chamar a API Error Reporting ou a API Cloud Logging para gravar eventos de erro formatados e stack traces, inclusive quando você precisa de autenticação de chave de API.

Quando o Error Reporting analisa entradas de registro

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 de registros com a CMEK ativada. Para saber como determinar a configuração da CMEK para um bucket de registros, consulte Verificar a ativação da chave.
  • O bucket de registros atende a um dos seguintes critérios:
    • 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 do VPC Service Controls

O VPC Service Controls é compatível com o Error Reporting.

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 perí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 da linguagem:

Gravar dados de erros usando uma API

É possível informar eventos de erro ao seu projeto Google Cloud executando o método da API Error Reporting report ou o método da API Logging write.

  • Se você precisar de autenticação baseada em chave de API, use a API Error Reporting. Para informar 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.

    Ao usar a API Error Reporting, entradas de registro com mensagens de erro formatadas corretamente são geradas e gravadas automaticamente no 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 Logging. Para controlar quais entradas de registro são ingeridas, consulte Filtros de exclusão.

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