Node.js Log4js输出自定义格式和变量

如锋

于 2018-12-13 12:52:28 发布

阅读量4k

点赞数

CC 4.0 BY-SA版权

分类专栏： JavaScript Node.js Node.js Step by Step 文章标签： Node.js Log4js Log4js自定义格式 Log4js自定义变量 log4js-node

本文链接：https://blog.youkuaiyun.com/prufeng/article/details/84986496

Node.js 同时被 3 个专栏收录

17 篇文章

订阅专栏

Node.js Step by Step

16 篇文章

订阅专栏

JavaScript

14 篇文章

订阅专栏

本文介绍如何使用Log4js的PatternLayout自定义日志格式，通过添加自定义变量如当前用户名，并展示了如何优雅地在代码中更新这些变量。利用express中间件截取request参数，设置到log4js，使所有logger都能格式化打印定义参数。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Log4js输出自定义格式，或者想在log里添加自己定义的变量，如显示当前用户名，可以通过pattern layout来实现。

Log4js Pattern Layout

设置占位符如%X{user}
在代码里调用addContext('user','userName')更新变量

log4js.configure({
  appenders: {
    out: { type: 'stdout', layout: {
      type: 'pattern',
      pattern: '%d %p %c %X{user} %m%n'
    }}
  },
  categories: { default: { appenders: ['out'], level: 'info' } }
});
const logger = log4js.getLogger();
logger.addContext('user', 'charlie');
logger.info('doing something.');

This would output:

2017-06-01 08:32:56.283 INFO default charlie doing something.

如何优雅地addContext

思路是利用express middleware，截取request获得参数信息，调用addContext()设置到log4js后，再转发到router的其他请求。这样，在该router里的所有logger都可以格式化地print出我们定义的参数。

这里有个简单Demo，其他AOP方法尚待研究。
https://github.com/prufeng/autotest-node

参考

https://github.com/log4js-node/log4js-node/blob/master/docs/layouts.md