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

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主要是用来记录请求相关的日志。每行日志都会在开头自动的记录当前请求的一些信息，比如时间、ip、请求url等等。

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

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

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

//config.default.jsexports.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去解决。自己实现我们需要考虑一些点，比如：

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

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