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

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

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

【领取方式】

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

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

相关推荐

Spring WebFlux vs. Spring MVC(springboot是什么)

背景随着异步I/O和Netty等框架的流行,响应式编程逐渐走入大众的视野。但是,响应式编程本身并不是太新的概念,这个术语最早出现在1985年DavidHarel和AmirPnue...

深度解析微服务高并发:适配SpringMVC框架适配模块及实现原理

适配主流框架如果不借助Sentinel提供的适配主流框架的模块,则在使用Sentinel时需要借助try-catchfinally将要保护的资源(方法或代码块)包起来,在目标方法或代码块执行之前,调...

Spring MVC 底层原理深度解析:从请求到响应的全链路拆解

一、Servlet容器与DispatcherServlet的启动博弈1.Tomcat初始化阶段java//Tomcat初始化流程StandardContext#startInterna...

改造总结之传统SpringMVC架构转换为SpringBoot再到集群

改造出发点,是基于现在服务都在向上云的目标前进,传统SpringMVC难以满足项目持续构建、服务节点任意扩展的需求,所以开始了历史项目的改造。项目改造考虑的主要是兼容以前的业务代码,以及session...

SpringBoot3 整合 Spring MVC 全解析:开启高效 Web 开发之旅

在当今的JavaWeb开发领域,Spring框架家族无疑占据着重要的地位。其中,SpringBoot3和SpringMVC更是开发者们构建强大、高效Web应用的得力工具。今天,...

一文读懂SpringMVC(一文读懂!残疾人低保边缘家庭能领的超实用福利政策)

1.SpringMVC定义1.1.MVC定义Model(模型):是应用程序中用于处理应用程序数据逻辑的部分。通常模型对象负责在数据库中存取数据View(视图):是应用程序中处理数据显示的部分。通常...

69 个Spring mvc 全部注解:真实业务使用案例说明(必须收藏)

SpringMVC框架的注解为Web开发提供了一种简洁而强大的声明式方法。从控制器的定义、请求映射、参数绑定到异常处理和响应构建,这些注解涵盖了Web应用程序开发的各个方面。它们不仅简化了编码工作,...

Spring MVC工作原理:像拼积木一样构建Web应用

SpringMVC工作原理:像拼积木一样构建Web应用在Java的Web开发领域,SpringMVC无疑是一个让人又爱又恨的存在。它像一位神通广大的积木搭建大师,将一个个分散的功能模块巧妙地拼接在...

5千字的SpringMVC总结,我觉得你会需要

思维导图文章已收录到我的Github精选,欢迎Star:https://github.com/yehongzhi/learningSummary概述SpringMVC再熟悉不过的框架了,因为现在最火的...

SpringMVC工作原理与优化指南(springmvc工作原理和工作流程)

SpringMVC工作原理与优化指南在现代Java开发中,SpringMVC无疑是构建Web应用程序的首选框架之一。它以其优雅的设计和强大的功能吸引了无数开发者。那么,SpringMVC究竟是如何工作...

Spring MVC框架源码深度剖析:从入门到精通

SpringMVC框架源码深度剖析:从入门到精通SpringMVC框架简介SpringMVC作为Spring框架的一部分,为构建Web应用程序提供了强大且灵活的支持。它遵循MVC(Model-V...

3000字搞明白SpringMVC工作流程、DispatcherServlet类、拦截器!

SpringMVC基础虽然SpringBoot近几年发展迅猛,但是SpringMVC在Web开发领域仍然占有重要的地位。本章主要讲解SpringMVC的核心:DispatcherServlet类...

多年经验大佬用2000字透彻解析SpringMVC的常用注解及相关示例

SpringMVC注解SpringMVC框架提供了大量的注解,如请求注解、参数注解、响应注解及跨域注解等。这些注解提供了解决HTTP请求的方案。本节主要讲解SpringMVC的常用注解及相关示例...

知乎热议:如何成为前端架构师,赚百万年薪?

作者|慕课网精英讲师双越最近有一条知乎热议:从一个前端工程师,如何根据目标,制定计划,才能快速进阶成为前端架构师?不久之前我参与了一次直播,讲到了自己对于Web前端架构师的理解。架构师这个角色...

学习笔记-前端开发架构设计(前端架构设计方案)

前端开发的技术选项主要包含以下几点,下面对一些名词概念的解释做了笔记:1、分层架构:把功能相似,抽象级别相近的实现进行分层隔离优势:松散耦合(易维护,易复用,易扩展)常见分层方式:MVC,MVVM2、...

取消回复欢迎 发表评论: