Koa日志中間件封裝開發(fā)詳解
對于一個服務器應用來說,日志的記錄是必不可少的,我們需要使用其記錄項目程序每天都做了什么,什么時候發(fā)生過錯誤,發(fā)生過什么錯誤等等,便于日后回顧、實時掌握服務器的運行狀態(tài),還原問題場景。
日志的作用
- 記錄服務器程序運行狀態(tài);
- 幫助開發(fā)者快速捕獲錯誤,定位以及決解故障。
日志中間件開發(fā)工具log4js
- 在node當中沒有自帶的日志模塊,所以需要使用第三方模塊
- 使用模塊:log4js
- 安裝:
npm i log4js -S - logsjs官方文檔
- 日志分類:
- 訪問日志: 記錄客戶端對項目的訪問,主要是 http 請求。用于幫助改進和提升網(wǎng)站的性能和用戶體驗;
- 應用日志: 項目標記和記錄位置打印的日志,包括出現(xiàn)異常情況,方便查詢項目的運行狀態(tài)和定位bug(包含了debug、info、warn 和 error等級別)。
日志等級
- 如果配置了日志等級,則其只能記錄日志等級比設置的更高級別的日志信息
- 日志等級圖

如配置level: 'error',則只能輸出error,fatar,mark級別的日志信息
日志中間件開發(fā)
設置需要日志需要記錄的信息段(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'] // 客戶端信息 設備及瀏覽器信息
}
return JSON.stringify(Object.assign(commonInfo, client));
}
設置通用獲取配置后的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
}
}
// 如果為開發(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 || {});
// 取出通用配置(項目名,服務器請求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使用基本配置和流程解析
設置配置項,
// 配置項形式
{
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ù)據(jù)庫日志記錄)
相關(guān)文章
nodejs獲取微信小程序帶參數(shù)二維碼實現(xiàn)代碼
這篇文章主要介紹了nodejs獲取微信小程序帶參數(shù)二維碼實現(xiàn)代碼的相關(guān)資料,需要的朋友可以參考下2017-04-04
Node.js + Redis Sorted Set實現(xiàn)任務隊列
本文給大家分享的是使用Node.js + Redis Sorted Set實現(xiàn)任務隊列的方法示例,非常的實用,有需要的小伙伴可以參考下2016-09-09
Webpack打包構(gòu)建太慢試試這幾個提升打包速度方案
在大型項目開發(fā)中,Webpack打包速度過慢會嚴重影響開發(fā)效率,本文介紹了幾種優(yōu)化Webpack打包速度的策略,包括減少文件搜索范圍、優(yōu)化Loader緩存、并行處理、減少打包體積、開發(fā)模式優(yōu)化以及插件優(yōu)化等,需要的朋友可以參考下2024-11-11

