在一个大型网站或应用中，日志记录是一个非常重要的部分，因为它可以帮助开发人员快速地找到问题所在，记录一些关键性能指标等等。在 Node.js 中，有许多优秀的日志记录工具可以选择使用，其中 bunyan 就是一个很好的选择。bunyan 是一个可以将日志输出到各种源（包括标准输出、文件、syslog、loggly 等等）的强大的日志库。为了方便使用 bunyan，这篇文章将介绍如何使用 npm 包 bunyan-log-helper，快速地开始使用 bunyan。
安装
首先，我们需要安装 bunyan-log-helper：
npm i bunyan-log-helper
使用示例
以下是一个简单的使用示例，展示如何使用 bunyan-log-helper 创建一个 logger 并记录一条日志：
const bunyanLogHelper = require('bunyan-log-helper');
const logger = bunyanLogHelper.createLogger({
name: 'my-app',
});
logger.info('Hello, world!');在这个示例中，我们首先导入 bunyanLogHelper 模块，然后使用 createLogger 方法创建一个 logger 实例，最后使用 logger.info 方法记录一条日志。注意，在使用 createLogger 方法时，可以传递一个名为 "name" 的字段，作为 logger 的名称。
API 接口
bunyan-log-helper 中包含了多个 API 接口，可以用来设置和获取 logger 的不同配置。以下是最常用的 API：
createLogger(options)
创建一个新的 logger 实例。options 参数是一个可选的配置对象，可以包含以下字段：
name: [string] logger 的名称（默认为bunyan-log-helper）streams: [Array] bunyan streams 配置数组
返回值：logger 实例。
getLogger()
获取当前已经创建的 logger 实例，如果当前还没有创建，则创建一个新的 logger 实例。
返回值：logger 实例。
setFields(fields)
设置 logger 的默认字段。每条日志记录都会自动携带这些字段。fields 参数是一个对象，其中包含需要添加的字段及其对应的值。
返回值：无。
setGlobalFields(fields)
设置全局的默认字段。和 setFields 不同的是，这些字段会被添加到所有 logger 实例的每一条日志中。fields 参数是一个对象，其中包含需要添加的字段及其对应的值。
返回值：无。
addStream(streamOptions)
向 logger 实例中添加一个 bunyan stream 配置。streamOptions 参数是一个 bunyan stream 配置对象。
返回值：无。
removeStream(streamName)
从 logger 实例中删除一个已经添加的 stream。streamName 参数是一个字符串，这个字符串是一个为 stream 配置指定的名字。
返回值：无。
setLevel(level)
设置 logger 实例的全局日志级别。level 参数是一个字符串，可以是以下之一：fatal、error、warn、info、debug、trace。
返回值：无。
level()
获取当前 logger 实例的日志级别。
返回值：字符串。
trace(msg, [args])
记录一条 trace 级别的日志。msg 参数是日志信息，args 参数是附加信息，可以是任意 JavaScript 对象。
返回值：无。
debug(msg, [args])
记录一条 debug 级别的日志。msg 参数是日志信息，args 参数是附加信息，可以是任意 JavaScript 对象。
返回值：无。
info(msg, [args])
记录一条 info 级别的日志。msg 参数是日志信息，args 参数是附加信息，可以是任意 JavaScript 对象。
返回值：无。
warn(msg, [args])
记录一条 warn 级别的日志。msg 参数是日志信息，args 参数是附加信息，可以是任意 JavaScript 对象。
返回值：无。
error(msg, [args])
记录一条 error 级别的日志。msg 参数是日志信息，args 参数是附加信息，可以是任意 JavaScript 对象。
返回值：无。
fatal(msg, [args])
记录一条 fatal 级别的日志。msg 参数是日志信息，args 参数是附加信息，可以是任意 JavaScript 对象。
返回值：无。
通过这些 API，我们可以轻松地创建和配置 logger，记录不同级别的日志信息，同时也可以自定义额外的字段信息。
bunyan streams
对于 bunyan 的 streams 参数，bunyan-log-helper 也对其进行了封装。因此，我们一般可以不直接使用原生的 streams 参数，而是使用 bunyan-log-helper 的 addStream API 来添加 stream。在 addStream API 中，我们有以下配置项：
type: [string/function] stream 类型或者一个 bunyan stream 实例level: [string] stream 的日志级别，可以是以下之一：fatal、error、warn、info、debug、tracestream: [Writable] 可写的 stream，如果未提供，则使用process.stdout
例如，以下是一个向 logger 中添加标准输出和文件输出的示例：
-- -------------------- ---- ------- ----- --------------- - ----------------------------- ----- -- - -------------- ----- ------ - --------- -- ------------------------ - --------------------- - ----- ------ - ------------------------------ ----- --------- --- ------------------ ----- ------- ------ ------- ------- ------------------------------------------- - ------ --- --- --- ------------------ ----- --------- ------ -------- ---
在这个示例中，我们首先使用 fs 模块创建了一个 logs 目录，然后使用 createLogger 创建了一个 logger 实例，并将其添加到两个不同的 stream 中：一个是向文件中写入日志，另一个是向控制台输出日志。
结论
bunyan-log-helper 提供了非常方便的 API，帮助我们快速地创建和配置 bunyan logger，并可以向多个 stream 输出日志。它可以帮助我们更好地管理和控制应用程序的日志记录，提高应用程序的稳定性和可维护性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005597f81e8991b448d70e5