Buenas prácticas en logs

En la entrada anterior relacionada a los registros y lo importantes que son (Porque son los logs importantes) indicaba que son nuestros ojos y lo que nos ayudará a ver a posterior que ha pasado y tener la trazabilidad de la acción que acaba desembocando en un error.

Lo bueno y breve, dos veces bueno

Pero así como cuanto más azúcar más dulce. Hay que ir con cuidado de que no nos salgan caries y acabar con indigestión. Hay que tener en cuenta que en un breve lapso de tiempo una máquina puede realizar muchas operaciones. Si agregamos un registro por cada acción, al final vamos a tener documentos muy pesado y con mucha información para leer. Donde el final encontrar algo puede ser como buscar una aguja en un pajar. Por más herramientas que usemos para ayudarnos ser invertiría demasiado tiempo.

Hay que registrar los pasos importantes y ayudarnos de los de las etiquetas que marcan los diferentes niveles:

  • FATAL
  • ERROR
  • WARN
  • INFO
  • DEBUG
  • TRACE

Información relevante

Además de registrar las acciones importantes hay que mostrar la información suficiente para identificar los diferentes actores que intervienen de forma legible por la persona que tenga que revisar los registros.

Como pueden ser:

  1. El código inequívoco de la referencia en base de datos o el código.
  2. Los parámetros de entrada de la función.
  3. Resultado de la acción