Koa日志中間件封裝開發(fā)詳解
對于一個服務(wù)器應用來說,日志的記錄是必不可少的,我們需要使用其記錄項目程序每天都做了什么,什么時候發(fā)生過錯誤,發(fā)生過什么錯誤等等,便于日后回顧、實時掌握服務(wù)器的運行狀態(tài),還原問題場景。
日志的作用
- 記錄服務(wù)器程序運行狀態(tài);
- 幫助開發(fā)者快速捕獲錯誤,定位以及決解故障。
日志中間件開發(fā)工具log4js
- 在node當中沒有自帶的日志模塊,所以需要使用第三方模塊
- 使用模塊:log4js
- 安裝:
npm i log4js -S
- logsjs官方文檔
- 日志分類:
- 訪問日志: 記錄客戶端對項目的訪問,主要是 http 請求。用于幫助改進和提升網(wǎng)站的性能和用戶體驗;
- 應用日志: 項目標記和記錄位置打印的日志,包括出現(xiàn)異常情況,方便查詢項目的運行狀態(tài)和定位bug(包含了debug、info、warn 和 error等級別)。
日志等級
- 如果配置了日志等級,則其只能記錄日志等級比設(shè)置的更高級別的日志信息
- 日志等級圖
如配置level: 'error'
,則只能輸出error
,fatar
,mark
級別的日志信息
日志中間件開發(fā)
設(shè)置需要日志需要記錄的信息段(log_info.js)
export default (ctx, message, commonInfo) => { const { method, // 請求方法 url, // 請求鏈接 host, // 發(fā)送請求的客戶端的host headers // 請求中的headers } = ctx.request; const client = { method, url, host, message, referer: headers['referer'], // 請求的源地址 userAgent: headers['user-agent'] // 客戶端信息 設(shè)備及瀏覽器信息 } return JSON.stringify(Object.assign(commonInfo, client)); }
設(shè)置通用獲取配置后的log4js對象(logger.js)
const getLog = ({env, appLogLevel, dir}, name) => { //log4js基本說明配置項,可自定義設(shè)置鍵名,用于categories.appenders自定義選取 let appenders = { // 自定義配置項1 cheese: { type: 'dateFile', //輸出日志類型 filename: `${dir}/task`, //輸出日志路徑 pattern: '-yyyy-MM-dd.log', //日志文件后綴名(task-2019-03-08.log) alwaysIncludePattern: true } } // 如果為開發(fā)環(huán)境配置在控制臺上打印信息 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參數(shù)值先會在categories中找,找不到就會默認使用default對應的appenders,信息會輸出到y(tǒng)yyyMMdd-out.log }
log日志中間件開發(fā)(logger.js)
export default (options) => { const contextLogger = {}; //后期賦值給ctx.log const { env, appLogLevel, dir, serverIp, projectName } = Object.assign({}, baseInfo, options || {}); // 取出通用配置(項目名,服務(wù)器請求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; // 執(zhí)行中間件 await next() // 結(jié)束時間 const responseTime = Date.now() - start; // 將執(zhí)行時間記錄logger.info logger.info(logInfo(ctx, { responseTime: `響應時間為${responseTime/1000}s` }, commonInfo) ) } }
中間件使用(app.js)
import Log from '../log/logger'; ... app.use(Log({ env: app.env, // koa 提供的環(huán)境變量 projectName: 'back-API', appLogLevel: 'debug', dir: 'logs', serverIp: ip.address() }))
其他特殊位置需要日志記錄使用
ctx.log.error(err.stack); //記錄錯誤日志 ctx.log.info(err.stack); // 記錄信息日志 ctx.log.warn(err.stack); // 記錄警告日志 ...
運行截圖
log4js使用基本配置和流程解析
設(shè)置配置項,
// 配置項形式 { appenders:{ [自定義key]:{} }, categories:{ } } // 配置 config: { appenders:{ // 每一個屬性可以看作為一個配置模塊 out: { type: 'dateFile', //輸出日志類型 filename: `log/task`, //輸出日志路徑 pattern: '-yyyy-MM-dd.log', //日志文件后綴名(task-2019-03-08.log) ...//具體配置看官網(wǎng) }, 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'} } }
使用let logger_out = log4js.getLogger('app');
log4js.getLogger('app')
查找特定log4js對象流程:先根據(jù)app參數(shù)值在categories中找,發(fā)現(xiàn)沒有app,然后就會默認使用default對應的appenders進行配置,即信息會輸出到log/task-yyyy-mm-dd.log文件中,并且會輸出到控制臺
使用let logger_out = log4js.getLogger('error');
根據(jù)error參數(shù)值在categories中找,發(fā)現(xiàn)沒有擁有error配置,然后就會使用error對應的appenders進行配置,即信息會輸出到log/error-yyyy-mm-dd.log文件中,因為error的配置項appenders中沒有使用stdout模塊,所以信息不會輸出到控制臺
后期考慮
是否需要對日志進行數(shù)據(jù)庫存儲,進行日志持久化;
考慮到不可能對日志記錄后一直保存,對于一個月或者一周以前的日志可能沒有必要在進行存儲了,需要開發(fā)設(shè)置定時自動刪除過期日志文件(獲數(shù)據(jù)庫日志記錄)
相關(guān)文章
NPM配置私服構(gòu)建內(nèi)網(wǎng)中央倉庫過程詳解
這篇文章主要為大家介紹了NPM配置私服構(gòu)建內(nèi)網(wǎng)中央倉庫過程詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-08-08node版本下報錯build: `vue-cli-service build`問題及解決
這篇文章主要介紹了node版本下報錯build: `vue-cli-service build`問題及解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-01-01在Node.js中使用Express框架和Mongoose庫實現(xiàn)視頻評論功能
本文我們將詳細介紹如何在Node.js應用中使用Express框架和Mongoose庫來實現(xiàn)一個視頻評論功能,這個功能允許用戶對視頻內(nèi)容添加評論,并將評論數(shù)實時更新,以下是逐步的實現(xiàn)過程,包括代碼示例和說明,需要的朋友可以參考下2024-04-04nodejs require js文件入口,在package.json中指定默認入口main方法
今天小編就為大家分享一篇nodejs require js文件入口,在package.json中指定默認入口main方法,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-10-10NodeJs Express框架實現(xiàn)服務(wù)器接口詳解
最近學習了基于前后端分離的開發(fā)模式,我前端使用Vue框架,后端使用nodejs開發(fā)API接口,下面這篇文章主要給大家介紹了關(guān)于nodejs使用Express框架寫后端接口的相關(guān)資料,需要的朋友可以參考下2022-08-08