关于自定义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之对系统的toFixed()方法的修正
May 08 Javascript
js 分页全选或反选标识实现代码
Aug 09 Javascript
jQuery实现div横向拖拽排序的简单实例
Jul 13 Javascript
VueJs与ReactJS和AngularJS的异同点
Dec 12 Javascript
Bootstrap源码解读导航(6)
Dec 23 Javascript
Node.js利用Net模块实现多人命令行聊天室的方法
Dec 23 Javascript
Bootstrap布局之栅格系统学习笔记
May 04 Javascript
基于layui的table插件进行复选框联动功能的实现方法
Sep 19 Javascript
javascript设计模式 ? 迭代器模式原理与用法实例分析
Apr 17 Javascript
在Vue中使用antv的示例代码
Jun 29 Javascript
使用jquery实现轮播图效果
Jan 02 jQuery
ES2020让代码更优美的运算符 (?.) (??)
Jan 04 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/06/24 PHP
php_screw安装使用教程(另一个PHP代码加密实现)
2014/05/29 PHP
php上传文件常见问题总结
2015/02/03 PHP
PHP使用递归方式列出当前目录下所有文件的方法
2015/06/02 PHP
PHP错误处理函数
2016/04/03 PHP
php的api数据接口书写实例(推荐)
2016/09/22 PHP
Netbeans 8.2与PHP相关的新特性介绍
2016/10/08 PHP
20个最新的jQuery插件
2012/01/13 Javascript
jquery制作搜狐快站页面效果示例分享
2014/02/21 Javascript
js实现下拉框选择要显示图片的方法
2015/02/16 Javascript
JS实现支持Ajax验证的表单插件
2016/03/24 Javascript
JavaScript中数组去除重复的三种方法
2016/04/22 Javascript
Node.js刷新session过期时间的实现方法推荐
2016/05/18 Javascript
深入理解JavaScript单体内置对象
2016/06/06 Javascript
详解Vue 开发模式下跨域问题
2017/06/06 Javascript
vue中路由参数传递可能会遇到的坑
2017/12/07 Javascript
为vue-router懒加载时下载js的过程中添加loading提示避免无响应问题
2018/04/03 Javascript
ssm+vue前后端分离框架整合实现(附源码)
2020/07/08 Javascript
解决vue刷新页面以后丢失store的数据问题
2020/08/11 Javascript
pyside写ui界面入门示例
2014/01/22 Python
彻底理解Python list切片原理
2017/10/27 Python
python生成tensorflow输入输出的图像格式的方法
2018/02/12 Python
Python实现的拟合二元一次函数功能示例【基于scipy模块】
2018/05/15 Python
python 获取当天凌晨零点的时间戳方法
2018/05/22 Python
Python matplotlib 画图窗口显示到gui或者控制台的实例
2018/05/24 Python
tensorflow 打印内存中的变量方法
2018/07/30 Python
Pycharm以root权限运行脚本的方法
2019/01/19 Python
python3正则提取字符串里的中文实例
2019/01/31 Python
简单了解python 邮件模块的使用方法
2019/07/24 Python
Python+PyQt5+MySQL实现天气管理系统
2020/06/16 Python
html5+css3之制作header实例与更新
2020/12/21 HTML / CSS
德国百年厨具品牌WMF美国站:WMF美国
2016/09/12 全球购物
Solid & Striped官网:美国泳装品牌
2019/06/19 全球购物
副护士长竞聘演讲稿
2014/04/30 职场文书
《观潮》教学反思
2016/02/17 职场文书
Mysql中where与on的区别及何时使用详析
2021/08/04 MySQL