溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務條款》

如何搭建node服務實現(xiàn)日志處理

發(fā)布時間:2021-11-20 16:36:27 來源:億速云 閱讀:148 作者:小新 欄目:大數(shù)據(jù)

小編給大家分享一下如何搭建node服務實現(xiàn)日志處理,希望大家閱讀完這篇文章之后都有所收獲,下面讓我們一起去探討吧!



一、技術(shù)選型


選擇了  3種主流的技術(shù)進行對比:  
1.1 log4js
log4js是一種node日志管理工具,可以將自定義格式的日志輸出到各種渠道。對于控制臺的日志輸出可以呈現(xiàn)彩色日志,對于文件方式的日志輸出,可以根據(jù)文件大小或者日期進行日志切割。
熟悉java的開發(fā)人員會發(fā)現(xiàn)log4js與一種常用的java日志工具log4j很像。沒錯,log4js是log4j的JavaScript版,使用方式也相似。
1.2 winston
winston也是一種非常流行的node日志管理工具,支持多傳輸。默認輸出格式為json,也可以自定義輸出格式。如果想要對日志進行切割還需要使用 winston-daily-rotate-file 模塊。
1.3 PM2
PM2實際是node進程管理工具,具有性能監(jiān)控、進程守護、負載均衡、日志管理等功能。使用PM2進行日志管理,只需要項目中增加console方法調(diào)用,無需添加額外的代碼。要對日志進行切割,需要使用pm2-logrotate。
由于團隊內(nèi)部服務端系統(tǒng)很多是基于java的,這些系統(tǒng)大部分使用log4j生成日志。日志管理相關(guān)的日志歸集系統(tǒng)和日志查詢系統(tǒng)對log4j格式的日志支持的更好,所以自己最終選用了log4j的JavaScript版log4js來生成日志,下面會對log4js的基本使用進行介紹。

二、基本概念


2.1 日志級別  
 
log4js的默認日志級別分為9級,按優(yōu)先級從低到高排列如下:
ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < MARK < OFF
  • 當日志級別為ALL時,會輸出所有級別的日志 
  • 當日志級別為OFF時,則會關(guān)閉日志,不會有任何日志輸出 
  • 用戶還可以根據(jù)自己的需要自定義日志級別
2.2 appender
appender 主要是用來定義以怎樣的方式輸出,輸出到哪里??梢詫⑷罩緦懭氲轿募?、發(fā)送電子郵件、通過網(wǎng)絡發(fā)送數(shù)據(jù)等??梢酝ㄟ^配置對象的appenders屬性定義多個appender。
appender的常用類型有:
  • console:控制臺輸出 
  • file:文件輸出 
  • dateFile:按日期切割的文件輸出
2.3 category
category 是日志的類型,指定一個或者多個appender為某種類型的日志,不同類型的日志可以指定不同的日志級別??梢酝ㄟ^配置對象的categories屬性定義多個category。必須指定default類型,用來獲取默認的Logger實例,還可以通過類型名來獲取指定類型的Logger實例。
綜上所訴,  appender 定義了日志輸出到哪里,category 將appender 進行了分類,不同類型指定不同的日志級別。

三、使用log4js


3.1 安裝  
 

npm install log4js --save

或者

yarn add log4js

3.2 簡單使用
下面示例利用log4js創(chuàng)建日志對象logger,通過調(diào)用logger.debug、logger.info、logger.warn、logger.error 等方法將日志輸出到控制臺和日志文件。
  • util/log4jsLogger.js
const path = require('path');
const log4js = require('log4js');

// 配置log4js
log4js.configure({
   appenders: {
       // 控制臺輸出
       console: { type: 'console' },
       // 日志文件
       file: { type: 'file', filename: path.join(__dirname, '../../logs/server.log')}
   },
   categories: {
       // 默認日志
       default: { appenders: [ 'file', 'console' ], level: 'debug' },
   }
});

// 獲取默認日志
const logger = log4js.getLogger();

module.exports = logger;
  • server.js

再通過調(diào)用logger. info 輸出INFO 級別的日志,這里web開發(fā)框架使用的Koa。

const Koa = require('koa');
const router = require('./router');
const logger = require('./util/log4jsLogger');

const port = 3000;
const app = new Koa()
   .use(router.routes())
   .use(router.allowedMethods());

app.listen(port, () => {
   logger.info(`Server running on port ${port}`);
});
3.3 日志格式
log4js通過layout 設置日志格式,內(nèi)置的layout有:
  • basic:包含時間戳、日志級別、日志類型的基本日志格式 
  • colored:格式與basic的一致,只是不同級別的日志顯示不同的顏色 
  • dummy:只輸出第一個參數(shù)的內(nèi)容,沒有時間戳、日志級別、日志分類等信息 
  • pattern:可以自定義格式的layout
示例:
默認的日志格式:
[2020-04-01T11:33:43.317] [INFO] default - Server running on port 3000
自定義的日志格式:
2020-04-01 11:33:43.317 [INFO] Server running on port 3000
代碼:
// 自定義日志格式
const layout = {
   type: 'pattern',
   pattern: '%d{yyyy-MM-dd hh:mm:ss.SSS} [%p] %m'
};

log4js.configure({
   appenders: {
       // 控制臺輸出
       console: { type: 'console' },
       // 日志文件,通過設置layout 設置日志格式
       file: { type: 'file', filename: path.join(__dirname, '../../logs/server.log'), layout}
   },
   categories: {
       // 默認日志
       default: { appenders: [ 'file', 'console' ], level: 'debug' },
   }
});
3.4 日志切割
如果日志全部輸出到一個文件,日志文件會越來越大,導致日志的備份和查看都很不方便。通過將appender 指定為 dateFile 類型可以實現(xiàn)按日期將日志進行切割。
// 日志配置
log4js.configure({
   appenders: {
       // 控制臺輸出
       console: { type: 'console' },
       // 日志文件
       file: {
           type: 'dateFile',
           filename: path.join(__dirname, '../../logs/server.log'),
           // 日志切割后文件名后綴格式
           pattern: '.yyyy-MM-dd'
       }
   },
   categories: {
       // 默認日志
       default: { appenders: [ 'file', 'console' ], level: 'debug' },
   }
});
假如4月1日部署的服務,日志會輸出到service.log文件,到4月2日會將service.log更名為server.log.2020-04-01,然后創(chuàng)建新的service.log文件,新的日志將繼續(xù)輸出到service.log文件。
3.5 輸出多個文件
下面示例除了將完整日志輸出到server.log,還會將error及以上級別的日志輸出到server-error.log。
  • util/log4jsLogger.js
const path = require('path');
const log4js = require('log4js');

// 配置log4js
log4js.configure({
   appenders: {
       // 控制臺輸出
       console: { type: 'console' },
       // 全部日志文件
       allFile: { type: 'file', filename: path.join(__dirname, '../../logs/server.log')},
       // 錯誤日志文件
       errorFile: { type: 'file', filename: path.join(__dirname, '../../logs/server-error.log')}
   },
   categories: {
       // 默認日志,輸出debug 及以上級別的日志
       default: { appenders: [ 'allFile', 'console' ], level: 'debug' },
       // 錯誤日志,輸出error 及以上級別的日志
       error: { appenders: [ 'errorFile' ], level: 'error' },
   }
});

// 獲取默認日志
const defaultLogger = log4js.getLogger();
// 獲取錯誤級別日志
const errorLogger = log4js.getLogger('error');

// 日志代理,同時調(diào)用默認日志和錯誤日志
const loggerProxy = {};
const levels = log4js.levels.levels;
levels.forEach(level => {
   const curLevel = level.levelStr.toLowerCase();
   loggerProxy[curLevel] = (...params) => {
       defaultLogger[curLevel](...params);
       errorLogger[curLevel](...params);
   }
});

module.exports = loggerProxy;
3.6 覆蓋console
由于使用log4js需要調(diào)用logger.debug、logger.info、logger.warn、logger.error等方法,對于已經(jīng)調(diào)用console 方法輸出日志的項目,全部改為調(diào)用logger的方法,改動起來很麻煩,可以通過覆蓋console的方法來使用log4js輸出日志。
/**
* 創(chuàng)建日志代理方法
* @param logLevel 日志級別
* @param logger 日志對象
* @return {function}
*/
function createLogProxy (logLevel, logger) {
   return (...param) => {
       logger[logLevel](...param);
   };
}
console.log = createLogProxy('debug', logger);
console.info = createLogProxy('info', logger);
console.warn = createLogProxy('warn', logger);
console.error = createLogProxy('error', logger);
為了保證所有日志都能輸出到日志文件,獲取logger 對象和覆蓋console方法要盡早執(zhí)行。


看完了這篇文章,相信你對“如何搭建node服務實現(xiàn)日志處理”有了一定的了解,如果想了解更多相關(guān)知識,歡迎關(guān)注億速云行業(yè)資訊頻道,感謝各位的閱讀!

向AI問一下細節(jié)

免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI