¿Cómo es un informe de error?
Un buen informe de error debe responder no solo a la pregunta de qué se ha roto, sino también ayudar a determinar dónde y en qué condiciones se ha producido el problema.
Por eso, además del propio mensaje de la excepción, puedes enviar información como el stack trace, datos de la petición, del usuario, del entorno y contexto adicional de la aplicación.
Excepción y stack trace
La parte más importante de un evento es la excepción. El tipo de error y su mensaje describen el problema, mientras que el stack trace muestra la ruta de ejecución que ha llevado a él.
En la práctica, es precisamente el stack trace lo que a menudo permite pasar de un mensaje genérico a un punto concreto del código.
Información de la petición
Si el error se ha producido durante el procesamiento de una petición HTTP, el contexto adicional puede incluir la dirección, el método, el código de estado de la respuesta y otra información seleccionada relacionada con la petición.
Esto facilita determinar si el problema afecta a un endpoint concreto, a un formulario, a una página o a una operación realizada por el usuario.
Usuario y contexto
Según la integración que uses, también puedes enviar información sobre el usuario, junto con tus propias etiquetas y datos de contexto. Esto permite responder a preguntas como: a qué usuario afectó el error, a qué módulo correspondía el problema o en qué entorno se detectó.
Con los datos del usuario, siempre conviene aplicar el principio de minimización. Envía solo la información que realmente sea necesaria para el diagnóstico.
Datos propios de la aplicación
Si el contexto estándar no es suficiente, puedes enriquecer el evento con tus propias etiquetas. Por ejemplo, puedes marcar los errores relacionados con los pagos, con un módulo concreto o con una versión de despliegue.
feature = payments
environment = production
release = 1.4.0No envíes secretos
La monitorización de errores no debe ser un lugar donde enviar contraseñas, tokens, claves de API ni credenciales completas de autenticación. Antes de enviar datos, conviene comprobar que la integración no esté transmitiendo por accidente información sensible.