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 相关文章推荐
jQuery EasyUI 中文API Layout(Tabs)
Apr 27 Javascript
Jquery 获取对象的几种方式介绍
Jan 17 Javascript
JavaScript实现简单的二级导航菜单实例
Apr 15 Javascript
HTML5使用DeviceOrientation实现摇一摇功能
Jun 05 Javascript
JS实现的简洁纵向滑动菜单(滑动门)效果
Oct 19 Javascript
JS实现DIV容器赋值的方法
Dec 14 Javascript
jQuery实现多级联动下拉列表查询框
Jan 18 Javascript
利用js的闭包原理做对象封装及调用方法
Apr 07 Javascript
axios进阶实践之利用最优雅的方式写ajax请求
Dec 20 Javascript
vue keep-alive请求数据的方法示例
May 16 Javascript
解决Layui数据表格显示无数据提示的问题
Nov 14 Javascript
详解uniapp的全局变量实现方式
Jan 11 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
php学习笔记 数组遍历实现代码
2011/06/09 PHP
PHP设计模式之工厂模式与单例模式
2016/09/28 PHP
Zend Framework校验器Zend_Validate用法详解
2016/12/09 PHP
javascript编程起步(第二课)
2007/01/10 Javascript
一些不错的js函数ajax
2008/08/20 Javascript
jQuery 操作XML入门
2008/12/25 Javascript
js实现图片在未加载完成前显示加载中字样
2014/09/03 Javascript
javascript引用类型指针的工作方式
2015/04/13 Javascript
JavaScript性能优化总结之加载与执行
2016/08/11 Javascript
JS制作类似选项卡切换的年历
2016/12/03 Javascript
获取当前按钮或者html的ID名称实例(推荐)
2017/06/23 Javascript
带你了解session和cookie作用原理区别和用法
2017/08/14 Javascript
Bootstrap 模态框(Modal)带参数传值实例
2017/08/20 Javascript
JS鼠标3次点击事件实现代码及扩展思路
2017/09/12 Javascript
webpack配置打包后图片路径出错的解决
2018/04/26 Javascript
详解SPA中前端路由基本原理与实现方式
2018/09/12 Javascript
在Bootstrap开发框架中使用dataTable直接录入表格行数据的方法
2018/10/25 Javascript
JavaScript解析JSON数据示例
2019/07/16 Javascript
Python struct.unpack
2008/09/06 Python
Python 2与Python 3版本和编码的对比
2017/02/14 Python
利用Django内置的认证视图实现用户密码重置功能详解
2017/11/24 Python
python selenium 对浏览器标签页进行关闭和切换的方法
2018/05/21 Python
Python切片操作深入详解
2018/07/27 Python
pyqt5 实现在别的窗口弹出进度条
2019/06/18 Python
python 实现方阵的对角线遍历示例
2019/11/29 Python
python实现一个点绕另一个点旋转后的坐标
2019/12/04 Python
Python使用Paramiko控制liunx第三方库
2020/05/20 Python
python爬虫scrapy框架的梨视频案例解析
2021/02/20 Python
香港No.1得奖零食网:香港零食大王
2016/07/22 全球购物
Philosophy美国官网:美国美容品牌
2016/08/15 全球购物
Boden美国官网:英伦原创时装品牌
2017/07/03 全球购物
一些Solaris面试题
2015/12/22 面试题
个人租房协议书(范本)
2014/10/14 职场文书
逃出克隆岛观后感
2015/06/09 职场文书
分布式锁为什么要选择Zookeeper而不是Redis?看完这篇你就明白了
2021/05/21 Redis
ORACLE中dbms_output.put_line输出问题的解决过程
2022/06/28 Oracle