Chaque système de journalisation robuste se compose de trois composants clés : un collecteur, un stockage et un visualiseur. Les modules de journalisation Node.js populaires comme Winston et Pino fonctionnent uniquement comme collecteurs de journaux. Errsole, cependant, propose une solution de journalisation complète qui comprend :

1. Stockage des journaux : Enregistrez les journaux dans un fichier ou dans la base de données de votre application.

2. Tableau de bord intégré : Affichez, filtrez et recherchez les journaux à l'aide du tableau de bord intégré.

3. Alertes : Recevez des notifications en temps réel en cas d'erreurs critiques.

Installer Errsole et ses dépendances

Pour utiliser Errsole, vous devez installer le module Errsole ainsi qu'un module de stockage basé sur la base de données choisie. Voici les étapes d'installation pour les différentes options de stockage :

Stockage de fichiers :

npm install errsole errsole-sqlite

MongoDB :

npm install errsole errsole-mongodb

MySQL :

npm install errsole errsole-mysql

PostgreSQL :

npm install errsole errsole-postgres

Création d'un fichier de journalisation personnalisé

Dans un projet Node.js réel, vous aurez plusieurs fichiers. Pour utiliser Errsole Logger dans chaque fichier de votre projet, créez un fichier logger.js et initialisez Errsole dedans :

const errsole = require('errsole');
const ErrsoleSQLite = require('errsole-sqlite');

errsole.initialize({
  storage: new ErrsoleSQLite('/tmp/logs.sqlite')
});

module.exports = errsole;

Maintenant, vous pouvez importer le fichier logger.js dans chaque fichier de votre projet et l'utiliser pour vous connecter :

const logger = require('./logger');

// Example usage
logger.info('This is an informational message.');
logger.error('This is an error message.');

Comprendre les niveaux de journalisation dans Errsole

Les fonctions Errsole Logger prennent les mêmes arguments que console.log. Vous pouvez fournir une ou plusieurs chaînes, objets ou variables séparés par une virgule. De plus, vous pouvez joindre des métadonnées à vos messages de journal à l'aide de la fonction méta. Ces métadonnées peuvent être n'importe quelle information contextuelle, telle que des requêtes HTTP ou des résultats de requêtes de base de données.

logger.meta({ reqBody: req.body, queryResults: results }).error(err);
logger.meta({ email: req.body.email }).log('User logged in');

Errsole Logger fournit des fonctions pour cinq niveaux de journalisation : alerte, erreur, avertissement, informations et débogage.

log / info : Utilisé pour enregistrer des messages ou des informations.

logger.log('Logging a message');
logger.log('Multiple', 'arguments', 'are supported');
logger.log('Logging with a variable:', var1);
logger.log(new Error('An error occurred'));
logger.log('Logging with an error object:', errorObject);

alerte : Enregistre un message et envoie une notification aux canaux configurés, tels que l'e-mail ou Slack.

logger.alert('Alert! Something critical happened');

error : Spécialement conçu pour enregistrer les erreurs.

logger.error(new Error('An error occurred'));

warn : Enregistre les messages d'avertissement.

logger.warn('This is a warning message');

debug : Enregistre les informations de débogage, généralement utilisées pour le dépannage pendant le développement.

logger.debug('Debugging information');

Quand utiliser logger.alert dans votre code

Chaque fois que votre application Node.js plante, Errsole envoie une notification en temps réel à votre équipe de développement. Cette notification inclut le message d'erreur, le nom de l'application, le nom de l'environnement et le nom du serveur.

Pour ajouter des erreurs critiques à cette liste de notifications, utilisez logger.alert dans votre code. Évitez cependant d’en abuser pour éviter d’inonder vos développeurs de notifications. Utilisez-le pour les erreurs critiques telles que les échecs de paiement ou les échecs de requêtes de base de données. Placez l'objet d'erreur dans la fonction d'alerte et ajoutez toutes les informations contextuelles dans la méta-fonction. Cela permet aux développeurs de déboguer facilement les erreurs critiques.

logger.meta({ reqBody: req.body, queryResults: results }).alert(err);

Conclusion

L'intégration d'une solution de journalisation complète dans votre application Node.js garantit une gestion robuste des journaux et un débogage efficace. Errsole fournit un stockage de journaux, un tableau de bord intégré et des notifications en temps réel, ce qui en fait un outil de journalisation complet.

Pour démarrer avec Errsole, visitez https://github.com/errsole/errsole.js.