Accueil › Node.js › Journaliser juste assez
Journaliser juste assez
Erreurs et journalisationintermediaire
Un journal utile tient en deux règles : une ligne par événement qui compte, et rien de sensible dedans.
La ligne par requête
journal.info({
requeteId: req.id, methode: req.method, route: req.route?.path,
statut: res.statusCode, dureeMs: Date.now() - debut, utilisateurId: req.user?.id,
}, "requête terminée");
C'est le journal qu'on lit en premier dans un incident : il donne le volume, la latence, la répartition des statuts, et le fil pour remonter une requête précise. Une seule ligne, à la fin.
Ce qu'on ne journalise jamais
Mot de passe, jeton, en-tête authorization, témoin de session, numéro de
carte, clé d'API, et corps complet de requête. Le corps est le piège : il
est inoffensif aujourd'hui et contiendra un secret après la prochaine
fonctionnalité.
Liste blanche, pas liste noire
const AUTORISES = ["id", "nom", "pays", "offre.code"];
function masquer(objet, autorises, prefixe = "") {
const sortie = {};
for (const [cle, valeur] of Object.entries(objet)) {
const chemin = prefixe ? `${prefixe}.${cle}` : cle;
if (autorises.includes(chemin)) sortie[cle] = valeur;
else if (valeur && typeof valeur === "object") sortie[cle] = masquer(valeur, autorises, chemin);
else sortie[cle] = "[masqué]";
}
return sortie;
}
Une liste noire est juste le jour où on l'écrit : motDePasse y figure,
motDePasseConfirmation non. Une liste noire oublie toujours un champ.
Masquer, pas supprimer
{"nom":"Ada","motDePasse":"[masqué]","authorization":"[masqué]"}
Savoir qu'un en-tête d'autorisation était présent est souvent l'information décisive. La suppression la détruit : le champ devient indistinguable d'un champ jamais envoyé.
Les termes à connaître
- Masquage par liste blanche
On énumère les champs autorisés et on masque tout le reste. Une liste noire fait l'inverse, et oublie toujours un champ — celui ajouté le mois suivant.
- Marqueur de masquage
Une valeur de remplacement comme
[masqué]. Elle conserve l'information « ce champ existait et portait une valeur », que la suppression détruirait.- Journaliser une fois
Une erreur se journalise à une frontière, celle qui la traite. Journaliser à chaque niveau produit cinq lignes pour un incident, qui se comptent comme cinq incidents.
- Métrique
Un compteur agrégé. Pour une erreur attendue, mille occurrences ne valent pas mille lignes : elles valent un compteur et une alerte sur sa pente.
- Journal d'accès
Une ligne par requête terminée, avec méthode, route, statut, durée et identifiant de corrélation. C'est le journal qu'on lit en premier dans un incident.
- Cardinalité
Le nombre de valeurs distinctes d'un champ. Mettre un identifiant de requête dans une étiquette de métrique crée autant de séries que de requêtes, et sature le système.
- Durée de conservation
Les journaux survivent des mois et sont lus par plus de monde que le code. Tout ce qu'on y écrit doit pouvoir être relu par un tiers dans un an.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.