2

NPM酷库,每天两分钟,了解一个流行NPM库。

前两天,我们认识了 debug 库 和 winston 库,两款管理程序日志的库,其中debug偏向于适合开发调试,winston则更适合在一个完整的 Node.js 应用中管理日常日志记录。

今天,我们继续认识另一个日志框架 log4js,这个框架和 winston 有些类似,也提供了多路日志输出的功能。所谓多路,意思是你可以自定义多个日志储存驱动,比如,将日志输出到终端的同时,将重要日志记录到文件中,甚至写到数据库中。 winston 中称之为 Transports,而log4js 中称之为 Appenders (输出源)。

注意,虽然 log4js 的名字很像JAVA的日志库 log4j,但两者没什么关系,并且接口也是不同的

log4js 用法

const log4js = require('log4js');

const logger = log4js.getLogger();

logger.level = 'debug';

logger.debug("Some debug messages");

上边就是log2js 最简单的用法,程序会将日志输出到控制台:

[2018-01-06T12:23:43.706] [DEBUG] default - Some debug messages

注意,代码中将日志输出等级设置为debug,程序会输出DEBUG级别以上的日志,如果不设置,默认级别为OFF 即关闭所有日志输出!

log4js 重要概念

Level

日志级别,debug/info/error 等,参考 RFC5424。

Category

日志分类,可以用来标志不同的程序模块,类似debug库中的效果,默认分类为 default

Appender

输出源,你可以选择不同的输出源将日志输出到控制台、文件、数据库,甚至Email。

Logger

log4js 的主要日志接口,可以实例多个Logger,每一个Logger都可选地设置 Category,所以我们的应用中,不同模块实例化不同的Logger对象,输出的日志中就会记录下不同模块的日志输出。

Layout

Layout是日志输出时用来格式化日志的函数,你可以自定义不同的Layout函数,用来自定义日志格式。

LogEvent

每一次调用日志记录函数就会生成一个LogEvent:

logger.debug("Some debug messages");

LogEvent 中包含当前时间戳、日志级别、分类等信息。

参考资料

log4js: https://github.com/log4js-nod...

log4js文档: https://log4js-node.github.io...

RFC 5424: https://tools.ietf.org/html/r...

欢迎关注公众号:梁兴臣

梁兴臣

每天了解一个NPM库,一年后成为Node.js高手


脉冲云_梁兴臣
616 声望194 粉丝

脉冲云CTO,JS全栈开发,DevOps实施,开发体验优化,开发效率提升