对于线上项目用来说,日志是非常重要的一环。log4js是使用得比较多的一个日志组件,经常跟Express一起配合使用。本文从入门实例开始,讲解log4js的使用,以及如何跟Express进行整合。
入门例子
输出日志如下,包括日志打印时间、日志级别、日志分类、日志内容。
// started.js
var log4js = require('log4js');
var logger = log4js.getLogger();
logger.debug('hello world');
// 输出:
// [2017-02-28 21:28:22.853] [DEBUG] [default] - hello world
日志级别
logger.setLevel('INFO');
表示想要打印的最低级别的日志是INFO
,也就是说,调用类似logger.debug()
等级别低于INFO
的接口,日志是不会打印出来的。
var log4js = require('log4js');
var logger = log4js.getLogger();
logger.setLevel('INFO');
logger.debug('level: debug');
logger.info('level: info');
logger.error('level: error');
// 输出如下:
// [2017-02-28 21:50:45.372] [INFO] [default] - level: info
// [2017-02-28 21:50:45.376] [ERROR] [default] - level: error
日志类别
除级别外,还可以对日志进行分类,log4js.getLogger(category)
,如下所示
var log4js = require('log4js');
var alogger = log4js.getLogger('category-a');
var blogger = log4js.getLogger('category-b');
alogger.info('hello');
blogger.info('hello');
// 输出如下:
// [2017-02-28 22:36:57.570] [INFO] category-a - hello
// [2017-02-28 22:36:57.574] [INFO] category-b - hello
appenders
appenders指定日志输出的位置,可以同时配置多个,用category进行区分。比如 log4js.getLogger('info')
应用的就是 type
为 dateFile
的配置。
可以注意到,type
为 console
的配置没有声明 category
,因此,所有的日志都会打印到控制台。
var log4js = require('log4js');
log4js.configure({
appenders: [
{ type: 'console'},
{ type: 'dateFile', filename: './logs/info.log', category: 'info' }
]
});
var logger = log4js.getLogger('info');
logger.setLevel('INFO');
logger.trace('trace');
logger.debug('debug');
logger.info('info');
// 输出如下:
// [2017-02-28 22:51:30.723] [INFO] info - info
express应用
一个比较简单的例子如下,日志全部打印到控制台。
var express = require('express');
var log4js = require('log4js');
var app = express();
log4js.configure({
appenders: [
{ type: 'console', category: 'app' }
]
});
var logger = log4js.getLogger('app');
logger.setLevel('INFO'); // 级别 > INFO 的日志才会被打印
app.use( log4js.connectLogger(logger) );
app.use(function(req, res, next){
res.send('ok');
});
app.listen(3000);
访问 http://127.0.0.1:3000 ,打印日志如下
[2017-03-01 00:28:29.301] [INFO] app - ::ffff:127.0.0.1 - - "GET / HTTP/1.1" 304 - "" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36"
log4js.connectLogger(logger)
时,可以声明日志的级别。
// 级别 > INFO 的日志才会被打印
logger.setLevel('INFO');
// 日志的级别是 WARN
app.use( log4js.connectLogger(logger, {level: 'WARN'}) );
注意,如果声明的日志级别低于logger.setLevel(level)
限定的级别,那么日志不会被打印,如下例子。
logger.setLevel('INFO');
app.use( log4js.connectLogger(logger, {level: 'DEBUG'}) );