Évitez la pollution des journaux d'application à l'aide du module « debug » de Node.js

Cet article vous présentera comment utiliser le module « debug » de Node.js pour éviter la pollution des logs des applications. Il a une certaine valeur de référence. Les amis dans le besoin peuvent s'y référer. J'espère qu'il sera utile à tout le monde.

Recommandation de didacticiel vidéo : Tutoriel nodejs

Avez-vous déjà vécu une telle expérience, veuillez l'enregistrer ? Ajoutez à un module Node personnalisé et pensez que vous bénéficierez d'informations supplémentaires, pour constater que lorsque vous ajoutez le module en tant que dépendance et exécutez npm install et npm start, vos journaux de programme ressemblent à ceci ?

Comment trouver les informations dont vous avez réellement besoin ? Comme qui s'est connecté et quand, plutôt que les informations provenant des dépendances de l'application :

De même, lorsque vous soupçonnez que vos performances When diminuent en raison de modifications apportées par l'équipe aux dépendances du module Node, les seuls journaux qui doivent être traités sont :

En regardant la situation dans son ensemble, voici à quoi ressemble la pollution des journaux comme :

Ce que nous voulons

La solution de journalisation idéale serait celle où les journaux de module n'entrent pas dans la journalisation d'un programme ou d'un service, mais dans la capacité pour l'ouvrir pour le dépannage en cas de besoin.

Pour ce faire, je vais vous montrer comment utiliser le module debug pour activer ou désactiver la journalisation dans un module Node.

Si vous n'en avez pas besoin et que le service utilisant ce module fonctionne correctement, réglez-le sur OFF.

ON est utilisé lorsque vous rencontrez un problème et avez besoin d'autant d'informations de journal que possible.

debug Présentation du module

En termes de fonctionnalités, veuillez ne pas penser aux modules de débogage comme vous y penseriez normalement dans un débogueur (comme la façon dont vous définissez les points d'arrêt dans l'EDI) , Cela devrait ressembler davantage à un module console modifié. Il s'agit d'un outil qui vous permet d'activer et de désactiver les journaux selon vos besoins. Si vous allez sur sa page GitHub (https://github.com/visionmedi...), vous verrez également ses diverses autres fonctionnalités, telles que les espaces de noms, etc. Ignorez cela pour l'instant, sachez simplement que c'est un outil qui peut optimiser votre environnement de production.

Implémentation de debug

dans votre propre module Node Regardons un exemple d'utilisation de debug dans le code. Supposons que ce qui suit soit un module :

const debug = require('debug');
const log = debug('http:server');
const http = require('http');
const name = 'Demo App for debug module';
 
log('booting %o', name);
 
http.createServer((req, res) => {
  log(req.method + ' ' + req.url);
  res.end('debug example\n');
}).listen(3200, () => {
  log('listening');
});

La mise en œuvre de debug est facile. Tout ce que nous avons à faire est d'importer ou d'exiger le module puis de créer un enregistreur - const log = debug('http:server'); . Il vous suffit de transmettre la balise ou l'espace de noms 'http:server' d'un enregistreur spécifique à la variable d'environnement DEBUG pour activer le débogage.

Lorsque vous démarrez l'application (c'est-à-dire le programme qui a importé le module), vous la démarrerez comme ceci :

DEBUG=http:server node app-entrypoint.js

Si nous voulons Que dois-je faire si j'utilise un enregistreur distinct pour changer certains journaux ? Par exemple, que se passe-t-il si nous voulons uniquement passer à l’erreur ? C'est aussi simple que de créer un autre enregistreur, comme ceci :

const debug = require('debug');
const log = debug('http:server');
const errorLogger = debug('http:error'); // create new logger here, passing it a new namespace
const http = require('http');
const name = 'Demo App for debug module';
 
log('booting %o', name);
 
http.createServer((req, res) => {
  log(req.method + ' ' + req.url);
  res.end('hello\n');
 
  // fake an error to demonstrate using debug for http:error namespace
  setTimeout(() => {
    errorLogger('fake error'); // then call the logger 
  }, 1000);
}).listen(3200, () => {
  log('listening');
});

Ce qui suit n'ouvrira que les erreurs :

DEBUG=http:error node app-entrypoint.js

而且，当你要记录所有命名空间的日志时（在这种情况下，是 http:server 和 http:error），只需传递通配符 * 即可。

DEBUG=http:* node app-entrypoint.js

让我们看看这些日志现在是什么样的：

然后，当我们加载页面时：

注意，debug 会写入 stderr 而不是 stdout，所以如果你有一个根据不同的来源提取日志的日志路由，这些调试日志将最终会存储在 stderr 流中。

最后，你还可以选择：

• 你可以记录所有用 debug 编写的模块的日志。
• 或者，你仍然可以用 console.log()/console.error() 记录某些内容，而另一些记录 debug

如果你有必须要记录的事项，并且与使用该模块的应用程序有关，请用 console 将其记录下来。但是如果你不这样做，就会用 debug 记录所有的内容。

为第三方模块打开 debug

到目前为止，如果你（或你的团队）编写了该模块，那么我们所介绍的内容就很棒。

但是如果你用的是第三方模块，那需要打开调试时该怎么办？

也许你已经对程序的各个部分进行了故障排除，不够现在假设你正在使用的开源模块可能会让你遇到问题。

好消息是，debug 是一个使用非常广泛的模块，npm 中的许多模块可能都在用它。第三方模块的创建者知道（至少，应该知道）该模块的用户真的不希望默认情况下进行记录，因为所有其他的日志都可能会变得杂乱无章。

由于 Express 内部使用了 debug 模块，所以如果你用了 Express 并需要对其进行故障排除，则可以通过运行以下命令打开日志：

DEBUG=express:* node your-app-entrypoint.js

查看开源 node 模块是否使用了 debug 以及是如何使用的

如果在文档中没有看到关于是否使用了 debug 的内容该怎么办？ 即便如此，也有可能使用了该模块，但是你必须进行一些挖掘。

我们已经知道 Express 文档中描述了该如何使用它，但是我们假设它并没有记录在案：

首先，你可以在项目的 GitHub（或其他开放源代码网站）上搜索 package.json，然后查找其中列出的作为依赖项的模块：

确认后，你还需要确认 1）实际正在使用中，以及 2）切换需要使用哪些标志。 GitHub 现在具有一项不错的功能，你可以在其中使用搜索栏搜索项目本身。如果我们在 Express 项目中搜索“debug”，则会发现以下内容：

我们可以看到切换标记为 “express”，因此 express:* 将为我们提供所有的日志，express:view 将为我们提供视图的日志，等等。

总结

希望你看到在 node 模块中实现 debug 并为第三方模块打开它是多么容易，以及它可以怎样帮你清理日志，同时又为你提供了一种方便的方法来将其重新打开进行故障排除。

英文原文地址：https://www.coreycleary.me/using-the-debug-module-to-avoid-polluting-your-application-logs-with-logs-from-node-modules/

作者：Corey Cleary

更多编程相关知识，可访问：编程入门！！

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!