背景

:::info 目前是MVP（最小化可行产品）1.0阶段, 实现全链路日志追踪，便于日志监控、问题排查、接口响应耗时数据统计等，根据业务需要，制定了统一的日志打印规范，然后通过定时器，读取日志的信息，经过日志清洗，日志过滤，最后存到数据库中，形成简单的一个闭环。结合腾讯邮箱通知使用，前端可以作为可视化分析使用等。 :::

一、Egg错误分类

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

  • Context Logger
  • App Logger
  • Agent Logger

1.Context Logger

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

    2.APP Logger

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

    3.Agent Logger

  • 用于记录多进程模式运行下的日志

二、自定义日志插件开发

基于 egg-logger 定制开发一个插件项目，参考 插件开发，以下以 egg-logger-custom 为项目，展示核心代码编写

  • 编写logger.js

    egg-logger-custom/lib/logger.js

const moment = require(‘moment’);
const FileTransport = require(‘egg-logger’).FileTransport;
const utils = require(‘./utils’); const util = require(‘util’);

/ 继承 FileTransport /
class AppTransport extends FileTransport {
constructor(options, ctx) {
super(options);
this.ctx = ctx; // 得到每次请求的上下文
}
log(level, args, meta) {
// 获取自定义格式消息
const customMsg = this.messageFormat({
level,
});
// 针对 Error 消息打印出错误的堆栈
if (args[0] instanceof Error) {
const err = args[0] || {};
args[0] = util.format(‘%s: %s\n%s\npid: %s\n’, err.name, err.message, err.stack, process.pid);
} else {
args[0] = util.format(customMsg, args[0]);
}

  1.     // 这个是必须的，否则日志文件不会写入<br />        super.log(level, args, meta);<br />    }<br />    messageFormat({<br />        level<br />    }) {<br />        const { ctx } = this;<br />        const params = JSON.stringify(Object.assign({}, ctx.request.query, ctx.body));<br />        return [<br />            moment().format('YYYY/MM/DD HH:mm:ss'),<br />            ctx.request.get('traceId'),<br />            utils.serviceIPAddress,<br />            utils.clientIPAddress(ctx.req),<br />            level,<br />        ].join(utils.loggerDelimiter) + utils.loggerDelimiter;<br />    }<br />}<br />module.exports = AppTransport;
  • 工具

    egg-logger-custom/lib/utils.js

const interfaces = require(‘os’).networkInterfaces();

module.exports = {

  1. /**<br />     * 日志分隔符<br />     */<br />    loggerDelimiter: '[]',
  3. /**<br />     * 获取当前服务器IP<br />     */<br />    serviceIPAddress: (() => {<br />        for (const devName in interfaces) {<br />            const iface = interfaces[devName];
  5.         for (let i = 0; i < iface.length; i++) {<br />                const alias = iface[i];
  7.             if (alias.family === 'IPv4' && alias.address !== '127.0.0.1' && !alias.internal) {<br />                    return alias.address;<br />                }<br />            }<br />        }<br />    })(),
  9. /**<br />     * 获取当前请求客户端IP<br />     * 不安全的写法<br />     */<br />    clientIPAddress: req => {<br />        const address = req.headers['x-forwarded-for'] || // 判断是否有反向代理 IP<br />        req.connection.remoteAddress || // 判断 connection 的远程 IP<br />        req.socket.remoteAddress || // 判断后端的 socket 的 IP<br />        req.connection.socket.remoteAddress;
  11.     return address.replace(/::ffff:/ig, '');<br />    },
  13. clientIPAddress: ctx => {    <br />        return ctx.ip;<br />    },<br />}
  • 初始化 Logger

    egg-logger-custom/app.js

const Logger = require(‘egg-logger’).Logger;
const ConsoleTransport = require(‘egg-logger’).ConsoleTransport;
const AppTransport = require(‘./app/logger’);

module.exports = (ctx, options) => {
const logger = new Logger();

  1. logger.set('file', new AppTransport({<br />        level: options.fileLoggerLevel || 'INFO',<br />        file: `/var/logs/${options.appName}/bizLog/${options.appName}.log`,<br />    }, ctx));
  3. logger.set('console', new ConsoleTransport({<br />        level: options.consoleLevel || 'INFO',<br />    }));
  5. return logger;<br />}

三、项目扩展

自定义日志中间件封装好之后，在实际项目应用中我们还需要一步操作，Egg 提供了 框架扩展 功能，包含五项：Application、Context、Request、Response、Helper，可以对这几项进行自定义扩展，对于日志因为每次日志记录我们需要记录当前请求携带的 traceId 做一个链路追踪，需要用到 Context（是 Koa 的请求上下文） 扩展项。

新建 app/extend/context.js 文件

const AppLogger = require(‘egg-logger-custom’); // 上面定义的中间件

module.exports = { get logger() { // 名字自定义 也可以是 customLogger

return AppLogger(this, {

appName: ‘test’, // 项目名称

consoleLevel: ‘DEBUG’, // 终端日志级别

fileLoggerLevel: ‘DEBUG’, // 文件日志级别 });

}
}

四、自定义日志格式

可以通过config文件里面的logger 进行配置

config.logger = {
contextFormatter: function(meta) {
console.log(meta);
return [
meta.date,
meta.message
].join(‘[]’)
},

};

五、结合项目

错误日志记录，直接会将错误日志完整堆栈信息记录下来，并且输出到 errorLog 中，为了保证异常可追踪，必须保证所有抛出的异常都是 Error 类型，因为只有 Error 类型才会带上堆栈信息，定位到问题。

const Controller = require(‘egg’).Controller;

class ExampleController extends Controller {
async list() {
const { ctx } = this;

  1.     ctx.logger.error(new Error('程序异常！'));
  3.     ctx.logger.debug('测试');
  5.     ctx.logger.info('测试');<br />    }<br />}

最终打印的日志文件
image.png

六：参考资料

https://eggjs.org/zh-cn/core/logger.html