怎样避免Node.js模块的日志污染程序日志

做者：Corey Cleary

翻译：疯狂的技术宅

原文：https://www.coreycleary.me/us...

未经容许严禁转载

你是否有过这样的经历，当把 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 环境变量，以启用调试功能便可。

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

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

以下所示将会仅打开错误：

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 并为第三方模块打开它是多么容易，以及它能够怎样帮你清理日志，同时又为你提供了一种方便的方法来将其从新打开进行故障排除。

---

本文首发微信公众号：前端先锋

欢迎扫描二维码关注公众号，天天都给你推送新鲜的前端技术文章

欢迎继续阅读本专栏其它高赞文章：

• 深刻理解Shadow DOM v1
• 一步步教你用 WebVR 实现虚拟现实游戏
• 13个帮你提升开发效率的现代CSS框架
• 快速上手BootstrapVue
• JavaScript引擎是如何工做的？从调用栈到Promise你须要知道的一切
• WebSocket实战：在 Node 和 React 之间进行实时通讯
• 关于 Git 的 20 个面试题
• 深刻解析 Node.js 的 console.log
• Node.js 到底是什么？
• 30分钟用Node.js构建一个API服务器
• Javascript的对象拷贝
• 程序员30岁前月薪达不到30K，该何去何从
• 14个最好的 JavaScript 数据可视化库
• 8 个给前端的顶级 VS Code 扩展插件
• Node.js 多线程彻底指南
• 把HTML转成PDF的4个方案及实现

---

• 更多文章...