Node.js日志处理利器：Bunyan CLI工具详解

Node.js日志处理利器：Bunyan CLI工具详解

node-bunyan a simple and fast JSON logging module for node.js services 项目地址: https://gitcode.com/gh_mirrors/no/node-bunyan

什么是Bunyan

Bunyan是一个专为Node.js服务设计的简单快速的JSON日志库，它定义了一种每行一个JSON对象的日志格式，并提供了一个强大的命令行工具来处理这些日志。本文将重点介绍Bunyan的CLI工具功能。

核心功能

1. 日志美化输出

Bunyan日志文件本质上是JSON对象流，可能夹杂着非JSON日志行。CLI工具的主要用途是将这些日志美化输出：

$ bunyan foo.log
[2012-02-08T22:56:52.856Z]  INFO: myservice/123 on example.com: My message
    extra: multi
    line

默认使用"long"输出格式，也可以通过-o FORMAT选项指定其他格式：

$ bunyan foo.log -o short
22:56:52.856Z  INFO myservice: My message
    extra: multi
    line

2. 日志过滤功能

Bunyan CLI提供了强大的日志过滤能力：

按日志级别过滤：

$ bunyan foo.log -l error  # 只显示error级别及以上的日志

使用JavaScript条件过滤：

$ bunyan foo.log -c 'this.pid == 123'  # 只显示pid为123的日志

常用选项详解

基础选项

• -h/--help：显示帮助信息
• --version：显示版本信息
• -q/--quiet：不警告非JSON输入

过滤选项

• -l/--level LEVEL：按日志级别过滤
• -c/--condition COND：使用JavaScript条件过滤
• --strict：只显示合法的Bunyan JSON日志行

输出控制

• --color/--no-color：控制是否彩色输出
• -o FORMAT/--output FORMAT：指定输出格式
• -j：等同于-o json
• -L/--time local：使用本地时间而非UTC

日志级别对照表

Bunyan使用数字表示日志级别，CLI工具中可以使用级别名称作为快捷方式：

| 级别名称 | 级别数值 | 条件脚本中的符号 | |---------|---------|----------------| | trace | 10 | TRACE | | debug | 20 | DEBUG | | info | 30 | INFO | | warn | 40 | WARN | | error | 50 | ERROR | | fatal | 60 | FATAL |

输出格式说明

Bunyan支持多种输出格式：

• long：默认格式，长格式，彩色输出，对req/res/err字段有特殊渲染
• short：简洁格式，省略冗余字段
• json：JSON格式，2空格缩进
• json-N：JSON格式，N空格缩进（如json-4）
• bunyan：等同于json-0，Bunyan原生格式
• inspect：Node.js的util.inspect输出

DTrace支持

在支持DTrace的系统上（如MacOS、FreeBSD等），Bunyan会创建一个DTrace provider(bunyan)，提供以下探针：

log-trace
log-debug
log-info
log-warn
log-error
log-fatal

每个探针都有一个参数：将要写入日志的字符串。注意当探针启用时，无论日志消息级别如何，只要对应函数被调用，探针就会触发。

环境变量

• BUNYAN_NO_COLOR：设置为非空值可强制禁用彩色输出，效果等同于--no-color

使用建议

1. 生产环境：建议使用json或bunyan格式输出，便于后续处理和分析
2. 开发环境：使用long或short格式，便于阅读
3. 调试：结合-l debug和-c条件过滤可以快速定位问题
4. 时间显示：使用-L选项可以转换为本地时间，便于理解

Bunyan CLI工具是Node.js开发中处理日志的强大助手，通过合理使用其过滤和格式化功能，可以大大提高日志分析的效率。

node-bunyan a simple and fast JSON logging module for node.js services 项目地址: https://gitcode.com/gh_mirrors/no/node-bunyan