关于自定义Egg.js的请求级别日志详解


Posted in Javascript onDecember 12, 2018

Egg.js 是什么?

Egg.js 为企业级框架和应用而生,我们希望由 Egg.js 孕育出更多上层框架,帮助开发团队和开发人员降低开发和维护成本。

注:Egg.js 缩写为 Egg

背景

组织为了更好的对各个业务的请求日志进行统一的分析,制定了统一的日志打印规范,比如:

[time][processId][traceId][userid] Hello World....

统一格式之后,业务现有业务的日志工具打印出来的格式是无法满足该规范的,所以我们需要对此进行改造。

我们前端目前Node中间层使用的框架是Egg.js,所以下文讲述下如何在Egg.js上自定义请求日志格式。

开始动手

Egg.js中自带了三种logger,分别是

  • Context Logger
  • App Logger
  • Agent Logger

Context Logger主要是用来记录请求相关的日志。每行日志都会在开头自动的记录当前请求的一些信息,比如时间、ip、请求url等等。

App Logger用于记录应用级别的日志,比如程序启动日志。

Agent Logger用于记录多进程模式运行下的日志。

我们想自定义请求级别的日志,那重点就要从Context Logger去研究怎么做。最理想的方案就是,Context Logger本身支持配置化的自定义格式,通过在egg.js的config配置文件中,通过传入formatter的参数就能自定义。

//config.default.js
exports.customLogger = {
 log: {
  file: 'appname.log',
  formatter: (message)=>{
   return `${message.time}${message.processid}` 
  }
 }
}

但不久我们发现这条路走不通,设置了这个formatter并不起作用。从Context Logger的源码中,我们发现的端倪context_logger.js

[ 'error', 'warn', 'info', 'debug' ].forEach(level => {
 const LEVEL = level.toUpperCase();
 ContextLogger.prototype[level] = function() {
 const meta = {
  formatter: contextFormatter,
  paddingMessage: this.paddingMessage,
 };
 this._logger.log(LEVEL, arguments, meta);
 };
});

module.exports = ContextLogger;

function contextFormatter(meta) {
 return meta.date + ' ' + meta.level + ' ' + meta.pid + ' ' + meta.paddingMessage + ' ' + meta.message;
}

在源码中我们可以看到,formatter参数已经被内部的一个自定义格式化函数覆盖了,配置中写的是不会启作用的。
此路不通,只能尝试自己实现logger去解决。自己实现我们需要考虑一些点,比如:

  • 日志要写到文件中,错误日志单独写一个文件
  • 需要能按天或按小时切割日志
  • IO性能

如果这些都自己实现的话,那就太麻烦了。好在了解到Egg的这几个logger都是基于egg-logger和egg-logrotator去实现的,所以我们可以站在巨人的肩膀上搞事情。

Context Logger是基于egg-logger的FileTransport类去进行文件落地的,同时FileTransport也默认配置了egg-logrotator的日志拆分。所以,我们只需要继承FileTransport类,实现接口就可以了,代码如下:

//CoustomTransport.js
const FileTransport = require('egg-logger').FileTransport;
const moment = require('moment');

class CoustomTransport extends FileTransport {
 constructor(options, ctx) {
  super(options);
  this.ctx = ctx;
 }

 log(level, args, meta) {
  const prefixStr = this.buildFormat(level);
  for (let i in args) {
   if (args.hasOwnProperty(i)) {
    if (parseInt(i, 10) === 0) {
     args[i] = `${prefixStr}${args[i]}`;
    }
    if (parseInt(i, 10) === args.length - 1) {
     args[i] += '\n';
    }
   }
  }

  super.log(level, args, meta);
 }

 buildFormat(level) {
  const timeStr = `[${moment().format('YYYY-MM-DD HH:mm:ss.SSS')}]`;
  const threadNameStr = `[${process.pid}]`;
  const urlStr = `[${this.ctx.request.url}]`
  return `${timeStr}${threadNameStr}${urlStr}`;
 }

 setUserId(userId) {
  this.userId = userId;
 }
}

module.exports = CoustomTransport;

我们通过 logger.info('Hello World')去打印日志,格式则显示为我们自定义的格式。

到这,自定义日志格式解决了,那我们如何获取每次请求的信息呢?这里就要借助Egg.js框架对Context的扩展功能, Context是请求级别的对象,我们在Context的原型上扩展方法可以拿到该对象带有的每次请求的信息。

//CustomLogger.js
const Logger = require('egg-logger').Logger;
const CoustomTransport = require('./CoustomTransport.js');

module.exports = function(ctx){
 const logger = new Logger();
 logger.set('file', new CoustomTransport({
  level: 'INFO',
  file: 'app.log'
 }, ctx));
 return logger;
};

// app/extend/context.js
/*
* Context对象扩展
* */
const Logger = require('egg-logger').Logger;
const CoustomTransport = require('./CoustomTransport');
const CustomLogger = require('./CustomLogger');
module.exports = {
 get swLog() {
  return CustomLogger(this);
 }
};

调用

// app/controller/home.js
module.exports = app => {
 class HomeController extends app.Controller {
  async index() {
   this.ctx.swLog.info('Hello World');
  }
 }
 return HomeController;
};

结果

[2018-11-02 19:25:09.665][22896][/] Hello World

到此,我们就能完整的自定义请求级别的日志了。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

Javascript 相关文章推荐
javascript四舍五入函数代码分享(保留后几位)
Dec 10 Javascript
Javascript访问器属性实例分析
Dec 30 Javascript
Javascript基础教程之argument 详解
Jan 18 Javascript
jQuery实现选项卡切换效果简单演示
Dec 09 Javascript
学习JavaScript设计模式之模板方法模式
Jan 20 Javascript
实例讲解JavaScript中instanceof运算符的用法
Jun 08 Javascript
基于jQuery实现歌词滚动版音乐播放器的代码
Sep 17 Javascript
简单实现JS计算器功能
Dec 21 Javascript
Jquery鼠标放上去显示全名的实现方法
Feb 06 Javascript
详解webpack打包vue时提取css
May 26 Javascript
浅谈vuex的基本用法和mapaction传值问题
Nov 08 Javascript
JavaScript实现省市联动效果
Nov 22 Javascript
JS/HTML5游戏常用算法之碰撞检测 像素检测算法实例详解
Dec 12 #Javascript
d3绘制基本的柱形图的实现代码
Dec 12 #Javascript
JS/HTML5游戏常用算法之碰撞检测 地图格子算法实例详解
Dec 12 #Javascript
JS/HTML5游戏常用算法之追踪算法实例详解
Dec 12 #Javascript
js使用swiper实现层叠轮播效果实例代码
Dec 12 #Javascript
如何制作一个Node命令行图像识别工具
Dec 12 #Javascript
JS遍历JSON数组及获取JSON数组长度操作示例【测试可用】
Dec 12 #Javascript
You might like
php+js实现异步图片上传实例分享
2014/06/02 PHP
PHP超牛逼无限极分类生成树方法
2015/05/11 PHP
PHP生成图片缩略图类示例
2017/01/12 PHP
PHP实现网站访问量计数器
2017/10/27 PHP
Javascript SHA-1:Secure Hash Algorithm
2006/12/20 Javascript
深入聊聊Array的sort方法的使用技巧.详细点评protype.js中的sortBy方法
2007/04/12 Javascript
IE/FireFox具备兼容性的拖动代码
2007/08/13 Javascript
获取网站跟路径的javascript代码(站点及虚拟目录)
2009/10/20 Javascript
js截取函数(indexOf,join等)
2010/09/01 Javascript
关于jQuery中的each方法(jQuery到底干了什么)
2014/03/05 Javascript
javascript获取checkbox复选框获取选中的选项
2014/08/12 Javascript
javascript实现禁止复制网页内容
2014/12/16 Javascript
javascript与Python快速排序实例对比
2015/08/10 Javascript
JS实现简单的右下角弹出提示窗口完整实例
2016/06/21 Javascript
form表单转Json提交的方法(推荐)
2016/09/23 Javascript
js 调用百度分享功能
2017/02/27 Javascript
vue2 设置router-view默认路径的实例
2018/09/20 Javascript
微信小程序Echarts图表组件使用方法详解
2019/06/25 Javascript
vue 实现setInterval 创建和销毁实例
2020/07/21 Javascript
Python实现批量把SVG格式转成png、pdf格式的代码分享
2014/08/21 Python
Python基于回溯法子集树模板解决数字组合问题实例
2017/09/02 Python
详解Python下Flask-ApScheduler快速指南
2018/11/04 Python
python对于requests的封装方法详解
2019/01/03 Python
Python 单例设计模式用法实例分析
2019/09/23 Python
K近邻法(KNN)相关知识总结以及如何用python实现
2021/01/28 Python
简单介绍HTML5中audio标签的使用
2015/09/24 HTML / CSS
书法比赛获奖感言
2014/02/10 职场文书
餐饮采购员岗位职责
2014/03/15 职场文书
团队队名口号大全
2014/06/06 职场文书
三月雷锋月活动总结
2014/07/03 职场文书
司机个人年终总结
2015/03/03 职场文书
教师工作能力自我评价
2015/03/04 职场文书
2016年中秋节晚会领导致辞
2015/11/26 职场文书
Python 用户输入和while循环的操作
2021/05/23 Python
javascript Number 与 Math对象的介绍
2021/11/17 Javascript
基于Pygame实现简单的贪吃蛇游戏
2021/12/06 Python