Reproduce un error a partir de un archivo de log: guía de detective
Cómo encontrar el momento del fallo en un log, recortarlo a lo que importa, convertirlo en pasos repetibles y compartirlo de forma segura.
Un usuario escribe: «Se rompió. No sé cómo.» Pruebas lo obvio. No pasa nada. El error es real, el usuario está molesto y el único testigo es un archivo de log con miles de líneas.
La buena noticia: un log es un testigo que no puede mentir, solo balbucear. Con un poco de método puedes encontrar el momento en que algo salió mal, leer las pistas que lo rodean y convertirlas en pasos que otra persona pueda seguir. Aquí tienes el método.
Paso uno: fija la hora del crimen
Empieza por una hora. Pregunta a quien lo reportó cuándo ocurrió, o usa la marca de tiempo del ticket, y busca en el log dentro de ese intervalo. Busca la primera línea con nivel de advertencia o de error, no solo la más llamativa. El primer error suele ser la causa. Los errores que vienen después a menudo son el programa reaccionando al daño.
Si tienes un id de solicitud, un id de sesión o un id de usuario, búscalo. Seguir un mismo id a lo largo de un log convierte un muro de texto en una sola historia, con principio, nudo y desenlace.
Paso dos: lee la pila de llamadas desde arriba
La línea de la excepción te dice el tipo y el mensaje. Los marcos que hay debajo te dicen dónde estaba el programa. Baja hasta llegar a los primeros marcos que pertenecen a tu propio código, porque son los que indican el archivo y la línea que hay que revisar.
`` 12:04:13 ERROR TypeError: plan.period is undefined at applyPromo (pricing.ts:88) at updateTotal (cart.ts:41) at onPromoSubmit (checkout.ts:130) ``
En este ejemplo el fallo está en applyPromo, llamada desde el total del carrito, que a su vez se invoca al enviar un código promocional. Ya tienes un verbo para tu primer paso: aplicar un código promocional a un carrito.
Paso tres: mira lo que pasó justo antes
Las líneas anteriores al error muestran el estado en que estaba el programa. Quizá un ajuste cambió un momento antes. Quizá se cargó un valor desde un lugar que no lo tenía. En el ejemplo, el log podría mostrar unas líneas más arriba que el periodo de facturación pasó de mensual a anual. Esa es una pista sobre la entrada que llevó al fallo.
Anota los valores que veas: el nombre del plan, el código introducido, el ajuste que cambió, el orden de las acciones. El orden importa. Un error que necesita A y luego B no aparecerá si haces B y luego A.
Paso cuatro: convierte las pistas en pasos
Ahora tienes lo suficiente para escribir algo que una persona pueda seguir.
- Escribe las acciones del usuario en el orden en que las muestra el log.
- Sustituye todo lo que sea propio de una persona concreta por un equivalente que un tester pueda reutilizar, como una cuenta de prueba.
- Conserva los valores que parezcan relevantes, como el código promocional y el plan. Descarta el resto.
- Ejecuta los pasos. Si aparece el mismo error, tienes una reproducción. Si no, cambia una sola cosa cada vez: la compilación, el tipo de cuenta, los datos, el orden.
Cambiar una sola cosa cada vez es la parte que parece lenta y en realidad es rápida. Si cambias tres cosas, un éxito no te dice nada.
Paso cinco: cuenta con qué frecuencia ocurre
Ejecuta los pasos unas cuantas veces y anota el resultado. Un fallo que aparece todas las veces apunta a un error de lógica. Un fallo que aparece de vez en cuando suele apuntar a la sincronización, a la carga o a datos que cambian entre ejecuciones. Indica la frecuencia en el reporte, porque cambia el punto por el que empieza un desarrollador.
Paso seis: recorta el log antes de compartirlo
Un log que adjuntas a un ticket lo lee más gente de la que esperas, y puede contener cosas que no deberían estar en un tracker.
- Conserva la parte útil. La línea de error, la pila de llamadas y unas cuantas líneas anteriores. Indica de qué parte del archivo procede el fragmento.
- Enmascara los datos personales. Direcciones de correo electrónico, nombres y cualquier cosa que identifique a una persona.
- Enmascara los secretos. Tokens de acceso, claves de API y contraseñas. Un token en un ticket lo puede leer cualquiera que pueda abrir el ticket.
- Revísalo a ojo. El enmascarado automático ayuda, pero funciona en la medida de lo posible, así que mira el resultado antes de adjuntarlo.
Qué va en el ticket
Indica los pasos que encontraste, lo que esperabas, lo que ocurrió, la compilación y la frecuencia, y adjunta el fragmento recortado. Un desarrollador que lea eso puede repetir el problema en minutos en lugar de horas. Si quieres un formato que seguir, la plantilla de reporte de error recorre cada parte.
Dónde encaja BugIt
Leer logs es una habilidad que vale la pena tener, y también es una tarea pesada cuando el log es largo. Cuando pegas un log en BugIt, este conserva la línea de error y la pila de llamadas que importan y deja fuera el ruido que las rodea; luego usa lo que encontró para escribir los pasos y el entorno en el borrador. BugIt oculta los datos personales comunes en la medida de lo posible, así que lee el borrador antes de que se registre. Tú revisas cada borrador, y no se escribe nada en tu tracker hasta que escribas FILE IT.
Más información en bugit.dev y taskivator.com/bugit.
En resumen
Encuentra el primer error, lee la pila de llamadas desde arriba, mira lo que pasó justo antes y escribe los pasos en el orden en que los muestra el log. Cambia una sola cosa cada vez cuando el error no se repita, anota con qué frecuencia ocurre, y recorta y enmascara el log antes de compartirlo. Un log es un testigo paciente. Hazle las preguntas adecuadas y te dirá cómo repetir el problema.