Este documento lista os ambientes compatíveis com o Error Reporting e contém links para guias específicos de linguagens para desenvolvedores de aplicativos.
Recomendamos que você use as bibliotecas de cliente específicas da linguagem
ou use 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 do seu projeto do Google Cloud para identificar erros.
No entanto, o Error Reporting pode analisar apenas as 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
iguais e em que 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 as CMEKs,
o Error Reporting não vai capturar e analisar esses registros.
Para mais 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).
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:
- Ambiente flexível do App Engine
- Ambiente padrão do App Engine
- Apps Script
- Cloud Functions
- Cloud Run
- Compute Engine
- Google Kubernetes Engine
- Amazon EC2
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 cada linguagem:
Gravar dados de erro usando uma API
É possível relatar eventos de erro para o projeto do Google Cloud
executando o método da API Error Reporting
report
ou o método
write
da API Cloud Logging.
Se você exigir a autenticação baseada em chave de API, será necessário usar 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 objetoReportedErrorEvent
.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 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ê receba cobranças 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 aplicará.
Se você quiser usar a API Cloud Logging, formate o objeto
LogEntry
para que ele inclua um stack trace ou um objetoReportedErrorEvent
. Para mais informações sobre os requisitos de formatação, consulte Erros de formatação em registros.