在前端开发中，我们经常需要记录和查看日志以便快速排查问题。而 bunyan-readable 就是一个可以帮助我们实现日志记录和查看的 npm 包。本文将介绍 bunyan-readable 的使用教程，包括安装、配置、使用以及常用功能的示例代码演示。
安装
使用 npm 包管理器安装 bunyan-readable：
npm install bunyan-readable
配置
在使用 bunyan-readable 之前，我们需要先进行配置，指定日志的输出路径和格式等参数。示例代码如下：
-- -------------------- ---- -------
----- ------ - ---------------------------
----- ------ - --- --------
----- ---------
-------- --
------ -------
------- --------------
-- -
------ --------
----- ---------------------------
--
---以上代码指定了日志的记录器名称为 my-app，共包含输出两个流。其中第一个流的 日志级别 为 info，输出到控制台(console)，第二个流的 日志级别 为 error，输出到指定的文件路径 /var/log/my-app-error.log。
更多关于 bunyan-readable 的配置参考请查阅官方文档：https://github.com/voxelbrain/bunyan-readable#configuration
使用
配置好之后，我们就可以在代码中使用 bunyan-readable 进行日志记录了。示例代码如下：
// info 类型的日志记录
logger.info("Hello, world!");
// error 类型的日志记录
logger.error(new Error("Something went wrong!"));以上代码分别进行了 info 类型和 error 类型的日志记录。我们可以通过使用 bunyan-readable 提供的 CLI 工具 quick-log 来查看这些日志：
npx quick-log /var/log/my-app-error.log
执行后会打印出最近记录的几条 error 类型的日志，以便查看排查问题。
常用功能
添加自定义字段
在某些情况下，我们可能需要为日志记录添加一些自定义字段，以便更好的进行问题排查。例如：
logger.info({
message: "Hello, world!",
module: "MyModule",
timestamp: new Date().toISOString()
});以上代码在 info 类型日志记录中添加了三项自定义字段：message、module 和 timestamp。
日志级别
bunyan-readable 支持五个级别的日志记录：
tracedebuginfowarnerror
可以在配置时针对每个流设置不同的日志级别。例如：
-- -------------------- ---- -------
----- ------ - --- --------
----- ---------
-------- --
------ ------- -- ---- ---- ---------
------- --------------
-- -
------ -------- -- ----- ----- -------
----- ---------------------------
--
---格式化输出
bunyan-readable 支持多种格式化输出方式，以便更好的阅读查看日志记录。以下是一些常用的格式化输出方式：
beautify
npx quick-log /var/log/my-app-error.log --format beautify
simple
npx quick-log /var/log/my-app-error.log --format simple
更多支持的格式选项可以查阅 官方文档。
总结
bunyan-readable 是一个非常强大的前端日志记录工具，使用它可以帮助我们更好的进行问题排查和故障处理。本文介绍了 bunyan-readable 的使用教程，包括安装、配置、使用以及常用功能的示例代码演示。希望大家在开发中能够加以尝试和使用，并取得更好的成果。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c8eccdc64669dde56fb