1.安装
npm install express morgan
2.使用案例(默认)
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);
eg:
2016.12.11-advanced-morgan git:(master) ✗ 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
核心API
morgan的API非常少,使用频率最高的就是morgan(),作用是返回一个express日志中间件。
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。
morgan.format(name, format); // 自定义日志格式
morgan.token(name, fn); // 自定义token
3.使用案例(自定义format)
var express = require('express');
var app = express();
var morgan = require('morgan');
morgan.format('hcsy', '[hcsy] :method :url :status');
app.use(morgan('hcsy'));
app.use(function(req, res, next){
res.send('ok');
});
app.listen(3000);
eg:
[hcsy] GET /users 304
4.只打印4xx 和 5xx的文件
var logDirectory = path.join(__dirname, 'log')
fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory)//判断是否存在文件,不存在即创建
//error 的日志文件
var accessLogStream = FileStreamRotator.getStream({
date_format: 'YYYYMMDDhh',// 日志文件按小时记录
filename: path.join(logDirectory, 'error-%DATE%.log'),
frequency: 'daily',
verbose: false
})
//info 的日志文件
var accessLogStreamInfo = FileStreamRotator.getStream({
date_format: 'YYYYMMDDhh',// 日志文件按小时记录
filename: path.join(logDirectory, 'info-%DATE%.log'),
frequency: 'daily',
verbose: false
})
//warn 的日志文件
var accessLogStreamWarn = FileStreamRotator.getStream({
date_format: 'YYYYMMDDhh',// 日志文件按小时记录
filename: path.join(logDirectory, 'info-%DATE%.log'),
frequency: 'daily',
verbose: false
})
//只会打印 4xxx 和 5xxx 的请求
app.use(logger('error', {
skip: function (req, res) { console.log("执行打印error"); return res.statusCode < 400 },
stream: accessLogStream
}))