使用koa-log4玩轉nodeJs日誌管理

前言

對於後端程序應用來說，日誌是必不可少的，在nodeJs當中並沒有自帶的日誌模塊。最近正好使用koa框架來做後端服務，需要對日誌進行分割處理，特記錄下分享給大家。

一.後端代碼目錄結構

├── back-end
│ ├── logs 所有產生的日誌文件存放在此目錄下
│ ├── db.js 使用Sequelize連接數據庫
│ ├── logger.js 日誌的配置
│ ├── server.js 後端提供的所有接口

二.引用日誌模塊

log4js-node是一款比較好的在node環境下對於日誌處理的模塊，由於我的整個項目是基於koa框架，所以我選擇了koa-log4模塊。
koa-log4在log4js-node的基礎上做了一次包裝，是koa的一個處理日誌的中間件，此模塊可以幫助你按照你配置的規則分叉日誌消息。

三.日誌配置logger.js

koa-log4的配置與log4js-node是一樣的。

const path = require('path');
const log4js = require('koa-log4');

log4js.configure({
  appenders: {
    access: {
      type: 'dateFile',
      pattern: '-yyyy-MM-dd.log', //生成文件的規則
      filename: path.join('back-end/logs/', 'access.log') //生成文件名
    },
    application: {
      type: 'dateFile',
      pattern: '-yyyy-MM-dd.log',
      filename: path.join('back-end/logs/', 'application.log')
    },
    out: {
      type: 'console'
    }
  },
  categories: {
    default: { appenders: [ 'out' ], level: 'info' },
    access: { appenders: [ 'access' ], level: 'info' },
    application: { appenders: [ 'application' ], level: 'WARN'}
  }
});

exports.accessLogger = () => log4js.koaLogger(log4js.getLogger('access')); //記錄所有訪問級別的日誌
exports.logger = log4js.getLogger('application');  //記錄所有應用級別的日誌

四.日誌的使用方法

• 1.訪問日誌

對於日誌的使用，訪問級別的，記錄用戶的所有請求，作爲koa的中間件，直接使用便可，如下：

const Koa = require('koa');
const KoaRouter = require('koa-router');
const app = new Koa();
const router = new KoaRouter();
const { logger, accessLogger } = require('./logger');
const router = new KoaRouter();

app.use(accessLogger());

• 2.應用日誌

應用級別的日誌，可記錄全局狀態下的error,也可記錄接口請求當中的錯誤處理。

捕獲全局狀態下的error

app.on('error', err => {
  logger.error(err);
});

接口請求錯誤

router.post('/test',async (ctx, next)=>{
 //處理代碼
  }catch(e){
    logger.error(e);
    ctx.body = {status:-1, message:e.message};
  }
});

五.自動生成日誌

開啓node應用對於每一次的請求，都將按日期來生成日誌文件，以下是我這幾天自動生成的日誌文件

六.日誌內容分析

日誌文件當中都有詳細的記錄

寫文章不容易，希望大家多多支持和關注！