章节概览

morgan是express默认的日志中间件，也可以脱离express，作为node.js的日志组件单独使用。本文由浅入深，内容主要包括：

  • morgan使用入门例子
  • 如何将日志保存到本地文件
  • 核心API使用说明及例子
  • 进阶使用：1、日志分割 2、将日志写入数据库
  • 源码剖析：morgan的日志格式以及预编译

入门例子

首先，初始化项目。

  1. npm install express morgan

然后，在basic.js中添加如下代码。

  1. var express = require('express');
  2. var app = express();
  3. var morgan = require('morgan');
  5. app.use(morgan('short'));
  6. app.use(function(req, res, next){
  7.     res.send('ok');
  8. });
  10. app.listen(3000);

node basic.js运行程序，并在浏览器里访问 http://127.0.0.1:3000 ，打印日志如下

  1. ➜  2016.12.11-advanced-morgan git:(master) ✗ node basic.js
  2. ::ffff:127.0.0.1 - GET / HTTP/1.1 304 - - 3.019 ms
  3. ::ffff:127.0.0.1 - GET /favicon.ico HTTP/1.1 200 2 - 0.984 ms

将日志打印到本地文件

morgan支持stream配置项，可以通过它来实现将日志落地的效果，代码如下：

  1. var express = require('express');
  2. var app = express();
  3. var morgan = require('morgan');
  4. var fs = require('fs');
  5. var path = require('path');
  7. var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'});
  9. app.use(morgan('short', {stream: accessLogStream}));
  10. app.use(function(req, res, next){
  11.     res.send('ok');
  12. });
  14. app.listen(3000);

使用讲解

核心API

morgan的API非常少，使用频率最高的就是morgan()，作用是返回一个express日志中间件。

  1. morgan(format, options)

参数说明如下：

  • format：可选，morgan与定义了几种日志格式，每种格式都有对应的名称，比如combined、short等，默认是default。不同格式的差别可参考这里。下文会讲解下，如果自定义日志格式。
  • options：可选，配置项，包含stream（常用）、skip、immediate。
    • stream：日志的输出流配置，默认是process.stdout。
    • skip：是否跳过日志记录，使用方式可以参考这里。
    • immediate：布尔值，默认是false。当为true时，一收到请求，就记录日志；如果为false，则在请求返回后，再记录日志。

自定义日志格式

首先搞清楚morgan中的两个概念：format 跟 token。非常简单：

  • format：日志格式，本质是代表日志格式的字符串，比如 :method :url :status :res[content-length] - :response-time ms。
  • token：format的组成部分，比如上面的:method、:url即使所谓的token。

搞清楚format、token的区别后，就可以看下morgan中，关于自定义日志格式的关键API。

  1. morgan.format(name, format);  // 自定义日志格式
  2. morgan.token(name, fn);  // 自定义token

自定义format

非常简单，首先通过morgan.format()定义名为joke的日志格式，然后通过morgan('joke')调用即可。

  1. var express = require('express');
  2. var app = express();
  3. var morgan = require('morgan');
  5. morgan.format('joke', '[joke] :method :url :status');
  7. app.use(morgan('joke'));
  9. app.use(function(req, res, next){
  10.     res.send('ok');
  11. });
  13. app.listen(3000);

我们来看下运行结果

  1. ➜  2016.12.11-advanced-morgan git:(master) ✗ node morgan.format.js
  2. [joke] GET / 304
  3. [joke] GET /favicon.ico 200

自定义token

代码如下，通过morgan.token()自定义token，然后将自定义的token，加入自定义的format中即可。

  1. var express = require('express');
  2. var app = express();
  3. var morgan = require('morgan');
  5. // 自定义token
  6. morgan.token('from', function(req, res){
  7.     return req.query.from || '-';
  8. });
  10. // 自定义format，其中包含自定义的token
  11. morgan.format('joke', '[joke] :method :url :status :from');
  13. // 使用自定义的format
  14. app.use(morgan('joke'));
  16. app.use(function(req, res, next){
  17.     res.send('ok');
  18. });
  20. app.listen(3000);

运行程序，并在浏览器里先后访问 http://127.0.0.1:3000/hello?from=app 和 http://127.0.0.1:3000/hello?from=pc

  1. ➜  2016.12.11-advanced-morgan git:(master) ✗ node morgan.token.js 
  2. [joke] GET /hello?from=app 200 app
  3. [joke] GET /favicon.ico 304 -
  4. [joke] GET /hello?from=pc 200 pc
  5. [joke] GET /favicon.ico 304 -

高级使用

日志切割

一个线上应用，如果所有的日志都落地到同一个本地文件，时间久了，文件会变得非常大，既影响性能，又不便于查看。这时候，就需要用到日志分割了。

借助file-stream-rotator插件，可以轻松完成日志分割的工作。除了file-stream-rotator相关的配置代码，其余跟之前的例子差不多，这里不赘述。

  1. var FileStreamRotator = require('file-stream-rotator')
  2. var express = require('express')
  3. var fs = require('fs')
  4. var morgan = require('morgan')
  5. var path = require('path')
  7. var app = express()
  8. var logDirectory = path.join(__dirname, 'log')
  10. // ensure log directory exists
  11. fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory)
  13. // create a rotating write stream
  14. var accessLogStream = FileStreamRotator.getStream({
  15.   date_format: 'YYYYMMDD',
  16.   filename: path.join(logDirectory, 'access-%DATE%.log'),
  17.   frequency: 'daily',
  18.   verbose: false
  19. })
  21. // setup the logger
  22. app.use(morgan('combined', {stream: accessLogStream}))
  24. app.get('/', function (req, res) {
  25.   res.send('hello, world!')
  26. })

日志写入数据库

有的时候，我们会有这样的需求，将访问日志写入数据库。这种需求常见于需要实时查询统计的日志系统。

在morgan里该如何实现呢？从文档上，并没有看到适合的扩展接口。于是查阅了下morgan的源码，发现实现起来非常简单。

回顾下之前日志写入本地文件的例子，最关键的两行代码如下。通过stream指定日志的输出流。

  1. var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'});
  2. app.use(morgan('short', {stream: accessLogStream}));

在morgan内部，大致实现是这样的（简化后）。

  1. // opt为配置文件
  2. var stream = opts.stream || process.stdout;
  3. var logString = createLogString();  // 伪代码，根据format、token的定义，生成日志
  4. stream.write(logString);

于是，可以用比较取巧的方式来实现目的：声明一个带write方法的对象，并作为stream配置传入。

  1. var express = require('express');
  2. var app = express();
  3. var morgan = require('morgan');
  5. // 带write方法的对象
  6. var dbStream = {
  7.   write: function(line){
  8.     saveToDatabase(line);  // 伪代码，保存到数据库
  9.   }
  10. };
  12. // 将 dbStream 作为 stream 配置项的值
  13. app.use(morgan('short', {stream: dbStream}));
  14. app.use(function(req, res, next){
  15.   res.send('ok');
  16. });
  18. app.listen(3000);

深入剖析

morgan的代码非常简洁，从设计上来说，morgan的生命周期包含：

token定义 —> 日志格式定义 -> 日志格式预编译 —> 请求达到/返回 —> 写日志

其中，token定义、日志格式定义前面已经讲到，这里就只讲下 日志格式预编译 的细节。

跟模板引擎预编译一样，日志格式预编译，也是为了提升性能。源码如下，最关键的代码就是compile(fmt)。

  1. function getFormatFunction (name) {
  2.   // lookup format
  3.   var fmt = morgan[name] || name || morgan.default
  5.   // return compiled format
  6.   return typeof fmt !== 'function'
  7.     ? compile(fmt)
  8.     : fmt
  9. }

compile()方法的实现细节这里不赘述，着重看下compile(fmt)返回的内容：

  1. var morgan = require('morgan');
  2. var format = morgan['tiny'];
  3. var fn = morgan.compile(format);
  5. console.log(fn.toString());

运行上面程序，输出内容如下，其中tokens其实就是morgan。

  1. function anonymous(tokens, req, res
  2. /**/) {
  3.   return ""
  4.     + (tokens["method"](req, res, undefined) || "-") + " "
  5.     + (tokens["url"](req, res, undefined) || "-") + " "
  6.     + (tokens["status"](req, res, undefined) || "-") + " "
  7.     + (tokens["res"](req, res, "content-length") || "-") + " - "
  8.     + (tokens["response-time"](req, res, undefined) || "-") + " ms";
  9. }

看下morgan.token()的定义，就很清晰了

  1. function token (name, fn) {
  2.   morgan[name] = fn
  3.   return this
  4. }

相关链接

https://github.com/expressjs/morgan