Skip to content

Système de log et d'erreurs

Tanguy Gimenez edited this page Aug 9, 2021 · 1 revision

Certaines informations importantes peuvent nécessiter d'être conservées, comme par exemple, des modifications apportés à des fichiers de configurations.

Pour cela, il existe un service log.js qui permet de formatter et conserver les logs et les erreurs facilement.

Quand logger ?

Par convention, toutes les erreurs doivent être enregistré dans les logs d'erreurs via la fonction logError.

De plus, toute modification d'un fichier du bot doit être enregistrée dans les logs standards via la fonction logStdout.

Utilisation du service

Pour utiliser ce service correctement et facilement, je recommande la méthode suivante :

A la fin de votre module ou de votre commande, rajoutez les deux fonctions suivantes

// changez le chemin vers le service si celui ci ne convient pas
// changez également les paramètres s'il n'existe pas (par exemple, le paramètre name)
function log(text, msg) {
	require('../services/log').logStdout(text, name, msg ?? null);
}

function err(text, msg, err) {
	require('../services/log').logError(text, name, msg ?? null, err ? err.stack : null)
}

Ainsi, pour logger une erreur par exemple, il suffira d'appeler la fonction err comme ceci :

msg.channel.send("coucou").catch(error => err("Impossible d'envoyer un message", msg, error))