Koa日誌中介軟體封裝開發

keywords發表於2019-03-08
封裝

Koa日誌中介軟體開發封裝

對於一個伺服器應用來說，日誌的記錄是必不可少的，我們需要使用其記錄專案程式每天都做了什麼，什麼時候發生過錯誤，發生過什麼錯誤等等，便於日後回顧、實時掌握伺服器的執行狀態，還原問題場景。

日誌的作用

  1. 記錄伺服器程式執行狀態；
  2. 幫助開發者快速捕獲錯誤，定位以及決解故障。

日誌中介軟體開發工具log4js

  • 在node當中沒有自帶的日誌模組，所以需要使用第三方模組
  1. 使用模組：log4js
  2. 安裝： npm i log4js -S
  3. logsjs官方文件

  4. 日誌分類:

    • 訪問日誌: 記錄客戶端對專案的訪問，主要是 http 請求。用於幫助改進和提升網站的效能和使用者體驗；
    • 應用日誌： 專案標記和記錄位置列印的日誌，包括出現異常情況，方便查詢專案的執行狀態和定位bug（包含了debug、info、warn 和 error等級別）。

日誌等級

  • 如果配置了日誌等級，則其只能記錄日誌等級比設定的更高階別的日誌資訊
  • 日誌等級圖

clipboard.png

  • 如配置level: 'error',則只能輸出error,fatar,mark級別的日誌資訊

日誌中介軟體開發

  1. 設定需要日誌需要記錄的資訊段(log_info.js)
export default (ctx, message, commonInfo) => {
    const {
      method,  // 請求方法
      url,          // 請求連結
      host,      // 傳送請求的客戶端的host
      headers      // 請求中的headers
    } = ctx.request;
    const client = {
      method,
      url,
      host,
      message,
      referer: headers['referer'],  // 請求的源地址
      userAgent: headers['user-agent']  // 客戶端資訊 裝置及瀏覽器資訊
    }
    return JSON.stringify(Object.assign(commonInfo, client));
}
  1. 設定通用獲取配置後的log4js物件（logger.js）
const getLog = ({env, appLogLevel, dir}, name) => {
    
    //log4js基本說明配置項，可自定義設定鍵名，用於categories.appenders自定義選取
    let appenders = {
        // 自定義配置項1
        cheese: {
            type: 'dateFile', //輸出日誌型別
            filename: `${dir}/task`,  //輸出日誌路徑
            pattern: '-yyyy-MM-dd.log', //日誌檔案字尾名（task-2019-03-08.log）
            alwaysIncludePattern: true
        }
    }
    // 如果為開發環境配置在控制檯上列印資訊
    if (env === "dev" || env === "local" || env === "development") {
        // 自定義配置項2
        appenders.out = {
          type: "stdout"
        }
    }
    // log4js配置
    let config = {
        appenders,
        //作為getLogger方法獲取log物件的鍵名，default為預設使用
        categories: {
          default: {
            appenders: Object.keys(appenders), // 取appenders中的說有配置項
            level: appLogLevel
          }
        }
    }
    log4js.configure(config) //使用配置項
    return log4js.getLogger(name)// 這個cheese引數值先會在categories中找，找不到就會預設使用default對應的appenders,資訊會輸出到yyyyMMdd-out.log
}
  1. log日誌中介軟體開發（logger.js）
export default (options) => {
    const contextLogger = {}; //後期賦值給ctx.log
    const { env, appLogLevel, dir, serverIp, projectName } = Object.assign({}, baseInfo, options || {});
    // 取出通用配置（專案名，伺服器請求IP）
    const commonInfo = { projectName, serverIp };

    const logger = getLog({env, appLogLevel, dir},'cheese');

    return async (ctx, next) => {
        const start = Date.now(); //日誌記錄開始時間
        // 將日誌型別賦值ctx.log，後期中介軟體特殊位置需要記錄日誌，可直接使用ctx.log.error(err)記錄不同型別日誌
        methods.forEach((method, i) => {
            contextLogger[method] = (message) => {
                logger[method](logInfo(ctx, message, commonInfo))
            }
        })
        ctx.log = contextLogger;
        // 執行中介軟體
        await next()
        // 結束時間
        const responseTime = Date.now() - start;
        // 將執行時間記錄logger.info
        logger.info(logInfo(ctx,
            {
                responseTime: `響應時間為${responseTime/1000}s`
            }, commonInfo)
        )
    }
}
  1. 中介軟體使用（app.js）
import Log from '../log/logger';
...
app.use(Log({
        env: app.env,  // koa 提供的環境變數
        projectName: 'back-API',
        appLogLevel: 'debug',
        dir: 'logs',
        serverIp: ip.address()
    }))
  1. 其他特殊位置需要日誌記錄使用
ctx.log.error(err.stack); //記錄錯誤日誌
ctx.log.info(err.stack); // 記錄資訊日誌
ctx.log.warn(err.stack); // 記錄警告日誌
...
  1. 執行截圖

clipboard.png

log4js使用基本配置和流程解析

  1. 設定配置項,
// 配置項形式
{
    appenders:{
        [自定義key]:{}
    },
    categories:{
    }
}
// 配置
config: {
    appenders:{
        // 每一個屬性可以看作為一個配置模組
        out: {
            type: 'dateFile', //輸出日誌型別
            filename: `log/task`,  //輸出日誌路徑
            pattern: '-yyyy-MM-dd.log', //日誌檔案字尾名（task-2019-03-08.log）
            ...//具體配置看官網
        },
        error: {
            type: 'dateFile',
            filename: 'log/error',
            pattern: '-yyyy-MM-dd.log'',
            "alwaysIncludePattern": true
        },
        stdout: { type: 'stdout' }, //在控制檯上列印資訊
    },
    // 通過categories來取出給log4js按需配置，返回配置後的log4js物件，每個屬性配置相當於一個不同的log4js配置物件入口；default為預設入口（getLogger（）找不到入口時預設使用default）
    categories:{
        // 配置預設入口，使用appenders中的'stdout','out'配置模組，記錄trace以上等級日誌
        default: { appenders: ['stdout','out'], level: 'trace' },
        // 配置error門入口，使用appenders中的'stdout','err'配置模組，記錄error以上等級日誌
        error : {appenders: ['err'], level: 'error'}
    }
}

  1. 使用let logger_out = log4js.getLogger('app');

    • log4js.getLogger('app')查詢特定log4js物件流程：先根據app引數值在categories中找，發現沒有app，然後就會預設使用default對應的appenders進行配置,即資訊會輸出到log/task-yyyy-mm-dd.log檔案中，並且會輸出到控制檯

  2. 使用let logger_out = log4js.getLogger('error');

    • 根據error引數值在categories中找，發現沒有擁有error配置，然後就會使用error對應的appenders進行配置,即資訊會輸出到log/error-yyyy-mm-dd.log檔案中，因為error的配置項appenders中沒有使用stdout模組，所以資訊不會輸出到控制檯

後期考慮

  1. 是否需要對日誌進行資料庫儲存，進行日誌持久化；
  2. 考慮到不可能對日誌記錄後一直儲存，對於一個月或者一週以前的日誌可能沒有必要在進行儲存了，需要開發設定定時自動刪除過期日誌檔案（獲資料庫日誌記錄）
學無止境，積累點滴；把小簡單變成大簡單。
  • 如果這篇文章對你有所收穫，請留在你的小心心！
  • 往期文章推薦：
  1. React你知多少
  2. Git常用操作

相關文章