Écrire des logs qui aident vraiment à comprendre un bug

Le log comme outil de réflexion

Un log n’est pas seulement une sortie texte. C’est un moyen de structurer sa réflexion face à un bug.

Avant d’écrire un log, il est souvent utile de formuler mentalement ce que l’on cherche à vérifier.

Donner du contexte

Un log isolé est rarement suffisant. Le contexte autour de la valeur est souvent ce qui permet de comprendre.

  • où se situe le code
  • dans quelle condition il s’exécute
  • ce qui s’est passé juste avant

Éviter les logs jetables

Les logs ajoutés dans l’urgence ont tendance à rester. Avec le temps, ils perdent leur sens et encombrent la console.

Comme évoqué dans l’article sur console.log, supprimer des logs fait partie du travail.

Logs et méthode

Des logs bien pensés permettent souvent d’éviter des outils plus lourds.

Ils s’inscrivent naturellement dans une approche de debug progressive, comme celle décrite dans l’article précédent 🙂