Journalisation et surveillance dans Node.js : meilleures pratiques

Une journalisation et une surveillance efficaces sont essentielles pour maintenir la santé des applications, identifier rapidement les problèmes et améliorer les performances. Dans cet article, nous aborderons la journalisation et la surveillance des applications Node.js, en abordant des sujets clés tels que le choix des niveaux de journalisation, la configuration de journaux structurés, l'intégration aux outils de surveillance et les meilleures pratiques d'utilisation de Winston et Elasticsearch.

Introduction à la journalisation et à la surveillance

La journalisation permet de capturer les événements en temps réel, les erreurs et d'autres informations importantes de l'application, tandis que la surveillance implique le suivi des mesures de performances de l'application au fil du temps. Ensemble, ils fournissent des informations essentielles sur l'état des applications, permettant ainsi une résolution proactive des problèmes.

Configuration de la journalisation de base dans Node.js

L'objet console intégré fournit des fonctions de journalisation simples, mais une bibliothèque de journalisation dédiée est plus robuste pour les applications de production.

Journalisation de base de la console

console.log("Server started on port 3000");
console.warn("This is a warning");
console.error("Error occurred while processing request");

Cependant, la journalisation de la console présente des limites dans les applications complexes, telles que le manque de contrôle du niveau de journalisation et l'absence de persistance des journaux.

Présentation de Winston

Winston est une bibliothèque de journalisation populaire pour Node.js qui propose plusieurs niveaux de journalisation, transports (destinations des journaux) et journalisation structurée.

1. Installez Winston :

   npm install winston

1. Configuration de Winston

   const winston = require("winston");

   // Configure logger
   const logger = winston.createLogger({
       level: "info",
       format: winston.format.combine(
           winston.format.timestamp(),
           winston.format.json()
       ),
       transports: [
           new winston.transports.Console(),
           new winston.transports.File({ filename: "app.log" })
       ]
   });

   // Logging examples
   logger.info("Server started on port 3000");
   logger.error("Database connection failed");

Choisir les niveaux de journalisation appropriés

Les niveaux de journal catégorisent les messages de journal en fonction de leur importance. Les niveaux de journalisation courants sont :

• Erreur : problèmes critiques nécessitant une attention immédiate, tels que des pannes de base de données ou de serveur.
• Avertir : problèmes non critiques, tels que les API obsolètes.
• Informations : informations générales sur l'application, comme le démarrage ou l'arrêt du serveur.
• Debug : informations détaillées utiles lors du développement, telles que les valeurs des variables.

Configuration des niveaux de journalisation dans Winston

logger.level = "debug"; // Sets the minimum log level to debug, capturing all messages.

En production, il est préférable de maintenir les niveaux de journalisation à info ou d'avertir pour éviter les données de journalisation inutiles.

Journalisation structurée pour plus de cohérence

La journalisation structurée facilite le filtrage et l'analyse des journaux en conservant un format cohérent.

Ajout de métadonnées aux journaux

Les métadonnées telles que user_id ou request_id peuvent aider à suivre des actions spécifiques dans les journaux :

logger.info("User login successful", { user_id: "12345" });
logger.error("Failed to fetch user data", { user_id: "12345", error: "Database unavailable" });

Intégration à Elasticsearch pour la journalisation centralisée

Elasticsearch est largement utilisé pour la gestion centralisée des journaux et les capacités de recherche.

1. Installer Elasticsearch et Elasticsearch Transport

console.log("Server started on port 3000");
console.warn("This is a warning");
console.error("Error occurred while processing request");

1. Configurer le transport Elasticsearch

   npm install winston

Cette configuration enverra les journaux à Elasticsearch, vous permettant d'utiliser Kibana pour la recherche et l'analyse des journaux en temps réel.

Surveillance des métriques d'application avec Prometheus et Grafana

La surveillance suit les mesures de performances des applications telles que l'utilisation du processeur, la mémoire et les temps de réponse, contribuant ainsi à garantir une application stable.

Configurer Prometheus avec Node.js

1. Installer la bibliothèque client Prometheus

   const winston = require("winston");

   // Configure logger
   const logger = winston.createLogger({
       level: "info",
       format: winston.format.combine(
           winston.format.timestamp(),
           winston.format.json()
       ),
       transports: [
           new winston.transports.Console(),
           new winston.transports.File({ filename: "app.log" })
       ]
   });

   // Logging examples
   logger.info("Server started on port 3000");
   logger.error("Database connection failed");

1. Créer et exporter des métriques

logger.level = "debug"; // Sets the minimum log level to debug, capturing all messages.

1. Exposer le point de terminaison des métriques

logger.info("User login successful", { user_id: "12345" });
logger.error("Failed to fetch user data", { user_id: "12345", error: "Database unavailable" });

Visualiser avec Grafana

Grafana est un outil puissant pour créer des tableaux de bord à partir des métriques Prometheus. Intégrez Prometheus en tant que source de données dans Grafana, puis visualisez des métriques telles que les temps de réponse et les taux d'erreur.

Cas d'utilisation réel : journalisation et surveillance dans le commerce électronique

Envisagez une plate-forme de commerce électronique où la journalisation et la surveillance sont essentielles au maintien de performances et d'une fiabilité élevées.

1. Enregistrer toutes les transactions : capturez les événements de commande et de paiement avec des journaux structurés, y compris des métadonnées telles que order_id et user_id.
2. Suivi des erreurs : utilisez Winston pour enregistrer les erreurs telles que les échecs de paiement, ainsi que les traces de pile et les métadonnées pour un débogage plus rapide.
3. Surveiller l'état du serveur : configurez Prometheus pour surveiller les temps de réponse et le nombre de requêtes, visualisés dans Grafana pour des informations en temps réel.
4. Définir des alertes : configurez des alertes basées sur des métriques. Par exemple, si la durée de la demande dépasse un seuil, envoyez une alerte à l'administrateur.

Cette configuration fournit une vue complète de l’état de l’application, permettant une détection et une résolution proactives des problèmes.

Conclusion

La mise en œuvre d'une journalisation et d'une surveillance robustes dans Node.js est essentielle pour maintenir la fiabilité et garantir un dépannage rapide. À l'aide d'outils tels que Winston, Elasticsearch, Prometheus et Grafana, vous pouvez capturer des journaux structurés, les centraliser et surveiller efficacement les mesures de performances critiques.

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!