介绍
Bunyan-rotating-file-stream 是一个基于 bunyan 的轮转文件日志记录工具，可以用于在 Node.js 应用程序中记录日志，并覆盖基本的轮转和日志大小限制。通过其轮转和大小限制功能，它可以轻松地管理日志文件的大小和数量，避免占用磁盘空间过多，且日志文件呈一个被切分并按时间归档的格式。
安装
本指南假定您已经安装了 Node.js 和 npm，您可以使用以下命令安装 bunyan-rotating-file-stream：
--- ------- --------------------------- ------
示例代码
----- ------ - ------------------
----- ------------------ - ---------------------------------------
----- ------ - ---------------------
----- --------
-------- -
-
----- ------
------- --- --------------------
----- ---------------------
------- ----- -- ----- --------
----------- --- -- ---- -- -- -- ---- ------
--------------- ----- -- ---- --------- - ----- ---- ---- -- ----- --- ----- -- ------
---------- ------ -- ------ --- ----- ------ ---- -- ---------
---------- ------ -- ----- ---- ---- ---- ---- -- -------- --- -----
----- ----- -- -------- --- ------- --- ----- -- ---- -----
--
-
-
---
------------------- ---------在上面的示例代码中，我们创建了一个日志记录器，并将其配置为使用 bunyan-rotating-file-stream。其中，我们将 logs 放在 /var/log/myapp.log 中，通过period定义轮转间隔、totalFiles设定保留的历史轮转日志文件数量、threshold定义日志文件超过多少大小时开始轮转、totalSize设定保留的轮转日志文件总大小。
使用指南
使用 bunyan-rotating-file-stream 实现日志轮转是很简单的: 只需在创建 Bunyan 记录器时，包装一个 RotatingFileStream，并将其添加到streams数组。完整的Bunyan创建方法如下面示例代码。
----- ------------------ - ---------------------------------------
----- ------ - ---------------------
----- --------
-------- -
-
------ --------
------- --------------
--
-
----- --------------
------ -------
----- ------
------- --- --------------------
----- --------------------
------- -----
----------- --
--------------- -----
---------- ------
---------- -------
----- ----
--
-
-
---
------------------ --------在上面的示例中，我们使用bunyan.createLogger()方法创建一个日志记录器，并使用 process.stdout 将log输出到控制台。 我们还注意到，在记录器上，我们添加了一个新的传输流，它会将日志输出到一个轮转的写入流上，这个流会在日志大小超过10m时轮转，并覆盖原日志，一共保留4个文件，每个文件保留100m大小，使用gzip压缩归档日志文件，日志文件名自动包含时刻信息，表明当前日志是第几个轮转文件。
其他参数选项
在上面的示例中，我们使用了以下参数：
| 参数 | 说明 |
|---|---|
path |
日志文件的路径，可以绝对路径，也可以相对路径 |
period |
日志文件轮替周期，可以是毫秒，也可以是durants，比如'1d','2h','30m'等 |
totalFiles |
备份日志的数量。当日志文件超出数量时，旧文件将被删除，能够控制日志文件所占空间的大小。默认情况下，只会保留一个备份。 |
rotateExisting |
为防止程序被提前杀掉而没有机会写完文件，以及程序重启后的空日志文件，可以设置此项为 true，这样启动时会先将日志文件更名为当前时间打标记(-201704102224)的日志文件；如果是 false，则启动时直接为当前时间再新建文件。 |
threshold |
日志文件的大小超出该值时，会轮转日志文件并生成新的日志文件，比如'1k','10m','100g' |
totalSize |
限制日志文件总大小。比如'1k','10m','100g' |
gzip |
备份日志设置是否压缩。默认为 false |
总结
bunyan-rotating-file-stream 是一个很方便的日志文件轮转库，支持多种配置项，使用简单方便，可以后台自动轮转日志文件，并按时间归档，可以确保日志记录的稳定性和持久性，并在大量日志产生时，避免占用文件过多磁盘空间。它可以很容易地在 Node.js 应用程序中使用，通过它的配置选项，还可以更加细致地管理日志。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/107311