Parlons de la journalisation, d’accord? Arnold ici portant une bûche géante ressemble à une introduction appropriée à cet article dans lequel nous allons parler de nœud populaire.cadres de journalisation js.

Si vous écrivez n’importe quel type d’application de longue durée, la journalisation détaillée est primordiale pour repérer les problèmes et le débogage. Sans journaux, vous auriez peu de moyens de dire comment se comporte votre application, y a-t-il des erreurs, à quoi ressemblent les performances, fait-elle quoi que ce soit ou tombe-t-elle simplement sur toutes les autres demandes lorsque vous ne la regardez pas.

Requirements

Permet d’identifier quelques exigences que nous pouvons utiliser pour opposer les frameworks les uns aux autres. Certaines de ces exigences sont assez triviales, d’autres ne le sont pas tellement.

1. Horodatage de chaque ligne de journal. Celui–ci est assez explicite – vous devriez pouvoir dire quand chaque entrée de journal s’est produite.
2. Le format de journalisation doit être facile à digérer par les humains comme par les machines.
3. Permet de configurer plusieurs flux de destination. Par exemple, vous pouvez écrire des journaux de traces dans un fichier, mais lorsqu’une erreur se produit, écrivez dans le même fichier, puis dans le fichier d’erreur et envoyez un e-mail en même temps.

Sur la base de ces exigences (et de leur popularité), il existe deux frameworks de journalisation pour Node.js vaut le détour, en particulier:

• Bunyan par Trent Mick.
• Winston fait partie du framework Flatiron et est sponsorisé par nodejitstu.

console

Avant d’arriver à Bunyan et Winston, regardons notre vieil ami console. Le type de journalisation le plus rudimentaire que vous puissiez faire est d’utiliser les méthodes console.log et console.error. C’est mieux que rien mais à peine la meilleure solution. La console écrit sur STDOUT et STDERR respectivement. Il y a une mise en garde très intéressante à savoir en ce qui concerne les méthodes console dans le nœud.js.

Les fonctions de la console sont synchrones lorsque la destination est un terminal ou un fichier (pour éviter la perte de messages en cas de sortie prématurée) et asynchrones lorsqu’il s’agit d’un tuyau (pour éviter le blocage pendant de longues périodes).

C’est-à-dire, dans l’exemple suivant, stdout ne bloque pas tandis que stderr bloque :

$ node script.js 2> error.log | tee info.log

Il s’agit essentiellement d’une approche de journalisation « roll your own ». C’est entièrement manuel, vous devez créer votre propre format et tout gérer vous-même. Cela prend du temps, est sujet aux erreurs et vous souhaitez probablement vous concentrer sur les fonctionnalités de votre application. Étant donné qu’il existe des bibliothèques de journalisation open source qui sont activement maintenues, cela n’en vaut pas la peine si vous essayez de vous concentrer sur la fourniture de fonctionnalités.

Winston

L’un des nœuds les plus populaires.les frameworks de journalisation js sont Winston. Il est conçu pour être une bibliothèque de journalisation simple et universelle prenant en charge plusieurs transports (un transport dans le monde de Winston est essentiellement un périphérique de stockage, par exemple où vos journaux finissent par être stockés). Chaque instance d’un enregistreur Winston peut avoir plusieurs transports configurés à différents niveaux de journalisation.

Installation

npm install winston

Utilisation

L’utilisation la plus basique de Winston consiste à appeler l’instance par défaut exportée depuis le module winston.

var winston = require('winston');winston.log('info', 'Hello distributed log files!');winston.info('Hello again distributed logs');

Ce qui précède est le même que:

Les deux exemples produiront la sortie suivante:

info: Hello distributed log files!info: Hello again distributed logs

Formatage

Personnellement, je suis un peu perplexe par le manque de détails dans le formateur par défaut. Il n’y a pas d’horodatage, de nom de machine ou d’ID de processus et le format de sortie est légèrement adapté à l’analyse de la machine. Cela dit, vous pouvez obtenir toutes les informations vous-même avec juste un peu de travail supplémentaire.

winston.info('Hello world!', {timestamp: Date.now(), pid: process.pid});

Produit la sortie suivante, qui est plus informative, mais qui n’est toujours pas très adaptée à l’analyse de la machine.

info: Hello world! timestamp=1402286804314, pid=80481

Enfin, la méthode log fournit les mêmes méthodes d’interpolation de chaîne que util.format, par exemple :

winston.log('info', 'test message %d', 123);

winston.add(require('winston-irc'), { host: 'irc.somewhere.net', nick: 'logger', pass: 'hunter2', channels: { '#logs': true, 'sysadmin': }});

winston.loggers.add('category1', {console: { ... }, file: { ... }});winston.loggers.add('category2', {irc: { ... }, file: { ... }});

var category1 = winston.loggers.get('category1');category1.info('logging from your IoC container-based logger');

npm install bunyan

var bunyan = require('bunyan');var log = bunyan.createLogger({name: 'myapp'});log.info('hi');log.warn({lang: 'fr'}, 'au revoir');

node example.js | bunyan

 INFO: myapp/13372 on pwony-2: hi WARN: myapp/13372 on pwony-2: au revoir (lang=fr)

log.info(user, 'registered');log.info({user: user}, 'registered');

{"name":"myapp","hostname":"pwony-2","pid":14837,"level":30,"reqId":"XXXX-XX-XXXX","user":"[email protected]","time":"2014-05-26T18:27:43.530Z","v":0}

Sérialiseurs

Deux problèmes surviennent lorsque Bunyan essaie de stringifier des objets entiers :

1. Références circulaires. Winston est un peu plus intelligent ici et détecte les références circulaires lorsqu’elles se produisent (cependant la sortie de résultat $ref=$ n’est pas très utile).
2. Bruit indésirable. Il me semble que parce que les objets sont de première classe, il est beaucoup plus facile de prendre l’habitude de tout jeter dans le journal.

Pour aider à gérer les deux, Bunyan a un concept de sérialiseur qui sont essentiellement des fonctions de transformation qui vous permettent de réduire les objets couramment passés aux champs qui vous intéressent:

Maintenant, essayer de consigner reqobject inclurait simplement les trois champs qui nous intéressent.

Flux

Les flux dans Bunyan sont la même chose que les transporteurs dans Winston – c’est un moyen d’envoyer vos journaux ailleurs à des fins d’affichage et de stockage. Bunyan utilise une interface de flux inscriptible avec des attributs supplémentaires. Une instance d’enregistreur Bunyan a un ou plusieurs flux et est spécifiée avec l’option streams :

var log = bunyan.createLogger({ name: "foo", streams: });

Plus

Voici quelques choses plus remarquables à explorer dans Bunyan :

• Journal d’exécution fouinant via Prise en charge de Dtrace
• Champs d’enregistrement de journal

Lequel choisir?

Winston et Bunyan sont à la fois des cadres d’exploitation forestière très matures et établis et sont très à égalité en termes de caractéristiques. Winston a beaucoup de soutien communautaire avec divers modules de journalisation. Bunyan facilite l’analyse des journaux dès la sortie de la boîte, mais laisse la consommation à l’utilisateur (généralement le drain syslog fonctionne assez bien ici). Je pense que tout se résume à la préférence et à la facilité d’intégration avec votre pile.

• Qu’en est-il de la prochaine version du nœud ? Découvrez huit nouvelles fonctionnalités passionnantes de Node v0.12 et comment en tirer le meilleur parti, des auteurs eux-mêmes.
• Prêt à développer des API dans Node.js et les connecter à vos données? Vérifiez le nœud.cadre API js LoopBack. Nous avons facilité le démarrage local ou sur votre cloud préféré, avec une simple installation npm.
• Besoin de formation et de certification pour Node ? En savoir plus sur les options privées et ouvertes offertes par StrongLoop.