Comment implémenter la journalisation dans une application Node.js avec pino-logger

La journalisation efficace est cruciale pour le développement des applications. Il donne un aperçu du comportement des applications et simplifie le débogage. Ce tutoriel montre comment implémenter la journalisation dans une application Node.js à l'aide du Pino Logger, un choix populaire connu pour ses performances et sa flexibilité.

Pino permet une journalisation complète, y compris des informations détaillées sur le flux d'application et la possibilité d'enregistrer les journaux dans des fichiers séparés. Sa vaste communauté GitHub souligne en outre sa fiabilité.

Ce guide couvre:

• Configuration des niveaux de journalisation.
• Personnalisation de la sortie du journal pour améliorer la lisibilité dans le terminal, y compris les options pour l'inclusion de la réponse JSON.
• Enregistrement des journaux à un fichier dédié.

À la fin, vous serez en mesure d'implémenter une journalisation robuste dans vos applications Node.js en utilisant les meilleures pratiques et Pino.

Condition préalable

Avant de continuer, assurez-vous que vous avez:

• Expérience avec express.js pour le développement côté serveur.
• Familiarité avec la construction d'API REST sans authentification.
• Mesure avec des outils de ligne de commande ou des terminaux intégrés dans les éditeurs de code.

L'utilisation d'un outil comme Postman pour les tests de point de terminaison de l'API est recommandée.

Étape 1: Configuration du projet

Cette étape consiste à créer une application Node.js de base Node.js à l'aide de Express.js et Mongoose. Cette approche garantit que la fonctionnalité de journalisation est implémentée dans un contexte d'application réaliste.

Pour la configuration de l'application CRUD, reportez-vous à un tutoriel sur l'exécution des opérations CRUD avec Mongoose et MongoDB Atlas. Une fois terminé, vous aurez une application Node.js avec des routes Create, Lire, Update et Supprimer.

Installez nodemon pour les redémarrages du serveur automatique lors des modifications de code:

 NPM Install -g - Force Nodemon

Le drapeau -g s'installe à l'échelle mondiale et --force gère les conflits potentiels.

Étape 2: Installation de Pino

Installez les dépendances nécessaires: pino, journaliste express-pio et pino-pretty:

 NPM Installer Pino Express-Pino-Logger Pino-Pretty

Étape 3: Création du service d'enregistrement

Créez un service Pino Logger avec différents niveaux de journal (avertissement, erreur, informations, etc.). Ce service sera intégré à votre application à l'aide de Node.js Middleware.

Créer un répertoire services :

 services MKDIR

Créez services à loggerService.js avec le code suivant:

 const pino = require ('pino');
module.Exports = pino ({prettyprint: true});

Cela crée un enregistreur de base avec une sortie assez imprimée. Les étapes ultérieures couvriront la configuration supplémentaire.

Ensuite, dans votre fichier server.js , importez le service logique et express-pino-logger :

 const ExpressPinologger = require («express-pino-logger»);
const Logger = require ('./ Services / Loggerservice');

Configurez express-pino-logger avec votre service d'enregistrement:

 // ...
const logggermiddleware = expresspinologger ({{
  Enregistreur: enregistreur,
  Autologing: vrai,
});

app.use (logggermiddleware);
// ...

autoLogging: true inclut la réponse JSON dans les journaux.

Dans votre gestionnaire d'itinéraire (par exemple, foodRoutes.js ), importez et utilisez le journal de bûcher:

 const Logger = require ('../ Services / Loggerservice');

// ...
app.get ("/ food", async (demande, réponse) => {
  Logger.info («Get Route accessible»);
  // ...
});
// ...

Redémarrez votre serveur ( nodemon server.js ) et testez le point de terminaison de l'API. La sortie du journal apparaîtra dans votre terminal.

Étape 4: Configuration des journaux

Cette étape se concentre sur la personnalisation du service d'enregistrement et l'amélioration de la lisibilité des journaux.

Niveaux de journal personnalisés

Définissez les niveaux de journal personnalisés dans loggerService.js :

 // ...
constants const = {
  http: 10,
  débogage: 20,
  Info: 30,
  avertir: 40,
  Erreur: 50,
  Fatal: 60,
};
// ...

Mettez à jour la configuration pino dans loggerService.js :

 module.exports = pino ({
  Prettyprint: vrai,
  Customlevels: niveaux,
  useNlyCustomAlevels: true,
  Niveau: «Http»,
});

Testez avec des niveaux personnalisés (par exemple, logger.http(...) ). Définissez autoLogging: false dans server.js si la réponse JSON n'est pas nécessaire.

Jolie impression

Améliorer le formatage des journaux dans loggerService.js :

 module.exports = pino ({
  Customlevels: niveaux,
  useNlyCustomAlevels: true,
  Niveau: «Http»,
  Prettyprint: {
    colorize: vrai,
    Levelfirst: vrai,
    TranslateTime: «Yyyy-dd-mm, h: mm: ss tt»,
  },
});

Testez à nouveau pour voir la sortie du journal améliorée.

Étape 5: stockage des journaux dans un fichier

Pour écrire des journaux dans un fichier, modifiez la configuration pino dans loggerService.js :

 module.exports = pino ({
  Customlevels: niveaux,
  useNlyCustomAlevels: true,
  Niveau: «Http»,
  Prettyprint: {
    colorize: vrai,
    Levelfirst: vrai,
    TranslateTime: «Yyyy-dd-mm, h: mm: ss tt»,
  },
}, pino.destination (`$ {__ dirname} / logger.log`));

Tester votre API; Les journaux seront désormais écrits sur logger.log dans le répertoire services .

Conclusion

Ce tutoriel a fourni un guide complet pour implémenter la journalisation PINO dans les applications Node.js. N'oubliez pas les meilleures pratiques: les informations contextuelles, le but clair et la mise en forme lisible sont essentiels à une journalisation efficace. Explorez la documentation officielle PINO pour les options de configuration avancées.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!