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

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

ccwgpt 2024-09-21 13:37 34 浏览 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 等学习资料。

【领取方式】

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

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

相关推荐

十分钟让你学会LNMP架构负载均衡(impala负载均衡)

业务架构、应用架构、数据架构和技术架构一、几个基本概念1、pv值pv值(pageviews):页面的浏览量概念:一个网站的所有页面,在一天内,被浏览的总次数。(大型网站通常是上千万的级别)2、u...

AGV仓储机器人调度系统架构(agv物流机器人)

系统架构层次划分采用分层模块化设计,分为以下五层:1.1用户接口层功能:提供人机交互界面(Web/桌面端),支持任务下发、实时监控、数据可视化和报警管理。模块:任务管理面板:接收订单(如拣货、...

远程热部署在美团的落地实践(远程热点是什么意思)

Sonic是美团内部研发设计的一款用于热部署的IDEA插件,本文其实现原理及落地的一些技术细节。在阅读本文之前,建议大家先熟悉一下Spring源码、SpringMVC源码、SpringBoot...

springboot搭建xxl-job(分布式任务调度系统)

一、部署xxl-job服务端下载xxl-job源码:https://gitee.com/xuxueli0323/xxl-job二、导入项目、创建xxl_job数据库、修改配置文件为自己的数据库三、启动...

大模型:使用vLLM和Ray分布式部署推理应用

一、vLLM:面向大模型的高效推理框架1.核心特点专为推理优化:专注于大模型(如GPT-3、LLaMA)的高吞吐量、低延迟推理。关键技术:PagedAttention:类似操作系统内存分页管理,将K...

国产开源之光【分布式工作流调度系统】:DolphinScheduler

DolphinScheduler是一个开源的分布式工作流调度系统,旨在帮助用户以可靠、高效和可扩展的方式管理和调度大规模的数据处理工作流。它支持以图形化方式定义和管理工作流,提供了丰富的调度功能和监控...

简单可靠高效的分布式任务队列系统

#记录我的2024#大家好,又见面了,我是GitHub精选君!背景介绍在系统访问量逐渐增大,高并发、分布式系统成为了企业技术架构升级的必由之路。在这样的背景下,异步任务队列扮演着至关重要的角色,...

虚拟服务器之间如何分布式运行?(虚拟服务器部署)

  在云计算和虚拟化技术快速发展的今天,传统“单机单任务”的服务器架构早已难以满足现代业务对高并发、高可用、弹性伸缩和容错容灾的严苛要求。分布式系统应运而生,并成为支撑各类互联网平台、企业信息系统和A...

一文掌握 XXL-Job 的 6 大核心组件

XXL-Job是一个分布式任务调度平台,其核心组件主要包括以下部分,各组件相互协作实现高效的任务调度与管理:1.调度注册中心(RegistryCenter)作用:负责管理调度器(Schedule...

京东大佬问我,SpringBoot中如何做延迟队列?单机与分布式如何做?

京东大佬问我,SpringBoot中如何做延迟队列?单机如何做?分布式如何做呢?并给出案例与代码分析。嗯,用户问的是在SpringBoot中如何实现延迟队列,单机和分布式环境下分别怎么做。这个问题其实...

企业级项目组件选型(一)分布式任务调度平台

官网地址:https://www.xuxueli.com/xxl-job/能力介绍架构图安全性为提升系统安全性,调度中心和执行器进行安全性校验,双方AccessToken匹配才允许通讯;调度中心和执...

python多进程的分布式任务调度应用场景及示例

多进程的分布式任务调度可以应用于以下场景:分布式爬虫:importmultiprocessingimportrequestsdefcrawl(url):response=re...

SpringBoot整合ElasticJob实现分布式任务调度

介绍ElasticJob是面向互联网生态和海量任务的分布式调度解决方案,由两个相互独立的子项目ElasticJob-Lite和ElasticJob-Cloud组成。它通过弹性调度、资源管控、...

分布式可视化 DAG 任务调度系统 Taier 的整体流程分析

Taier作为袋鼠云的开源项目之一,是一个分布式可视化的DAG任务调度系统。旨在降低ETL开发成本,提高大数据平台稳定性,让大数据开发人员可以在Taier直接进行业务逻辑的开发,而不用关...

SpringBoot任务调度:@Scheduled与TaskExecutor全面解析

一、任务调度基础概念1.1什么是任务调度任务调度是指按照预定的时间计划或特定条件自动执行任务的过程。在现代应用开发中,任务调度扮演着至关重要的角色,它使得开发者能够自动化处理周期性任务、定时任务和异...

取消回复欢迎 发表评论: