A API Error Reporting oferece:
- Um endpoint simples para informar erros do serviço em execução.
- Acesso de leitura a grupos de erros e aos erros associados a eles.
Primeiros passos
Ative a API Error Reporting.
Funções necessárias para ativar APIs
Para ativar as APIs, é necessário ter o papel do IAM de administrador de uso do serviço (roles/serviceusage.serviceUsageAdmin), que contém a permissão serviceusage.services.enable. Saiba como conceder
papéis.
Autorizando o uso da API
O acesso à API Error Reporting é controlado por papéis e permissões do Identity and Access Management. Saiba mais sobre autenticação e autorização para APIs Google Cloud no Guia de autenticação.
Modelo de dados
A API Error Reporting define três entidades: eventos de erro, grupos de erros e estatísticas de grupos de erros. O objeto error group stats é aquele com que a maioria dos usuários interage com mais frequência.
Eventos de erro
Um ErrorEvent representa uma única ocorrência de um erro no seu aplicativo. O objeto contém informações sobre o erro, como o momento em que ele ocorreu, o contexto e a mensagem de erro retornada. Um evento de erro tem a disponibilidade garantida por pelo menos 30 dias após ser gerado.
Grupos de erro
Os objetos ErrorGroup são coleções de eventos de erro agrupados logicamente. O agrupamento é baseado em informações no stack trace do evento de erro. Um grupo de erros é um objeto simples que contém apenas o nome, o ID do grupo e os problemas de rastreamento associados.
Para atualizar os URLs de problemas de rastreamento, use o método update deste recurso.
Estatísticas do grupo de erros
Os objetos ErrorGroupStats contêm informações detalhadas sobre um grupo de erros e são os objetos da API com que você vai interagir com mais frequência. As informações no objeto groupStats incluem a primeira e a última vez que um evento de erro nesse grupo ocorreu, a contagem, o número de usuários afetados e muito mais. Esse objeto é útil ao criar widgets e painéis personalizados.
Operações
A API Error Reporting oferece suporte às seguintes operações:
- Informar um novo evento de erro
- Listar estatísticas do grupo de erros
- Listar eventos de erro
- Receber grupos de erros
- Atualizar os problemas de rastreamento de um grupo de erros
Informar eventos de erro
É possível relatar eventos de erro dos serviços em execução gravando-os em ReportedErrorEvent. Isso gera mensagens de erro formatadas corretamente no Cloud Logging. O nome do registro resultante é formatado como projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors. Ao usar este método, poderá haver cobranças por ingestão no Cloud Logging. Para controlar os custos, reveja Exclusões de registros.
Também é possível informar novos eventos de erro ao Error Reporting montando entidades de eventos de erro do seu serviço em execução e enviando-as ao método events.report.
Listar estatísticas do grupo de erros
Para receber uma lista de estatísticas de grupos de erros, envie uma solicitação ao método groupStats.list. É possível transmitir um ou mais parâmetros de consulta para filtrar as estatísticas do grupo retornadas.
Listar eventos de erro
Para receber uma lista de eventos de erro pertencentes a um grupo específico, envie uma solicitação ao método events.list. Você pode transmitir uma condição de filtro para essas solicitações e recuperar apenas os eventos de erro que ocorreram entre um horário de início e de término específicos ou que correspondem a contextos de serviço específicos.
Receber grupos de erros
Para recuperar um recurso de grupo de erros específico, envie uma solicitação ao método groups.get.
Atualizar grupos de erros
Para atualizar os URLs de problemas de rastreamento associados a um grupo de erros, envie um recurso ErrorGroup atualizado ao método groups.update.