使用Node.js 'debug”模組避免日誌污染應用程式日誌

本篇文章為大家介紹一下使用Node.js “debug”模組避免日誌污染應用程式日誌的方法。有一定的參考價值，有需要的朋友可以參考一下，希望對大家有幫助。

影片教學推薦：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 環境變量，以啟用偵錯功能。

啟動應用程式時（即導入該模組的程式），你將會像這樣去啟動它：

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

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

作者：Corey Cleary

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

以上是使用Node.js 'debug”模組避免日誌污染應用程式日誌的詳細內容。更多資訊請關注PHP中文網其他相關文章！