对于线上项目用来说,日志是非常重要的一环。log4js是使用得比较多的一个日志组件,经常跟Express一起配合使用。本文从入门实例开始,讲解log4js的使用,以及如何跟Express进行整合。

入门例子

输出日志如下,包括日志打印时间、日志级别、日志分类、日志内容。

  1. // started.js
  2. var log4js = require('log4js');
  3. var logger = log4js.getLogger();
  4. logger.debug('hello world');
  5. // 输出:
  6. // [2017-02-28 21:28:22.853] [DEBUG] [default] - hello world

日志级别

logger.setLevel('INFO'); 表示想要打印的最低级别的日志是INFO,也就是说,调用类似logger.debug()等级别低于INFO的接口,日志是不会打印出来的。

  1. var log4js = require('log4js');
  2. var logger = log4js.getLogger();
  3. logger.setLevel('INFO');
  4. logger.debug('level: debug');
  5. logger.info('level: info');
  6. logger.error('level: error');
  7. // 输出如下:
  8. // [2017-02-28 21:50:45.372] [INFO] [default] - level: info
  9. // [2017-02-28 21:50:45.376] [ERROR] [default] - level: error

日志类别

除级别外,还可以对日志进行分类,log4js.getLogger(category),如下所示

  1. var log4js = require('log4js');
  2. var alogger = log4js.getLogger('category-a');
  3. var blogger = log4js.getLogger('category-b');
  4. alogger.info('hello');
  5. blogger.info('hello');
  6. // 输出如下:
  7. // [2017-02-28 22:36:57.570] [INFO] category-a - hello
  8. // [2017-02-28 22:36:57.574] [INFO] category-b - hello

appenders

appenders指定日志输出的位置,可以同时配置多个,用category进行区分。比如 log4js.getLogger('info') 应用的就是 typedateFile 的配置。

可以注意到,typeconsole 的配置没有声明 category ,因此,所有的日志都会打印到控制台。

  1. var log4js = require('log4js');
  2. log4js.configure({
  3. appenders: [
  4. { type: 'console'},
  5. { type: 'dateFile', filename: './logs/info.log', category: 'info' }
  6. ]
  7. });
  8. var logger = log4js.getLogger('info');
  9. logger.setLevel('INFO');
  10. logger.trace('trace');
  11. logger.debug('debug');
  12. logger.info('info');
  13. // 输出如下:
  14. // [2017-02-28 22:51:30.723] [INFO] info - info

express应用

一个比较简单的例子如下,日志全部打印到控制台。

  1. var express = require('express');
  2. var log4js = require('log4js');
  3. var app = express();
  4. log4js.configure({
  5. appenders: [
  6. { type: 'console', category: 'app' }
  7. ]
  8. });
  9. var logger = log4js.getLogger('app');
  10. logger.setLevel('INFO'); // 级别 > INFO 的日志才会被打印
  11. app.use( log4js.connectLogger(logger) );
  12. app.use(function(req, res, next){
  13. res.send('ok');
  14. });
  15. app.listen(3000);

访问 http://127.0.0.1:3000 ,打印日志如下

  1. [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) 时,可以声明日志的级别。

  1. // 级别 > INFO 的日志才会被打印
  2. logger.setLevel('INFO');
  3. // 日志的级别是 WARN
  4. app.use( log4js.connectLogger(logger, {level: 'WARN'}) );

注意,如果声明的日志级别低于logger.setLevel(level)限定的级别,那么日志不会被打印,如下例子。

  1. logger.setLevel('INFO');
  2. app.use( log4js.connectLogger(logger, {level: 'DEBUG'}) );

相关链接

官网:https://github.com/nomiddlename/log4js-node