ADR 009 : Amélioration de la Lisibilité des Logs et Gestion des Codes d'Erreur

Contexte

Pour faciliter la maintenance et le diagnostic des problèmes dans notre système, il est crucial que les logs soient clairs et utiles. Actuellement, nos logs ne fournissent pas suffisamment d'informations pour identifier rapidement la source des problèmes ni pour comprendre la nature des erreurs.

Décision

Afin d'améliorer la lisibilité et la gestion des logs dans notre système, nous mettrons en place les mesures suivantes :

1. Précision du Nom du Module :

   • Chaque entrée de log doit inclure le nom du module auquel elle se rapporte. Le nom du module sera spécifié entre crochets [] dans chaque message de log. Par exemple : [Portal], [Admin], etc.
   • Cette information permettra de localiser plus facilement la source des logs et de comprendre rapidement le contexte du message enregistré.

2. Introduction des Codes d'Erreur :

   • Nous introduirons des codes d'erreur standardisés pour les exceptions afin de faciliter le traitement et la résolution des problèmes.
   • Chaque exception ou erreur dans les logs sera associée à un code d'erreur spécifique. Ces codes seront définis dans une liste de codes d'erreur documentée.

3. Référencement et Plan d'Action :

   • Tous les codes d'erreur seront référencés dans un document centralisé qui inclura une description de chaque code ainsi qu'un plan d'action pour sa résolution.
   • Ce document servira de guide pour les développeurs et les équipes de support afin d'assurer une réponse rapide et appropriée aux incidents.

4. Correction Progressive des Exceptions :

   • Les exceptions existantes dans Open ENT NG seront progressivement corrigées pour se conformer à cette nouvelle norme de logging.
   • Une priorité sera accordée aux exceptions les plus critiques ou les plus fréquemment rencontrées.

Avantages

• Clarté Accrue : Les logs seront plus lisibles et plus informatifs grâce à la présence du nom du module et des codes d'erreur.
• Diagnostic Efficace : Les codes d'erreur et le plan d'action permettront une résolution plus rapide et plus ciblée des problèmes.
• Gestion Améliorée : La documentation centralisée des codes d'erreur et des plans d'action facilitera le suivi des incidents et des résolutions.