代码地址以下:
http://www.demodashi.com/demo/12466.htmlhtml
以前作的项目是采用 Express 框架进行搭建的,其中的日志管理采用了 winston + Postgresql + sequelize的形式, 最近倒弄 Koa2 框架,因而就想着尝试采用另外一种方式进行访问日志的管理,就想到了 log4js。关于 log4js 的介绍在这里就很少叙述了,想了解请点击 log4js详细介绍node
说到数据持久化,最广泛的无非就两种方式:sql
本文将以log4js为主线,分别对这两种形式进行实现。mongodb
log4js 输入日志到文件有两种形式:数据库
直接上代码:npm
// log4js.js const log4js = require('log4js') log4js.configure({ appenders: { error: { type: 'file', //日志类型 category: 'errLogger', //日志名称 filename: __dirname + '/../logs/error.log/', //日志输出位置,当目录文件或文件夹不存在时自动建立 maxLogSize: 104800, // 文件最大存储空间 backups: 100 //当文件内容超过文件存储空间时,备份文件的数量 }, response: { type: 'dateFile', category: 'resLogger', filename: __dirname + '/../logs/responses/', pattern: 'yyyy-MM-dd.log', //日志输出模式 alwaysIncludePattern: true, maxLogSize: 104800, backups: 100 } }, categories: { error: {appenders: ['error'], level: 'error'}, response: {appenders: ['response'], level: 'info'}, default: { appenders: ['response'], level: 'info'} }, replaceConsole: true })
日志配置文件咱们已经完成,在这里定义了两种形式的日志,分别是 errLogger 错误日志, resLogger 响应日志。
接下来咱们将这两种日志进行自定义格式化输出:api
// log4js.js const {formatError, formatRes} = require('./formatLog') let logger = {} let errorLogger = log4js.getLogger('error') let resLogger = log4js.getLogger('response') // 封装错误日志 logger.errLogger = (ctx, error, resTime) => { if(ctx && error) { errorLogger.error(formatError(ctx, error, resTime)) } } // 封装响应日志 logger.resLogger = (ctx, resTime) => { if(ctx) { resLogger.info(formatRes(ctx, resTime)) } }
// formatLog.js let formatError = (ctx, err,costTime) => { let method = ctx.method let url = ctx.url let body = ctx.request.body let userAgent = ctx.header.userAgent return {method, url, body, costTime, err} } let formatRes = (ctx,costTime) => { let method = ctx.method let url = ctx.url let body = ctx.request.body let response = ctx.response return {method, url, body, costTime, response} } module.exports = {formatError, formatRes}
在咱们的应用中使用咱们自定义的日志模型服务器
//app.js const log4js = require('./utils/log4js') // logger app.use(async(ctx, next) => { const start = new Date() await next() const ms = new Date() - start log4js.resLogger(ctx, ms) }) app.on('error', (err, ctx) => { log4js.errLogger(ctx, err) console.error('server error', err, ctx) });
此时咱们的访问信息都已被输出到了项目 logs 文件夹下面。app
咱们采用 Mongoose 驱动进行与 MongoDB 数据库进行交互。关于 Mongoose 的使用请查看 Mongoose使用详情框架
首先咱们先定义一个存放日志的数据模型 Log,以下:
//log.js let log = new Schema({ level: {type: String}, message: {type: String}, info: { method: String, url: String, costTime: Number, body: String, response: { status: Number, message: String, header: String, body: String } } }, { versionKey: false }) module.exports = mongoose.model('logs', log)
日志内容存储到数据库中,实现以下log2db.js
//log2db.js const {Log} = require('../models') let log2db = (msg, level, info) => { let log = { level: level || 'info', message: msg, info: { method: info.method, url: info.url, costTime: info.costTime, body: JSON.stringify(info.body), response: { status: info.response.status, message: info.response.message, header: JSON.stringify(info.response.header), body: JSON.stringify(info.response.body) } } } Log.create(log, (err, res) => { if(err) {console.log(err)} }) } module.exports = log2db
修改咱们上边封装的两种日志类型,添加 log2db 以下:
// 封装错误日志 logger.errLogger = (ctx, error, resTime) => { if(ctx && error) { log2db('ErrorRequest', 'error', formatError(ctx, error, resTime)) errorLogger.error(formatError(ctx, error, resTime)) } } // 封装相应日志 logger.resLogger = (ctx, resTime) => { if(ctx) { log2db('RequestInfo', 'info', formatRes(ctx, resTime)) resLogger.info(formatRes(ctx, resTime)) } }
OK, 咱们重启服务器,进行访问,而后经过 RoboMongo 进行查看咱们的 Log 集合,就会发现咱们的访问信息都已经记录了下来。
Koa2 + Mongoose + Log4js 持久化日志
注:本文著做权归做者,由demo大师代发,拒绝转载,转载须要做者受权