时间:2021-03-16 10:21:10 | 栏目:NodeJS | 点击:次
前言
对于后端程序应用来说,日志是必不可少的,在nodeJs当中并没有自带的日志模块。最近正好使用koa框架来做后端服务,需要对日志进行分割处理,特记录下分享给大家。
一.后端代码目录结构
├── back-end │ ├── logs 所有产生的日志文件存放在此目录下 │ ├── db.js 使用Sequelize连接数据库 │ ├── logger.js 日志的配置 │ ├── server.js 后端提供的所有接口
二.引用日志模块
log4js-node是一款比较好的在node环境下对于日志处理的模块,由于我的整个项目是基于koa框架,所以我选择了koa-log4模块。
koa-log4在log4js-node的基础上做了一次包装,是koa的一个处理日志的中间件,此模块可以帮助你按照你配置的规则分叉日志消息。
三.日志配置logger.js
koa-log4的配置与log4js-node是一样的。
const path = require('path'); const log4js = require('koa-log4'); log4js.configure({ appenders: { access: { type: 'dateFile', pattern: '-yyyy-MM-dd.log', //生成文件的规则 filename: path.join('back-end/logs/', 'access.log') //生成文件名 }, application: { type: 'dateFile', pattern: '-yyyy-MM-dd.log', filename: path.join('back-end/logs/', 'application.log') }, out: { type: 'console' } }, categories: { default: { appenders: [ 'out' ], level: 'info' }, access: { appenders: [ 'access' ], level: 'info' }, application: { appenders: [ 'application' ], level: 'WARN'} } }); exports.accessLogger = () => log4js.koaLogger(log4js.getLogger('access')); //记录所有访问级别的日志 exports.logger = log4js.getLogger('application'); //记录所有应用级别的日志
四.日志的使用方法
1.访问日志
对于日志的使用,访问级别的,记录用户的所有请求,作为koa的中间件,直接使用便可,如下:
const Koa = require('koa'); const KoaRouter = require('koa-router'); const app = new Koa(); const router = new KoaRouter(); const { logger, accessLogger } = require('./logger'); const router = new KoaRouter(); app.use(accessLogger());
2.应用日志
应用级别的日志,可记录全局状态下的error,也可记录接口请求当中的错误处理。
捕获全局状态下的error
app.on('error', err => { logger.error(err); });
接口请求错误
router.post('/test',async (ctx, next)=>{ //处理代码 }catch(e){ logger.error(e); ctx.body = {status:-1, message:e.message}; } });
五.自动生成日志
开启node应用对于每一次的请求,都将按日期来生成日志文件,以下是我这几天自动生成的日志文件
六.日志内容分析
日志文件当中都有详细的记录