express框架日誌處理組件morgan

morgan是express默認的日誌中間件，經過插拔方式引入express框架中，本文將從如下幾方面內容展開。

• 日誌控制檯顯示

// 安裝包
$npm install express morgan -s
var express = require('express');
var app = express();
var morgan = require('morgan');

app.use(morgan('short'));
app.use(function(req, res, next){
    res.send('ok');
});

app.listen(3000);

$node basic.js
::ffff:127.0.0.1 - GET / HTTP/1.1 304 - - 3.019 ms
::ffff:127.0.0.1 - GET /favicon.ico HTTP/1.1 200 2 - 0.984 ms

• 日誌文件保存

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

• API介紹

morgan(format, options) 返回express的中間件
參數說明：
format：可選，morgan與定義了幾種日誌格式，每種格式都有對應的名稱，好比combined、short等，默認是default
options：可選，配置項，包含stream（經常使用）、skip、immediate
stream：日誌的輸出流配置，默認是process.stdout
skip：是否跳過日誌記錄

morgan('combined', {
  skip: function (req, res) { return res.statusCode < 400 }
})

immediate：布爾值，默認是false。當爲true時，一收到請求，就記錄日誌；若是爲false，則在請求返回後，再記錄日誌

自定義fromt

var express = require('express');
var app = express();
var morgan = require('morgan');

morgan.format('joke', '[joke] :method :url :status');

app.use(morgan('joke'));

app.use(function(req, res, next){
    res.send('ok');
});

app.listen(3000);

自定義token

var express = require('express');
var app = express();
var morgan = require('morgan');

// 自定義token
morgan.token('from', function(req, res){
    return req.query.from || '-';
});

// 自定義format，其中包含自定義的token
morgan.format('joke', '[joke] :method :url :status :from');

// 使用自定義的format
app.use(morgan('joke'));

app.use(function(req, res, next){
    res.send('ok');
});

app.listen(3000);

• 日誌切割

var FileStreamRotator = require('file-stream-rotator')
var express = require('express')
var fs = require('fs')
var morgan = require('morgan')
var path = require('path')

var app = express()
var logDirectory = path.join(__dirname, 'log')

// ensure log directory exists
fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory)

// create a rotating write stream
var accessLogStream = FileStreamRotator.getStream({
  date_format: 'YYYYMMDD',
  filename: path.join(logDirectory, 'access-%DATE%.log'),
  frequency: 'daily',
  verbose: false
})

// setup the logger
app.use(morgan('combined', {stream: accessLogStream}))

app.get('/', function (req, res) {
  res.send('hello, world!')
})

• 日誌數據庫存儲

待續