百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

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

ccwgpt 2024-09-21 13:37 41 浏览 0 评论

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

日志的作用

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

日志中间件开发工具log4js

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

日志等级

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



  • 如配置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); // 记录警告日志
...

运行截图



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/vue/react/angualrde/express/koa/webpack 等学习资料。

【领取方式】

关注头条 前端全栈架构丶第一时间获取最新前端资讯学习

手机用户可私信关键词 【前端】即可获取全栈工程师路线和学习资料!

相关推荐

土豪农村建个别墅不新鲜 建个车库都用框架结构?

农村建房子过去都是没车库,也没有那么多豪车,一般直接停在路边或者院子里。现在很多人都会在建房子的时候留一个车库,通过车库可以直接进入客厅,省得雨雪天气折腾。农村土豪都是有钱任性,建房子跟我们普通人不一...

自建框架结构出现裂缝怎么回事?

三层自建房梁底与墙体连接处裂缝是结构问题吗?去前帮我姑画了一份三层自建房的图纸,前天他们全部装修好了。我姑丈突然打电话给我说他发现二层的梁底与墙分离了,有裂缝。也就是图纸中前面8.3米那跨梁与墙体衔接...

钢结构三维图集-框架结构(钢柱对接)

1、实腹式钢柱对接说明1:1.上节钢柱的安装吊点设置在钢柱的上部,利用四个吊点进行吊装;2.吊装前,下节钢柱顶面和本节钢柱底面的渣土和浮锈要清除干净,保证上下节钢柱对接面接触顶紧;3.钢柱吊装到位后...

三层框架结构主体自建房设计案例!布局13*12米占地面积156平米!

绘创意设计乡村好房子设计小编今日头条带来分享一款:三层框架结构主体自建房设计案例!布局13*12米占地面积156平米!本案例设计亮点:这是一款三层新中式框架结构自建房,占地13×12米,户型占地面积...

Casemaker机箱框架结构3D图纸 STEP格式

农村自建房新宠!半框架结构凭啥这么火?内行人揭开3个扎心真相

回老家闲逛,竟发现个有意思的现象:村里盖新房,十家有八家都选了"半框架结构"。隔壁王叔家那栋刚封顶的二层小楼,外墙红砖还露着糙面没勾缝,里头的水泥柱子倒先支棱得笔直,这到底是啥讲究?蹲...

砖混结构与框架结构!究竟有何区别?千万别被坑!

农村自建房选结构,砖混省钱但出事真能保命吗?7月建材价格波动期,多地建房户因安全焦虑陷入选择困境——框架结构虽贵30%,却是地震区保命的关键。框架柱和梁组成的承重体系,受力分散得像一张网。砖混靠墙硬扛...

砖混结构与框架结构,究竟有何区别?千万别被坑!

农村建房选砖混结构还是框架结构?这个问题算是近期留言板里问得最多的问题了。今天咱们说说二者的区别,帮您选个合适的。01成本区别假如盖一栋砖混结构的房子需要30万,那么换成框架结构,一般要多掏30%的费...

6个小众却逆天的App神器,个个都是黑科技的代表

你的手机上有哪些好用的软件?今天我就给大家分享6个小众却逆天的App神器,个个都是黑科技的代表!01*Via浏览器推荐理由:体积极小的浏览器,没有任何广告。使用感受:它的体量真的很小,只有702KB,...

合肥App开发做一个app需要多少钱?制作周期有多久?

在移动互联网时代,开发一款APP已成为企业数字化转型与个人创业的重要途径。然而,APP的开发成本与制作周期受功能复杂度、技术架构、团队类型等多重因素影响,差异极大。好牛软件将从这两个维度展开分析,帮助...

详解应对App臃肿化的五大法则

编者注:本文转自腾讯ISUX。先来看一张图:图上看到,所有平台上用户花费时间都在减少,除了移动端。观察身边也是如此,回家不开电脑的小伙伴越来越多。手机平板加电视,下班场景全搞定。连那些以前电脑苦手的...

实战!如何从零搭建10万级 QPS 大流量、高并发优惠券系统

需求背景春节活动中,多个业务方都有发放优惠券的需求,且对发券的QPS量级有明确的需求。所有的优惠券发放、核销、查询都需要一个新系统来承载。因此,我们需要设计、开发一个能够支持十万级QPS的券系...

8种移动APP导航设计模式大对比

当我们确定了移动APP的设计需求和APP产品设计流程之后,开始着手设计APP界面UI或是APP原型图啦。这个时候我们都要面临的第一个问题就是如何将信息以最优的方式组合起来?也许我们对比和了解了其他一些...

数字资产支付 App 的技术框架

开发一款功能强大、安全可靠的数字资产支付App需要一个整合了区块链技术、后端服务、前端应用以及第三方集成的全栈技术框架。这个框架的核心在于保障数字资产的安全流通,并将其高效地桥接到传统的法币支付场...

从MyBatis到App架构:设计模式全景应用指南

从MyBatis到App架构:设计模式全景应用指南引言在企业级应用和服务端开发领域,MyBatis凭借其灵活、简洁、强大的ORM映射能力被广泛应用。而它之所以能拥有如此优秀的可扩展性和工程可维护性,正...

取消回复欢迎 发表评论: