Node.js 中的日志处理及其实现方式
在前端开发中，日志处理起到非常关键的作用。它不仅可以帮助我们及时发现、定位问题，而且还可以为我们提供非常有用的业务指标，例如用户行为、服务性能等等。本文将介绍 Node.js 中的日志处理及其实现方式，希望对前端工程师们的日志处理和性能优化有所帮助。
- 前言
在 Node.js 中，我们可以使用 console.log() 实现简单的日志输出。但是，当我们需要更加丰富的日志输出、日志轮换、日志格式化等功能时，console.log() 就无法满足我们的需求了。这时候，我们就需要使用专门的日志库，如 log4js、winston 等。
- Log4js
log4js 是一个广泛使用的日志库，它支持多种日志输出方式，如文件、网络、控制台等。它提供了丰富的日志级别，如 DEBUG、INFO、WARN、ERROR、FATAL 等，可以帮助我们精细地控制日志输出。除此之外，log4js 还支持日志格式化、日志轮换等功能。
2.1 安装和使用
我们可以通过以下命令安装 log4js：
npm install log4js --save
接下来，我们可以使用以下代码来创建一个日志记录器：
const log4js = require('log4js');
const logger = log4js.getLogger();
logger.level = 'debug';
logger.debug("Some debug messages");
logger.info("Some info messages");在代码中，我们首先使用 require() 函数来导入 log4js 模块，然后使用 getLogger() 创建一个日志记录器。在创建记录器后，我们设置了日志记录器的级别为 debug，并使用 debug() 和 info() 方法记录日志。其中，debug() 和 info() 方法都接受一个参数，即要输出的日志信息。
2.2 日志输出方式
log4js 支持多样化的日志输出方式，我们可以根据具体需求选择不同的输出方式。以下是 log4js 的常见输出方式：
- 控制台输出：通过 console 输出日志信息。
- 文件输出：将日志记录到文件中。
- 多文件输出：将日志分别记录到不同的文件中。
- 网络输出：将日志发送到远程服务器。
- 邮件输出：将日志通过邮件发送。
我们可以使用以下代码指定输出方式：
-- -------------------- ---- -------
----- ------ - ------------------
------------------
---------- -
-------- - ----- --------- --
----- - ----- ------- --------- ----------------- -
--
----------- -
-------- - ---------- ----------- -------- ------ ------- -
-
---
----- ------ - -------------------在代码中，我们首先使用 configure() 函数来配置 log4js，其中 appenders 指定了日志输出方式，categories 指定了日志级别。在这个例子中，我们同时将日志输出到控制台和文件中。
2.3 日志格式化
log4js 还支持自定义日志格式化。在默认情况下，log4js 的日志格式为：
[date] [level] [category] - message
即日期、日志级别、日志分类和日志信息。我们可以通过以下代码来自定义日志格式：
-- -------------------- ---- -------
----- ------ - ------------------
------------------
-----------
-------- -
----- ----------
------- -
----- ----------
-------- -------------- ------------- ---- -- - -----
-
-
--
----------- - -------- - ---------- - --------- -- ------ ------- - -
---
----- ------ - -------------------在代码中，我们使用 configure() 函数来配置 log4js，其中 console 指定了输出方式，并通过 layout 选项指定了自定义日志格式。在上面的代码中，我们将日志格式化为类似于这样的格式：
2022/09/01 16:35:06.846 [INFO] cate1 - Some info messages
2.4 日志轮换
当我们的应用程序在长时间运行后，日志文件可能会变得非常大，这时候我们就需要使用日志轮换来防止日志文件过大。log4js 支持按大小和按时间进行日志轮换。
按大小进行日志轮换：当日志文件的大小超过指定大小时，将日志文件重命名，并创建一个新的日志文件。
-- -------------------- ---- -------
----- ------ - ------------------
------------------
---------- -
------- -
----- -------
--------- ------------------
----------- ----- -- ---
-------- --
--------- ----
-
--
----------- - -------- - ---------- ----------- ------ ------- - -
---
----- ------ - -------------------按时间进行日志轮换：当日志文件超过指定时间时，将日志文件重命名，并创建一个新的日志文件。
-- -------------------- ---- -------
----- ------ - ------------------
------------------
---------- -
------- -
----- -----------
--------- ------------------
-------- --------------
--------- ----
-
--
----------- - -------- - ---------- ----------- ------ ------- - -
---
----- ------ - -------------------在以上代码中，我们分别使用 maxLogSize 和 pattern 选项来进行日志轮换，并在 backups 和 compress 选项中指定了备份数量和是否压缩日志文件。
- Winston
winston 是另外一个常见的 Node.js 日志库，它同样支持多种日志输出方式、日志级别、日志格式化和日志轮换等功能。
3.1 安装和使用
我们可以通过以下命令安装 winston：
npm install winston --save
安装完成后，我们可以使用以下代码创建一个日志记录器：
-- -------------------- ---- -------
----- ------- - -------------------
----- ------ - ----------------------
------ --------
----------- -
--- -----------------------------
--- ------------------------- --------- ------------------- --
-
---
------------------ ----- -----------
----------------- ---- -----------在代码中，我们首先使用 require() 函数来导入 winston 模块，然后使用 createLogger() 方法创建一个日志记录器。在创建记录器后，我们使用 debug() 和 info() 方法记录日志。其中，debug() 和 info() 方法都接受一个参数，即要输出的日志信息。
3.2 日志输出方式
winston 同样支持多样化的日志输出方式。我们可以根据具体需求选择不同的输出方式。以下是 winston 的常见输出方式：
- 控制台输出：通过 console 输出日志信息。
- 文件输出：将日志记录到文件中。
- 多文件输出：将日志分别记录到不同的文件中。
- 网络输出：将日志发送到远程服务器。
- 邮件输出：将日志通过邮件发送。
我们可以使用以下代码指定输出方式：
const winston = require('winston');
const logger = winston.createLogger({
level: 'debug',
transports: [
new winston.transports.Console(),
new winston.transports.File({ filename: 'logs/combined.log' })
]
});在代码中，我们使用 createLogger() 方法创建了一个日志记录器，并在 transports 选项中指定了输出方式。
3.3 日志格式化
winston 支持自定义日志格式化。在默认情况下，winston 的日志格式为：
[date] [level] message
即日期、日志级别和日志信息。我们可以通过以下代码来自定义日志格式：
-- -------------------- ---- -------
----- ------- - -------------------
----- ------ - ----------------------
------ --------
------- -----------------------
---------------------------
------------------------ ------ -------- --------- -- -- -
------ ------------- ------------------------ ------------
--
--
----------- -
--- -----------------------------
--- ------------------------- --------- ------------------- --
-
---在上面的代码中，我们使用 combine() 方法将两个日志格式化器(timestamp() 和 printf()）合并在一起。我们可以使用它们来自定义日志格式。
3.4 日志轮换
winston 同样支持按大小和按时间进行日志轮换。我们可以使用以下代码指定日志轮换规则：
-- -------------------- ---- -------
----- ------- - -------------------
----- ------ - ----------------------
------ --------
------- -----------------------
---------------------------
------------------------ ------ -------- --------- -- -- -
------ ------------- ------------------------ ------------
--
--
----------- -
--- -----------------------------
--- -------------------------
--------- --------------------
-------- -----
--------- --
--------- ----
--
-
---在上面的代码中，我们使用 maxsize 和 maxFiles 两个选项指定了按大小进行日志轮换，使用 tailable 选项指定了新的日志会被追加到旧日志后面。
- 总结
在本文中，我们介绍了 Node.js 中两个常用的日志库 log4js 和 winston，并详细介绍了它们的日志级别、日志格式化、日志轮换等功能。我们可以根据具体需求选择不同的日志库，并使用不同的选项来满足我们的要求。同时，在实际开发中，我们需要根据具体场景，选择适当的日志级别和输出方式，来保证我们对日志的分析和处理工作更加高效、准确。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64530b9d968c7c53b077dbb5