Koa日志中间件封装开发详解


Posted in Javascript onMarch 09, 2019

对于一个服务器应用来说,日志的记录是必不可少的,我们需要使用其记录项目程序每天都做了什么,什么时候发生过错误,发生过什么错误等等,便于日后回顾、实时掌握服务器的运行状态,还原问题场景。

日志的作用

  • 记录服务器程序运行状态;
  • 帮助开发者快速捕获错误,定位以及决解故障。

日志中间件开发工具log4js

  1. 在node当中没有自带的日志模块,所以需要使用第三方模块
  2. 使用模块:log4js
  3. 安装: npm i log4js -S
  4. logsjs官方文档
  5. 日志分类:
    1. 访问日志: 记录客户端对项目的访问,主要是 http 请求。用于帮助改进和提升网站的性能和用户体验;
    2. 应用日志: 项目标记和记录位置打印的日志,包括出现异常情况,方便查询项目的运行状态和定位bug(包含了debug、info、warn 和 error等级别)。

日志等级

  • 如果配置了日志等级,则其只能记录日志等级比设置的更高级别的日志信息
  • 日志等级图

Koa日志中间件封装开发详解

如配置level: 'error',则只能输出error,fatar,mark级别的日志信息

日志中间件开发

设置需要日志需要记录的信息段(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));
}

设置通用获取配置后的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
}

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)
    )
  }
}

中间件使用(app.js)

import Log from '../log/logger';
...
app.use(Log({
    env: app.env, // koa 提供的环境变量
    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); // 记录警告日志
...

运行截图

Koa日志中间件封装开发详解

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

设置配置项,

// 配置项形式
{
  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'}
  }
}

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

log4js.getLogger('app')查找特定log4js对象流程:先根据app参数值在categories中找,发现没有app,然后就会默认使用default对应的appenders进行配置,即信息会输出到log/task-yyyy-mm-dd.log文件中,并且会输出到控制台

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

根据error参数值在categories中找,发现没有拥有error配置,然后就会使用error对应的appenders进行配置,即信息会输出到log/error-yyyy-mm-dd.log文件中,因为error的配置项appenders中没有使用stdout模块,所以信息不会输出到控制台

后期考虑

是否需要对日志进行数据库存储,进行日志持久化;

考虑到不可能对日志记录后一直保存,对于一个月或者一周以前的日志可能没有必要在进行存储了,需要开发设置定时自动删除过期日志文件(获数据库日志记录)

Javascript 相关文章推荐
JSON扫盲帖 JSON.as类教程
Feb 16 Javascript
javascript 写类方式之十
Jul 05 Javascript
javascript 浏览器判断 绑定事件 arguments 转换数组 数组遍历
Jul 06 Javascript
js removeChild 障眼法 可能出现的错误
Oct 06 Javascript
JS验证控制输入中英文字节长度(input、textarea等)具体实例
Jun 21 Javascript
jquery和javascript中如何将一元素的内容赋给另一元素
Jan 09 Javascript
jQuery的图片滑块焦点图插件整理推荐
Dec 07 Javascript
Javascript模拟加速运动与减速运动代码分享
Dec 11 Javascript
原生JS和JQuery动态添加、删除表格行的方法
May 28 Javascript
json实现添加、遍历与删除属性的方法
Jun 17 Javascript
AngularJS基础 ng-hide 指令用法及示例代码
Aug 01 Javascript
jquery实现回车键触发事件(实例讲解)
Nov 21 jQuery
详解vue2.6插槽更新v-slot用法总结
Mar 09 #Javascript
Node.js Stream ondata触发时机与顺序的探索
Mar 08 #Javascript
详解JSON和JSONP劫持以及解决方法
Mar 08 #Javascript
Node.js Event Loop各阶段讲解
Mar 08 #Javascript
vue基础之data存储数据及v-for循环用法示例
Mar 08 #Javascript
vue.js使用v-model实现表单元素(input) 双向数据绑定功能示例
Mar 08 #Javascript
JavaScript解析机制与闭包原理实例详解
Mar 08 #Javascript
You might like
一个oracle+PHP的查询的例子
2006/10/09 PHP
如何使用纯PHP实现定时器任务(Timer)
2015/07/31 PHP
WordPress中使主题支持小工具以及添加插件启用函数
2015/12/22 PHP
PHP之header函数详解
2021/03/02 PHP
通过下拉框的值来确定输入框是否可以为空的代码
2011/10/18 Javascript
jQuery.extend 函数的详细用法
2012/06/27 Javascript
jquery 单引号和双引号的区别及使用注意
2013/07/31 Javascript
JS、CSS加载中的小问题探讨
2013/11/26 Javascript
js通过元素class名字获取元素集合的具体实现
2014/01/06 Javascript
js阻止事件追加的具体实现
2014/10/15 Javascript
JS实现文件动态顺序载入的方法
2015/03/07 Javascript
JavaScript学习笔记整理_用于模式匹配的String方法
2016/09/19 Javascript
vue-cli中打包图片路径错误的解决方法
2017/10/26 Javascript
解决Linux无法正常安装与卸载Node.js的方法
2018/01/19 Javascript
js数组去重的N种方法(小结)
2018/06/07 Javascript
详解Axios 如何取消已发送的请求
2018/10/20 Javascript
[00:50]深扒TI7聊天轮盘语音出处6
2017/05/11 DOTA
[55:32]2018DOTA2亚洲邀请赛 4.4 淘汰赛 EG vs LGD 第二场
2018/04/05 DOTA
在Python的setuptools框架下生成egg的教程
2015/04/13 Python
Python异常处理操作实例详解
2018/08/28 Python
python标记语句块使用方法总结
2019/08/05 Python
python 并发下载器实现方法示例
2019/11/22 Python
Python3实现将一维数组按标准长度分隔为二维数组
2019/11/29 Python
Python如何将模块打包并发布
2020/08/30 Python
澳大利亚宠物商店:Petbarn
2017/11/18 全球购物
JD Sports芬兰:英国领先的运动鞋和运动服饰零售商
2018/11/16 全球购物
北京华建集团SQL面试题
2014/06/03 面试题
缅怀革命先烈演讲稿
2014/05/14 职场文书
国庆节演讲稿
2014/05/27 职场文书
党的群众路线教育实践活动宣传标语口号
2014/06/06 职场文书
学校交通安全责任书
2014/08/25 职场文书
小兵张嘎观后感300字
2015/06/03 职场文书
汽车车尾标语大全
2015/08/11 职场文书
python文件目录操作之os模块
2021/05/08 Python
解决Mysql中的innoDB幻读问题
2022/04/29 MySQL
Win11如何查看显卡型号 Win11查看显卡型号的方法
2022/08/14 数码科技