避免Node.js模块日志污染程序日志的方法介绍-木庄网络博客

本文摘自PHP中文网，作者青灯夜游，侵删。

视频教程推荐：nodejs 教程

你是否有过这样的经历，当把 logging 添加到自定义 Node 模块中，并认为自己将会从这些额外信息中受益，却发现当你将模块添加为依赖项并运行 npm install 和 npm start 时，你的程序日志就会像下面吗？

你如何找到自己实际需要的信息？比如都有哪些用户登录以及何时登录，而不是来自应用程序依赖项的信息：

同样，当你怀疑由于你的团队对 Node 模块依赖项所做的更改而导致性能下降时，唯一需要解决的日志如下：

从全局来看，这是日志污染的样子：

我们想要什么

理想的日志记录方案能够使模块日志不进入程序或服务的日志记录，但能够在需要时将其打开以进行故障排除。

为此，我将向你展示如何使用 debug 模块来打开或关闭 Node 模块中的日志。

如果你不需要它们，并且使用该模块的服务运行良好，则将其设置为 OFF。

ON 用于遇到问题并需要尽可能多的日志信息时。

`debug` 模块概述

在功能方面，请不要像通常在调试器中那样来考虑调试模块（就像你在 ID E中设置断点的方式一样），而应更像是被修改后的 console 模块。这是一种可让你根据需要打开和关闭日志的工具。如果到其 GitHub页面（https://github.com/visionmedi...），则还会看到它的其他各种功能，例如命名空间等。暂时不用管这些，现在只需要知道它是一种可以优化你的生产环境的工具即可。

在你自己的 Node 模块中实现`debug`

让我们来看一个在代码中使用 debug 的例子。假设下面是一个模块：

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');
});

实现 debug 很容易。我们要做的就是 import 或 require 模块，然后创建一个logger ―― const log = debug('http:server'); 。你只需将特定 logger 的标记或命名空间 ‘http:server‘ 传递给 DEBUG 环境变量，以启用调试功能即可。

启动应用程序时（即导入该模块的程序），你将会像这样去启动它：

1	`DEBUG=http:server node app-entrypoint.js`

如果我们希望使用单独的 logger 来切换某些日志怎么办？例如，如果我们只想切换到 error 怎么办？就像创建另一个 logger 一样简单，就像这样：

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');
});