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 相关文章推荐
Javascript笔记一 js以及json基础使用说明
May 22 Javascript
什么是cookie?js手动创建和存储cookie
May 27 Javascript
jquery中$(#form :input)与$(#form input)的区别
Aug 18 Javascript
jQuery和hwSlider实现内容响应式可触控滑动切换效果附源码下载(二)
Jun 22 Javascript
BootStrap按钮标签及基本样式
Nov 23 Javascript
jquery实现一个全局计时器(商城可用)
Jun 30 jQuery
原生JS实现的碰撞检测功能示例
May 18 Javascript
jQuery实现参数自定义的文字跑马灯效果
Aug 15 jQuery
KOA+egg.js集成kafka消息队列的示例
Nov 09 Javascript
使用React手写一个对话框或模态框的方法示例
Apr 25 Javascript
Vue 解决父组件跳转子路由后当前导航active样式消失问题
Jul 21 Javascript
JS实现扫雷项目总结
May 19 Javascript
详解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
Windows下的PHP安装文件线程安全和非线程安全的区别
2014/04/23 PHP
php版交通银行网银支付接口开发入门教程
2016/09/26 PHP
PHP使用GD库输出汉字的方法【测试可用】
2016/11/10 PHP
JS event使用方法详解
2008/04/28 Javascript
ie 7/8不支持trim的属性的解决方案
2014/05/23 Javascript
JavaScript判断变量是否为空的自定义函数分享
2015/01/31 Javascript
简介JavaScript中的push()方法的使用
2015/06/09 Javascript
jQuery使用$.ajax进行即时验证的方法
2015/12/08 Javascript
谈一谈jQuery核心架构设计
2016/03/28 Javascript
JS延时器提示框的应用实例代码解析
2016/04/27 Javascript
ES2015 Symbol 一种绝不重复的值
2016/12/25 Javascript
vue.js 上传图片实例代码
2017/06/22 Javascript
node跨域请求方法小结
2017/08/25 Javascript
Vue-cli Eslint在vscode里代码自动格式化的方法
2018/02/23 Javascript
elementUI table表格动态合并的示例代码
2019/05/15 Javascript
javascript 对象 与 prototype 原型用法实例分析
2019/11/11 Javascript
js实现一款简单踩白块小游戏(曾经很火)
2019/12/02 Javascript
python中zip和unzip数据的方法
2015/05/27 Python
python中pandas.DataFrame排除特定行方法示例
2017/03/12 Python
python 系统调用的实例详解
2017/07/11 Python
完美解决Pycharm无法导入包的问题 Unresolved reference
2018/05/18 Python
django 快速启动数据库客户端程序的方法示例
2019/08/16 Python
关于pytorch多GPU训练实例与性能对比分析
2019/08/19 Python
python datetime中strptime用法详解
2019/08/29 Python
Python如何输出百分比
2020/07/31 Python
python爬虫智能翻页批量下载文件的实例详解
2021/02/02 Python
整理HTML5移动端开发的常用触摸事件
2016/04/15 HTML / CSS
德国在线订购鲜花:Fleurop
2018/08/25 全球购物
设计师大码女装:11 Honoré
2020/05/03 全球购物
PHP如何删除一个Cookie值
2012/11/15 面试题
大学生专科毕业生自我评价
2013/11/17 职场文书
单位消防安全制度
2014/01/12 职场文书
函授大学生自我鉴定
2014/02/05 职场文书
会计系毕业生求职信
2014/05/28 职场文书
党的群众教育实践活动实施方案
2014/06/12 职场文书
肖申克救赎观后感
2015/06/02 职场文书