基于Egg框架的日志鏈路追蹤實踐分享

EscapedDog 發布于2019-08-23 17:58 / 3441人閱讀

摘要：項目擴展自定義日志中間件封裝好之后，在實際項目應用中我們還需要一步操作，提供了框架擴展功能，包含五項，可以對這幾項進行自定義擴展，對于日志因為每次日志記錄我們需要記錄當前請求攜帶的做一個鏈路追蹤，需要用到是的請求上下文擴展項。

快速導航

[Logger-Custom] 需求背景

[Logger-Custom] 自定義日志插件開發

[Logger-Custom] 項目擴展

[Logger-Custom] 項目應用

[ContextFormatter] contextFormatter自定義日志格式

[Logrotator] 日志切割

需求背景

實現全鏈路日志追蹤，便于日志監控、問題排查、接口響應耗時數據統計等，首先 API 接口服務接收到調用方請求，根據調用方傳的 traceId，在該次調用鏈中處理業務時，如需打印日志的，日志信息按照約定的規范進行打印，并記錄 traceId，實現日志鏈路追蹤。

日志路徑約定

/var/logs/${projectName}/bizLog/${projectName}-yyyyMMdd.log

日志格式約定

日志時間[]traceId[]服務端IP[]客戶端IP[]日志級別[]日志內容

采用 Egg.js 框架 egg-logger 中間件，在實現過程中發現對于按照以上日志格式打印是無法滿足需求的（至少目前我還沒找到可實現方式），如果要自己實現，可能要自己造輪子了，好在官方的 egg-logger 中間件提供了自定義日志擴展功能，參考高級自定義日志，本身也提供了日志分割、多進程日志處理等功能。

egg-logger 提供了多種傳輸通道，我們的需求主要是對請求的業務日志自定義格式存儲，主要用到 fileTransport 和 consoleTransport 兩個通道，分別打印日志到文件和終端。

自定義日志插件開發

基于 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
%s
pid: %s
", err.name, err.message, err.stack, process.pid);
        } else {
            args[0] = util.format(customMsg, args[0]);
        }

        // 這個是必須的，否則日志文件不會寫入
        super.log(level, args, meta);
    }

    /**
     * 自定義消息格式
     * 可以根據自己的業務需求自行定義
     * @param { String } level
     */
    messageFormat({
        level
    }) {
        const { ctx } = this;
        const params = JSON.stringify(Object.assign({}, ctx.request.query, ctx.body));

        return [
            moment().format("YYYY/MM/DD HH:mm:ss"),
            ctx.request.get("traceId"),
            utils.serviceIPAddress,
            utils.clientIPAddress(ctx.req),
            level,
        ].join(utils.loggerDelimiter) + utils.loggerDelimiter;
    }
}

module.exports = AppTransport;

工具

egg-logger-custom/lib/utils.js

const interfaces = require("os").networkInterfaces();

module.exports = {

    /**
     * 日志分隔符
     */
    loggerDelimiter: "[]",

    /**
     * 獲取當前服務器IP
     */
    serviceIPAddress: (() => {
        for (const devName in interfaces) {
            const iface = interfaces[devName];

            for (let i = 0; i < iface.length; i++) {
                const alias = iface[i];

                if (alias.family === "IPv4" && alias.address !== "127.0.0.1" && !alias.internal) {
                    return alias.address;
                }
            }
        }
    })(),

    /**
     * 獲取當前請求客戶端IP
     * 不安全的寫法
     */
    clientIPAddress: req => {
        const address = req.headers["x-forwarded-for"] || // 判斷是否有反向代理 IP
        req.connection.remoteAddress || // 判斷 connection 的遠程 IP
        req.socket.remoteAddress || // 判斷后端的 socket 的 IP
        req.connection.socket.remoteAddress;

        return address.replace(/::ffff:/ig, "");
    },

    clientIPAddress: ctx => {    
        return ctx.ip;
    },
}

注意：以上獲取當前請求客戶端IP的方式，如果你需要對用戶的 IP 做限流、防刷限制，請不要使用如上方式，參見科普文：如何偽造和獲取用戶真實 IP ？，在 Egg.js 里你也可以通過 ctx.ip 來獲取，參考前置代理模式。

初始化 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();

    logger.set("file", new AppTransport({
        level: options.fileLoggerLevel || "INFO",
        file: `/var/logs/${options.appName}/bizLog/${options.appName}.log`,
    }, ctx));

    logger.set("console", new ConsoleTransport({
        level: options.consoleLevel || "INFO",
    }));

    return logger;
}

以上對于日志定制格式開發已經好了，如果你有實際業務需要可以根據自己團隊的需求，封裝為團隊內部的一個 npm 中間件來使用。

項目擴展

自定義日志中間件封裝好之后，在實際項目應用中我們還需要一步操作，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", // 文件日志級別
        });
    }
}

建議：對于日志級別，可以采用配置中心如 Consul 進行配置，上線時日志級別設置為 INFO，當需要生產問題排查時，可以動態開啟 DEBUG 模式。關于 Consul 可以關注我之前寫的服務注冊發現 Consul 系列

項目應用

錯誤日志記錄，直接會將錯誤日志完整堆棧信息記錄下來，并且輸出到 errorLog 中，為了保證異常可追蹤，必須保證所有拋出的異常都是 Error 類型，因為只有 Error 類型才會帶上堆棧信息，定位到問題。

const Controller = require("egg").Controller;

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

        ctx.logger.error(new Error("程序異常！"));

        ctx.logger.debug("測試");

        ctx.logger.info("測試");
    }
}

最終日志打印格式如下所示：

2019/05/30 01:50:21[]d373c38a-344b-4b36-b931-1e8981aef14f[]192.168.1.20[]221.69.245.153[]INFO[]測試

contextFormatter自定義日志格式

Egg-Logger 最新版本支持通過 contextFormatter 函數自定義日志格式，參見之前 PR：support contextFormatter #51

應用也很簡單，通過配置 contextFormatter 函數即可，以下是簡單的應用

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

同樣的在你的業務里對于需要打印日志的地方，和之前一樣

ctx.logger.info("這是一個測試數據");

輸出結果如下所示：

2019-06-04 12:20:10,421[]這是一個測試數據

日志切割

框架提供了 egg-logrotator 中間件，默認切割為按天切割，其它方式可參考官網自行配置。

框架默認日志路徑

egg-logger 模塊 lib/egg/config/config.default.js

config.logger = {
    dir: path.join(appInfo.root, "logs", appInfo.name),
    ...
};

自定義日志目錄

很簡單按照我們的需求在項目配置文件重新定義 logger 的 dir 路徑

config.logger = {
    dir: /var/logs/test/bizLog/
}

這樣是否就可以呢？按照我們上面自定義的日志文件名格式（${projectName}-yyyyMMdd.log），貌似是不行的，在日志分割過程中默認的文件名格式為 .log.YYYY-MM-DD ，參考源碼

https://github.com/eggjs/egg-logrotator/blob/master/app/lib/day_rotator.js

 _setFile(srcPath, files) {
    // don"t rotate logPath in filesRotateBySize
    if (this.filesRotateBySize.indexOf(srcPath) > -1) {
      return;
    }

    // don"t rotate logPath in filesRotateByHour
    if (this.filesRotateByHour.indexOf(srcPath) > -1) {
      return;
    }

    if (!files.has(srcPath)) {
      // allow 2 minutes deviation
      const targetPath = srcPath + moment()
        .subtract(23, "hours")
        .subtract(58, "minutes")
        .format(".YYYY-MM-DD"); // 日志格式定義
      debug("set file %s => %s", srcPath, targetPath);
      files.set(srcPath, { srcPath, targetPath });
    }
 }

日志分割擴展

中間件 egg-logrotator 預留了擴展接口，對于自定義的日志文件名，可以用框架提供的 app.LogRotator 做一個定制。

app/schedule/custom.js

const moment = require("moment");

module.exports = app => {
    const rotator = getRotator(app);

    return {
        schedule: {
            type: "worker", // only one worker run this task
            cron: "1 0 0 * * *", // run every day at 00:00
        },
        async task() {
            await rotator.rotate();
        }
    };
};

function getRotator(app) {
    class CustomRotator extends app.LogRotator {
        async getRotateFiles() {
            const files = new Map();
            const srcPath = `/var/logs/test/bizLog/test.log`;
            const targetPath = `/var/logs/test/bizLog/test-${moment().subtract(1, "days").format("YYYY-MM-DD")}.log`;
            files.set(srcPath, { srcPath, targetPath });
            return files;
        }
    }

    return new CustomRotator({ app });
}

經過分割之后文件展示如下：

$ ls -lh /var/logs/test/bizLog/
total 188K
-rw-r--r-- 1 root root 135K Jun  1 11:00 test-2019-06-01.log
-rw-r--r-- 1 root root  912 Jun  2 09:44 test-2019-06-02.log
-rw-r--r-- 1 root root  40K Jun  3 11:49 test.log

擴展：基于以上日志格式，可以采用 ELK 做日志搜集、分析、檢索。

作者：五月君
鏈接：https://www.imooc.com/article...
來源：慕課網

閱讀推薦

側重于Nodejs服務端技術棧：https://www.nodejs.red

公眾號：Nodejs技術棧

云服務器 GPU云服務器基于webrtc的框架有哪些 linux追蹤日志日志分析最佳實踐基于騰訊云的k8s實踐

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/104452.html

螞蟻金服啟動分布式中間件開源計劃，用于快速構建金融級云原生架構

摘要：在螞蟻金服內部是被所有在線應用的使用的服務調用框架，截止年雙十一，已經被螞蟻多個系統所使用，生產環境發布的服務數量超過了個。原文地址：http://www.sohu.com/a/2288043... 我們很高興地宣布，今天螞蟻金服啟動分布式中間件（Scalable Open Financial Architecture，以下簡稱 SOFA 中間件）的開源計劃！ SOFA 是螞蟻金服自...

frank_fun 2019-06-25 18:38 評論0 收藏0
個推基于Docker和Kubernetes的微服務實踐

摘要：個推針對服務場景，基于和搭建了微服務框架，提高了開發效率。三容器化在微服務落地實踐時我們選擇了，下面將詳細介紹個推基于的實踐。 2016年伊始Docker無比興盛，如今Kubernetes萬人矚目。在這個無比需要創新與速度的時代，由容器、微服務、DevOps構成的云原生席卷整個IT界。個推針對Web服務場景，基于OpenResty和Node.js搭建了微服務框架，提高了開發效率。在微服...

yibinnn 2019-06-28 16:48 評論0 收藏0
個推基于Docker和Kubernetes的微服務實踐

摘要：個推針對服務場景，基于和搭建了微服務框架，提高了開發效率。三容器化在微服務落地實踐時我們選擇了，下面將詳細介紹個推基于的實踐。 2016年伊始Docker無比興盛，如今Kubernetes萬人矚目。在這個無比需要創新與速度的時代，由容器、微服務、DevOps構成的云原生席卷整個IT界。個推針對Web服務場景，基于OpenResty和Node.js搭建了微服務框架，提高了開發效率。在微服...

genefy 2019-07-01 16:52 評論0 收藏0
容器化 — 基于Docker技術容器云

摘要：導讀本文介紹了基于技術的企業級應用容器平臺，從云的定義云服務分類，到用友云基礎平臺平臺總體架構架構預覽部署架構平臺核心價值和核心競爭力，闡述基礎平臺成為廣大傳統企業數字化轉型的一把尖刀。　　導讀：本文介紹了基于Docker技術的企業級應用容器平臺，從云的定義、云服務分類，到用友云PaaS基礎平臺、平臺總體架構、架構預覽、部署架構、平臺核心價值和核心競爭力，闡述PaaS基礎平臺成為廣大...

wapeyang 2019-06-28 16:48 評論0 收藏0