关于自定义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 相关文章推荐
js写一个弹出层并锁屏效果实现代码
Dec 07 Javascript
html+javascript实现可拖动可提交的弹出层对话框效果
Aug 05 Javascript
javascript函数重载解决方案分享
Feb 19 Javascript
JS是按值传递还是按引用传递
Jan 30 Javascript
javascript中的Function.prototye.bind
Jun 25 Javascript
jQuery实现的图文高亮滚动切换特效实例
Aug 10 Javascript
安装使用Mongoose配合Node.js操作MongoDB的基础教程
Mar 01 Javascript
jQuery给div,Span, a ,button, radio 赋值与取值
Jun 24 Javascript
js实现微博发布小功能
Jan 12 Javascript
原生js实现密码输入框值的显示隐藏
Jul 17 Javascript
ES6 Symbol数据类型的应用实例分析
Jun 26 Javascript
vue+element搭建后台小总结 el-dropdown下拉功能
Apr 10 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截取中文字符串不乱码的方法
2013/12/25 PHP
php之readdir函数用法实例
2014/11/13 PHP
php实现parent调用父类的构造方法与被覆写的方法
2015/02/11 PHP
php中判断数组相等的方法以及数组运算符介绍
2015/03/30 PHP
浅谈PDO的rowCount函数
2015/06/18 PHP
CodeIgniter多语言实现方法详解
2016/01/20 PHP
json跟xml的对比分析
2008/06/10 Javascript
Ext 表单布局实例代码
2009/04/30 Javascript
用 Javascript 验证表单(form)中多选框(checkbox)值
2009/09/08 Javascript
基于jquery的滑动样例代码
2010/11/20 Javascript
jQuery获取文本节点之 text()/val()/html() 方法区别
2011/03/01 Javascript
js获取通过ajax返回的map型的JSONArray的方法
2014/01/09 Javascript
Jquery 实现弹出层插件
2015/01/28 Javascript
原生JS和JQuery动态添加、删除表格行的方法
2015/05/28 Javascript
百度地图api如何使用
2015/08/03 Javascript
jQuery基于扩展简单实现倒计时功能的方法
2016/05/14 Javascript
Angular.JS中指令ng-if的注意事项小结
2017/06/21 Javascript
TypeScript基础入门教程之三重斜线指令详解
2018/10/22 Javascript
如何使用50行javaScript代码实现简单版的call,apply,bind
2019/08/14 Javascript
vue实现滑动到底部加载更多效果
2020/10/27 Javascript
npm 语义版本控制详解
2019/09/10 Javascript
JS Ajax请求会话过期处理问题解决方法分析
2019/11/16 Javascript
JS 设计模式之:单例模式定义与实现方法浅析
2020/05/06 Javascript
微信小程序语音同步智能识别的实现案例代码解析
2020/05/29 Javascript
Vue循环遍历选项赋值到对应控件的实现方法
2020/06/22 Javascript
js属性对象的hasOwnProperty方法的使用
2021/02/05 Javascript
[00:34]DOTA2上海特级锦标赛 Spirit战队宣传片
2016/03/04 DOTA
Python常用的文件及文件路径、目录操作方法汇总介绍
2015/05/21 Python
Python单例模式实例详解
2017/03/01 Python
Python实现的求解最小公倍数算法示例
2018/05/03 Python
python使用Matplotlib画条形图
2020/03/25 Python
Python中format()格式输出全解
2019/04/12 Python
Python音频操作工具PyAudio上手教程详解
2019/06/26 Python
浅谈Pytorch中的torch.gather函数的含义
2019/08/18 Python
中文教师求职信
2014/02/22 职场文书
物联网工程专业推荐信
2014/09/08 职场文书