7 个最佳Node.js日志记录库和聚合器

日志记录是软件测试的重要组成部分。当我们知道错误是什么以及代码中出现问题的确切行时，调试应用程序要容易得多。

在本文中，我们将探讨与 Node.js 中的日志记录相关的各种概念，包括七个流行的日志记录库和聚合器，您可以使用它们来简化调试。

什么是日志记录？

语法错误 - 当一段代码不遵守语言规则时发生 - 可以在运行时识别。运行代码后，IDE 会检测这些错误并将其记录在终端上：

错误消息说明了问题，并标识了代码中导致错误的确切行，为我们提供了解决问题所需的所有信息。

但是，与语法错误不同，IDE 无法识别逻辑和运行时错误，并且可能很难调试。解决此类错误的最简单方法是在程序执行时使用程序中的日志记录技术在终端上打印消息。

可以记录代码中不同位置的语句，以便在遇到错误或 bug 时更轻松地进行调试。例如，如果您正在使用 API，则可以记录 API 的响应数据以检查数据或确保返回正确的数据结构：

您还可以在函数正文中记录消息。这样，如果遇到错误，您可以检查记录的消息，以确定运行和未运行的函数，从而可以轻松地从那里跟踪并调试代码。

什么是日志记录库？

日志记录库是一种插件，可帮助您从应用程序生成和管理日志数据。

使用第三方记录器最好的部分是您无需自己编写代码。您只需使用适当的 npm 或 Yarn 安装命令即可安装记录器。

大多数日志记录库都支持最常见的日志记录级别，例如信息、调试、警告和错误。您可以创建自己的自定义关卡并配置其样式。它们还支持不同的传输模式（文件、HTTP、流和控制台）。

在Node.js打日志

请务必遵循 Node.js 中日志记录的最佳做法，以使调试工作尽可能高效。确保您熟悉各种控制台消息、日志级别和其他日志记录基础知识。

一种 Node.js 日志记录方法是通过路由器和应用程序在中间件内执行日志记录，例如使用Express中间件的示例：

路由器可以配置为记录请求、响应、错误和其他可用于调试应用程序的信息。

您还可以使用 npm 或 Yarn 安装第三方日志记录库和聚合器。在下面的部分中，我们将探讨一些适用于 Node.js 的最佳记录器，包括 Grafana Loki、Pino 等。

1.Pino

如果你想要一个简单的记录器，开箱即用，Pino 是一个优秀的 Node.js 记录器选项。与其他一些日志记录解决方案不同，Pino不需要太多配置或外部依赖项。

使Pino成为最好的Node.js记录器之一的一些因素是，它可以免费使用，不断维护，并具有大量功能，包括漂亮的打印、异步日志记录、传输和日志处理、捆绑支持和低开销。

Pino 使用 JSON 格式化日志语句，这使得它们易于阅读。支持的日志级别包括 debug 、 warn 、error和 info ：

要使用 npm 进行安装，请运行：

$ npm install pino

成功安装 Pino 后，您可以将 Pino 记录器实例导入到项目中。请注意，您需要将语句替换为 console.log、logger.info 语句 — 如果需要，您可以查看 Pino 文档以获取一些示例。

您可以将Pino与许多Web框架一起使用，包括Fastify，Express，Koa，Nest.js，Nestify，Happi和Node核心的HTTP。

为避免兼容性问题，我们建议在安装 Pino 记录器之前在您的计算机上本地运行 Node.js v16 或更高版本。这将保证某些高级和现代功能都按预期运行。

2.Bunyan

Bunyan 是一个简单易用的日志记录库，适用于 Node.js 应用程序。它具有优雅的日志方法 API、可扩展的 Steam 系统、序列化程序、日志子项、日志对象的自定义渲染以及用于漂亮打印和过滤 Bunyan 日志的 bunyan CLI 工具：

要使用 npm 进行安装，请运行：

npm install bunyan

接下来，创建一个 Logger 实例并调用以日志记录级别命名的方法：

// server.js

var bunyan = require('bunyan');
var log = bunyan.createLogger({name: 'serverapp'});
log.info('server is active');
log.warn({type: 'error'}, 'something went wrong');

与 Pino 和大多数其他日志记录库一样，Bunyan 以易于阅读的 JSON 格式记录语句，并支持各种日志级别，包括 debug 、 warn 、 error 和 info 。

Bunyan支持Node.js，Browserify，Webpack和NW.js。

需要注意的是，在撰写本文时，Byan的官方GitHub存储库表明，十多个月来没有对代码进行任何维护。这可能会导致兼容性问题，尤其是对于较新的 Node.js 版本。

如果您使用的是 Node.js v17 或更高版本，最好使用定期维护的日志记录解决方案，如 Pino.js以避免兼容性问题。

3.Cabin.js

Cabin.js 具有比此列表中的其他日志记录库更高级的功能，包括：

• 自动检测和屏蔽敏感字段名称、信用卡号、社会保险号、BasicAuth 标头、API 密钥等

• 降低磁盘存储开销

• 跨平台和跨浏览器兼容性

• 能够将日志发送到 HTTP 端点、Slack、Sentry 和 Papertrail

要开始使用，请使用 npm 安装您需要的所有内容：

npm install express axe cabin signale

然后，创建快速使用应用程序：

const express = require('express');
const Axe = require('axe');
const Cabin = require('cabin');
const app = express();
const { Signale } = require('signale');

// initialize a new instance of Axe (see below TODO's that appeal to you)
const logger = new Axe({
  logger: new Signale()
});

const cabin = new Cabin({ logger });

app.use(cabin.middleware);

app.get('/', (req, res, next) => res.send('OK'));

// start the server
app.listen(3000);

在上面的代码中，我们创建了一个记录器的实例，并将其传递给 Cabin() 以创建新的cabin对象。然后，我们将 cabin.middleware 属性传递给内部 app.use() 以在应用程序中设置中间件。

有关如何使用Cabin.js的详细指南，请阅读其官方文档。

由于 Cabin.js 比本文中提到的其他日志记录解决方案更先进，因此它需要额外的安装和配置才能工作。

使用Cabin.js的好处是，您将获得更高级的功能，这些功能将极大地使您的应用程序受益，尤其是在安全性方面。代码库也会定期维护，这降低了与Node.js出现兼容性问题的风险。

总之，如果您想要一个提供高级安全功能的可靠日志记录解决方案并且如果您不介意复杂性，请选择 Cabin.js。

4.Winston

Winston 是一个简单而通用的日志记录库，具有多个日志记录级别、自定义日志记录、多个传输选项、自定义传输、异常处理、查询日志等等。

要使用 npm 安装 Winston，请运行：

npm i winston

使用Winston的 Winston.createLogger 创建自己的记录器可能是理想的：

const winston = require('winston');

const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  defaultMeta: { service: 'user-service' },
  transports: [
    new winston.transports.File({ filename: 'error.log', level: 'error' }),
    new winston.transports.File({ filename: 'combined.log' }),
  ],
});

if (process.env.NODE_ENV !== 'production') {
  logger.add(new winston.transports.Console({
    format: winston.format.simple(),
  }));
}

这将创建具有 info 日志记录级别和 JSON 格式的记录器。然后，记录器仅在生产中激活。Winston 支持不同的日志记录级别：

const levels = {
  error: 0,
  warn: 1,
  info: 2,
  http: 3,
  verbose: 4,
  debug: 5,
  silly: 6
};

如果您想了解有关配置和使用Winston记录器的更多信息，请查看他们的官方文档。

Winston内置了大量额外的功能，您可能会在大型项目中发现这些功能很方便。它们包括以下内容：

• 信息对象过滤 — 在记录时过滤掉特定的信息对象，然后返回 false 值

• 字符串内插 — 使用 log的 format.splat() 方法将字符串连接在一起

• 异常处理 — 捕获并记录 uncaughtException 应用程序中的事件

如果您正在寻找更高级的东西，温斯顿是一个很好的选择。源代码是持续维护的，因此该库适用于所有最新的 Node.js 版本。他们的文档也非常详细，并且整理得很好。

5.Grafana Loki

Loki 是一个日志聚合系统，用于存储和查询来自所有应用程序和基础架构的日志。使用 Grafana 日志，您可以从任何来源（本地日志文件、AWS EC2、Kafta）发送和摄取任何格式（JSON、XML、CSV）的日志，从而非常轻松地快速设置日志系统。

Grafana 与 Node.js 集成得很好。您可以通过设置 Node.js 服务器和 Deno 项目轻松使用 Grafana 仪表板来操作数据。

要在 Node.js 项目中安装 Grafana Loki，请创建一个免费的 Grafana Cloud 帐户。执行此操作时，您无需安装、维护或扩展您自己的 Grafana Loki 实例。

Loki 是企业 Node .js 应用程序的经济高效的解决方案。一些最有用的 Grafana 日志功能包括：

• 如果需要，能够每天从 MB 平滑扩展到 PB

• 可以处理查询和引入负载的突然峰值

• 使用与查询指标相同的语法创建查询日志

• 编写日志查询，允许您动态筛选和转换日志行

• Cloud Native （Prometheus， Golang， Grafana & K8S）

由于其最小的索引方法，Loki 将同一组日志存储在比其他企业日志记录解决方案更小的存储量中。它记录任何和所有格式，运行成本更低，运行更轻松，并且执行更快的写入和查询。

6.LogLevel

LogLevel 是一个简单而轻量级的 JavaScript 日志记录库。该库取代了通常的控制台日志记录方法，非常适合生产中的应用程序。

它支持典型的日志记录级别（跟踪、调试、信息、警告、错误），如果更具体的日志记录级别不可用 console ，则可以正常回退到这些级别。

在功能方面，LogLevel 非常小。它提供了您将在应用程序中使用的基本日志记录功能，但不允许您重新配置追加程序或添加复杂的日志筛选规则。您最好使用Cabin.js或Winston以获得更高级的功能。

要使用 npm 安装 LogLevel，请运行：

npm install loglevel.

要改为使用 Bower 进行安装，请运行：

bower install loglevel

LogLevel 还提供 WebJars 和 Meteor 的 Atmosphere 包。

要在 Node.js 中进行设置，只需导入库并在对象上调用任何常规控制台日志记录方法，并传入如下消息：

var log = require('loglevel');
log.warn("unreasonably simple");

有关如何使用 LogLevel 的综合指南，请阅读他们的官方文档。

7.Tracer

Tracer是一个强大的Node.js开源库。记录器非常易于定制，支持自定义记录器和输出格式。其功能包括：

• 支持所有日志记录级别（日志、跟踪、调试等）

• 用户定义的日志记录级别

• 自定义格式和过滤器

• 设置不同类型的传输（日志文件、流、MongoDB）

• 提供文件信息的堆栈索引

若要开始使用跟踪器，请从 npm 安装包：

npm i tracer

在调用首选的一个或多个控制台方法之前导入记录器：

var logger = require('tracer').console();

logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s',  'world', 123);
logger.info('hello %s %d',  'world', 123, {foo:'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo:'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo:'bar'}, [1, 2, 3, 4], Object);

该方法在控制台上记录其中每条消息。要了解有关 Tracer 的更多信息，请阅读其官方文档。

请注意，Tracer 的代码库不会定期维护。在撰写本文时，Tracer 的 GitHub 存储库已经一年多没有更新了。这使得Tracer 和较新的 Node.js 版本之间的兼容性问题成为可能。

总结

本文介绍了七个用于在 Node.js 应用程序中记录消息的库。日志记录可帮助您检测和诊断错误、检查来自 API 调用和函数的数据、跟踪程序执行流程以及执行更多操作。

我希望本文能帮助您确定哪些流行的 Node.js 日志记录库最适合您的需求。