La API de Error Reporting proporciona lo siguiente:
- Un extremo simple para informar errores de tu servicio en ejecución
- Acceso de lectura a los grupos de errores y sus errores asociados
Cómo comenzar
Habilitar la API de Error Reporting.
Roles necesarios para habilitar las APIs
Para habilitar las APIs, necesitas el rol de IAM de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin), que contiene el permiso serviceusage.services.enable. Obtén más información para otorgar roles.
Autoriza el uso de la API
El acceso a la API de Error Reporting está controlado por las funciones y los permisos de Identity and Access Management. Puedes obtener más información sobre la autenticación y la autorización para las Google Cloud APIs en la Guía de autenticación.
Modelo de datos
La API de Error Reporting define tres entidades: eventos de errores, grupos de errores y estadísticas de grupos de errores. El objeto de estadísticas de grupos de errores es el objeto con el que la mayoría de los usuarios interactuarán con mayor frecuencia.
Eventos de errores
Un ErrorEvent representa una sola ocurrencia de un error en tu aplicación. El objeto contiene información sobre el error, como la hora en que ocurrió, el contexto en el que ocurrió y el mensaje de error que se mostró. Se garantiza que un evento de error estará disponible durante al menos 30 días después de su generación.
Grupos de errores
ErrorGroup objetos son colecciones de eventos de errores agrupados de forma lógica. La agrupación se basa en la información del seguimiento de pila del evento de error. Un grupo de errores es un objeto simple que contiene solo el nombre, el ID del grupo y cualquier problema de seguimiento asociado para el grupo.
Para actualizar las URLs de los problemas de seguimiento, usa el método update de este recurso.
Estadísticas de grupos de errores
Los objetos ErrorGroupStats contienen información detallada sobre un grupo de errores y son los objetos de la API con los que interactuarás con mayor frecuencia. La información del objeto groupStats incluye la primera y la última vez que ocurrió un evento de error en este grupo, el recuento, la cantidad de usuarios afectados y mucho más. Este objeto es útil cuando se crean widgets y paneles personalizados.
Operaciones
La API de Error Reporting admite las siguientes operaciones:
- Informar un evento de error nuevo
- Enumerar estadísticas de grupos de errores
- Mostrar eventos de errores
- Obtener grupos de errores
- Actualizar los problemas de seguimiento de un grupo de errores
Informar eventos de errores
Puedes informar sobre los eventos de errores de tus servicios en ejecución si los escribes en ReportedErrorEvent. Cuando lo haces, se generan mensajes de error con el formato correcto en Cloud Logging. El nombre del registro resultante tiene el formato projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors. Es posible que incurras en costos mínimos de transferencia de Cloud Logging con este método; para controlar estos costos, revisa las exclusiones de registros.
También puedes informar eventos de errores nuevos a Error Reporting si ensamblas entidades de eventos de errores desde tu servicio en ejecución y las envías al método events.report.
Enumerar estadísticas de grupos de errores
Para obtener una lista de estadísticas de grupos de errores, envía una solicitud al groupStats.list método. Puedes pasar uno o más parámetros de consulta para filtrar las estadísticas de grupos que se muestran.
Mostrar eventos de errores
Para obtener una lista de eventos de errores que pertenecen a un grupo de errores específico, envía una solicitud al método events.list. Puedes pasar una condición de filtro a estas solicitudes para recuperar solo los eventos de errores que ocurrieron entre una hora de inicio y finalización específicas, o aquellos que coinciden con contextos de servicio específicos.
Obtener grupos de errores
Para recuperar un recurso de grupo de errores específico, envía una solicitud al método groups.get.
Actualizar grupos de errores
Para actualizar las URLs de los problemas de seguimiento asociadas con un grupo de errores, envía un recurso ErrorGroup actualizado al método groups.update.