De la oscuridad a la luz: Cómo escribir buenos logs en tus aplicaciones

Imagina que tienes una aplicación en producción y recibes una llamada en mitad de la noche informándote de que la aplicación se ha detenido. Te apresuras a iniciar una sesión remota y comienzas a investigar el problema. Descubres que el registro de la aplicación está lleno de mensajes irrelevantes y que no te aporta ninguna información útil para resolver el problema. Finalmente, después de mucho esfuerzo y tiempo, logras identificar y solucionar el problema. Mientras has podido perder varios clientes y dejar sin servicio a los que la estuvieran utilizando.

Este tipo de situación puede ser muy frustrante y costosa, pero puede evitarse escribiendo buenos logs. Esto no es una tarea fácil así que aquí hay algunos consejos que pueden ayudarte a lograrlo o al menos a intentar mitigar este tipo de situaciones:

1. Escribe logs claros y concisos que describan los eventos importantes de la aplicación. Logs que realmente te den información de qué estaba haciendo la aplicación en el momento de lanzarlo.
2. Intenta escribir en el log el contexto de la ejecución como el estado las variables importantes, resultados de funciones intermedias...
3. Utiliza niveles de log para clasificar la importancia de los mensajes y así facilitar su filtrado posteriormente.
4. Incluye información relevante en los mensajes de log, como la fecha y hora, la dirección IP, el usuario y los detalles del error.
5. Haz un uso adecuado de los formatos de log, como JSON o XML, para facilitar su análisis y procesamiento posterior.
6. Asegúrate de que los logs se guarden en un lugar seguro y accesible, como una base de datos, un archivo de texto o una plataforma dedicada a este tipo de servicios. Esto último además te aportará métodos de búsqueda, filtrado y rotación automática de logs.

Si escribir logs que aporten información es muy importante, también vamos a ver algunos consejos sobre qué no deberías que poner en los logs de tu aplicación:

1. Datos personales o sensibles: Esto es evidente, pero muchas veces con la velocidad de desarrollo y los plazos lo podemos pasar por alto. Es importante que no incluyas información personal o confidencial en los logs, como contraseñas, números de tarjeta de crédito, etc.
2. Mensajes irrelevantes: Incluir mensajes que no aportan valor sólo conseguirá poner más difícil la búsqueda de un posible error.
3. Datos excesivos: Por ejemplo en la subida de un fichero si estamos utilizando base64, no tiene ningún sentido escribir en el log el contenido del propio archivo. Este tipo de logs provocará múltiples filas imposibles de leer y que además ocuparán muchísimo espacio en nuestros registros.

En conclusión, escribir buenos logs es fundamental para mejorar la calidad y la eficiencia de nuestras aplicaciones. Con un enfoque cuidadoso y una atención constante a los detalles, podemos lograr una mejor comprensión de lo que está sucediendo en nuestro código y mejorar la resolución de problemas a largo plazo. No olvides evitar escribir información sensible o innecesaria en tus logs y siempre mantener una mentalidad de "menos es más" para lograr una mejor legibilidad y eficiencia.

¡No dudes en compartir tus experiencias con logs y cualquier pregunta que tengas en los comentarios! Será un placer hablar contigo sobre cómo mejorar tus logs y cómo podemos trabajar juntos para crear aplicaciones más eficientes y fiables.