Nest.js 实战 (十)：使用 winston 打印和收集日志记录

2024-08-31 09:44
文章标签 实战 使用 日志 记录 js 打印 收集 nest winston

本文主要是介绍Nest.js 实战 (十)：使用 winston 打印和收集日志记录，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

前言

日志记录在后台服务的重要性不言而喻，它可以帮助开发者调试和故障排查、性能监控、审计和安全、监控和警报等。

Nest 附带一个默认的内部日志记录器实现，它在实例化过程中以及在一些不同的情况下使用，比如发生异常等等（例如系统记录）。这由 @nestjs/common 包中的 Logger 类实现。你可以全面控制如下的日志系统的行为：

  1. 完全禁用日志
  2. 指定日志系统详细水平（例如，展示错误，警告，调试信息等）
  3. 覆盖默认日志记录器的时间戳（例如使用 ISO8601 标准作为日期格式）
  4. 完全覆盖默认日志记录器
  5. 通过扩展自定义默认日志记录器
  6. 使用依赖注入来简化编写和测试你的应用

更多高级的日志功能，可以使用任何 Node.js 日志包，比如Winston，来生成一个完全自定义的生产环境水平的日志系统。

今天我们就看看在 Nest 服务中应该如何使用 Winston 记录日志。

Nest 控制台

我们先看一下 Nest 服务原生的控制台输出：
在这里插入图片描述

在接口请求和执行 SQL 的时候，控制台并没有相应的输出信息，这不方便我们排查和调试。

我们需要在服务执行操作的时候，控制台应该输出信息：

  1. 执行 SQL 时，打印 SQL 日志
  2. 调用接口时，打印接口请求日志
  3. 将接口调用时的日志生成保存到指定文件夹中

打印 Prisma 日志

由于我的项目是使用 Prisma 客户端，按照官网文档配置日志记录。

在 PrismaService 中配置：

import { Injectable, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
import { PrismaClient } from '@prisma/client';@Injectable()
export class PrismaService extends PrismaClient implements OnModuleInit, OnModuleDestroy {constructor() {super({log: ['query', 'info', 'warn', 'error'], // 这里设置日志级别});}async onModuleInit() {await this.$connect(); // 在模块初始化时连接到数据库}async onModuleDestroy() {await this.$disconnect(); // 在应用程序关闭时断开与数据库的连}
}

在执行 SQL 时，控制台就会输出信息：
在这里插入图片描述

接口请求日志

Nest 内部自带了 Logger 类，我们创建一个日志中间件：

import { Injectable, Logger, NestMiddleware } from '@nestjs/common';
import dayjs from 'dayjs';
import { NextFunction, Request, Response } from 'express';@Injectable()
export class LoggerMiddleware implements NestMiddleware {private logger = new Logger();use(req: Request, res: Response, next: NextFunction) {// 记录开始时间const start = Date.now();// 获取请求信息const { method, originalUrl, ip, httpVersion, headers } = req;// 获取响应信息const { statusCode } = res;res.on('finish', () => {// 记录结束时间const end = Date.now();// 计算时间差const duration = end - start;// 这里可以根据自己需要组装日志信息：[timestamp] [method] [url] HTTP/[httpVersion] [client IP] [status code] [response time]ms [user-agent]const logFormat = `${dayjs().valueOf()} ${method} ${originalUrl} HTTP/${httpVersion} ${ip} ${statusCode} ${duration}ms ${headers['user-agent']}`;// 根据状态码，进行日志类型区分if (statusCode >= 500) {this.logger.error(logFormat, originalUrl);} else if (statusCode >= 400) {this.logger.warn(logFormat, originalUrl);} else {this.logger.log(logFormat, originalUrl);}});next();}
}

在 AppModule 中全局注册：

import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';import { LoggerMiddleware } from '@/middleware/logger.middleware'; // 全局日志中间件@Module({imports: [],
})
export class AppModule implements NestModule {configure(consumer: MiddlewareConsumer) {consumer.apply(LoggerMiddleware).forRoutes('*');}
}

在接口调用时，控制台就会输出信息：
在这里插入图片描述

Winston 生成日志

我们需要安装几个依赖：

  1. winston：一个通用的日志记录库，为 Node.js 应用提供灵活的日志记录功能
  2. nest-winston: 一个用于 winston 的 Nest 模块包装器
  3. winston-daily-rotate-file: 用于将日志文件按天轮换保存
  4. chalk: 用于在终端中输出带有颜色的文本

终端执行命令：

pnpm add winston nest-winston winston-daily-rotate-file chalk@4

新建 winston 配置文件：

import chalk from 'chalk'; // 用于颜色化输出
import { createLogger, format, transports } from 'winston';
import DailyRotateFile from 'winston-daily-rotate-file';// 定义日志级别颜色
const levelsColors = {error: 'red',warn: 'yellow',info: 'green',debug: 'blue',verbose: 'cyan',
};const winstonLogger = createLogger({format: format.combine(format.timestamp(), format.errors({ stack: true }), format.splat(), format.json()),defaultMeta: { service: 'log-service' },transports: [new DailyRotateFile({filename: 'logs/errors/error-%DATE%.log', // 日志名称，占位符 %DATE% 取值为 datePattern 值。datePattern: 'YYYY-MM-DD', // 日志轮换的频率，此处表示每天。zippedArchive: true, // 是否通过压缩的方式归档被轮换的日志文件。maxSize: '20m', // 设置日志文件的最大大小，m 表示 mb 。maxFiles: '14d', // 保留日志文件的最大天数，此处表示自动删除超过 14 天的日志文件。level: 'error', // 日志类型，此处表示只记录错误日志。}),new DailyRotateFile({filename: 'logs/warnings/warning-%DATE%.log',datePattern: 'YYYY-MM-DD',zippedArchive: true,maxSize: '20m',maxFiles: '14d',level: 'warn',}),new DailyRotateFile({filename: 'logs/app/app-%DATE%.log',datePattern: 'YYYY-MM-DD',zippedArchive: true,maxSize: '20m',maxFiles: '14d',}),new transports.Console({format: format.combine(format.colorize({colors: levelsColors,}),format.simple(),format.printf((info) => {// 获取 Info Symbols keyconst symbols = Object.getOwnPropertySymbols(info);const color = levelsColors[info[symbols[0]]]; // 获取日志级别的颜色const chalkColor = chalk[color];const message = `${chalkColor(info.timestamp)} ${chalkColor(info[symbols[2]])}`;return message;}),),level: 'debug',}),],
});export default winstonLogger;

这里我们按照日志不同级别区分，在 AppModule 配置服务：

import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
import { WinstonModule } from 'nest-winston';import { LoggerMiddleware } from '@/middleware/logger.middleware'; // 全局日志中间件import winstonLogger from './config/winston.config';@Module({imports: [WinstonModule.forRoot({transports: winstonLogger.transports,format: winstonLogger.format,defaultMeta: winstonLogger.defaultMeta,exitOnError: false, // 防止意外退出}),],
})
export class AppModule implements NestModule {configure(consumer: MiddlewareConsumer) {consumer.apply(LoggerMiddleware).forRoutes('*');}
}

在 main.ts 中更换日志记录器：

import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';async function bootstrap() {const app = await NestFactory.create(AppModule);app.useLogger(app.get(WINSTON_MODULE_NEST_PROVIDER));await app.listen(3000);
}
bootstrap();

最终效果

在这里插入图片描述

总结

这里只是简单的日志记录示例，更加高级自定义的日志功能需要自己去探索。

Github 仓库: Vue3 Admin

这篇关于Nest.js 实战 (十)：使用 winston 打印和收集日志记录的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1123553。

相关文章

网页解析 lxml 库--实战

网页解析 lxml 库--实战

lxml库使用流程 lxml 是 Python 的第三方解析库，完全使用 Python 语言编写，它对 XPath表达式提供了良好的支 持，因此能够了高效地解析 HTML/XML 文档。本节讲解如何通过 lxml 库解析 HTML 文档。 pip install lxml lxm| 库提供了一个 etree 模块，该模块专门用来解析 HTML/XML 文档，下面来介绍一下 lxml 库
阅读更多...
JS常用组件收集

JS常用组件收集

收集了一些平时遇到的前端比较优秀的组件，方便以后开发的时候查找！！！ 函数工具： Lodash 页面固定： stickUp、jQuery.Pin 轮播： unslider、swiper 开关: switch 复选框： icheck 气泡： grumble 隐藏元素： Headroom
阅读更多...
中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...
使用SecondaryNameNode恢复NameNode的数据

使用SecondaryNameNode恢复NameNode的数据

1）需求： NameNode进程挂了并且存储的数据也丢失了，如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2）故障模拟 （1）kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 （2）删除NameNode存储的数据（/opt/module/hadoop-3.1.4/data/tmp/dfs/na
阅读更多...
Hadoop数据压缩使用介绍

Hadoop数据压缩使用介绍

一、压缩原则 （1）运算密集型的Job，少用压缩 （2）IO密集型的Job，多用压缩 二、压缩算法比较 三、压缩位置选择 四、压缩参数配置 1）为了支持多种压缩/解压缩算法，Hadoop引入了编码/解码器 2）要在Hadoop中启用压缩，可以配置如下参数
阅读更多...
Makefile简明使用教程

Makefile简明使用教程

文章目录 规则makefile文件的基本语法：加在命令前的特殊符号：.PHONY伪目标: Makefilev1 直观写法v2 加上中间过程v3 伪目标v4 变量 make 选项-f-n-C Make 是一种流行的构建工具，常用于将源代码转换成可执行文件或者其他形式的输出文件(如库文件、文档等)。Make 可以自动化地执行编译、链接等一系列操作。 规则 makefile文件
阅读更多...
性能分析之MySQL索引实战案例

性能分析之MySQL索引实战案例

文章目录 一、前言二、准备三、MySQL索引优化四、MySQL 索引知识回顾五、总结 一、前言 在上一讲性能工具之 JProfiler 简单登录案例分析实战中已经发现SQL没有建立索引问题，本文将一起从代码层去分析为什么没有建立索引？ 开源ERP项目地址：https://gitee.com/jishenghua/JSH_ERP 二、准备 打开IDEA找到登录请求资源路径位置
阅读更多...
使用opencv优化图片（画面变清晰）

使用opencv优化图片（画面变清晰）

文章目录 需求影响照片清晰度的因素 实现降噪测试代码 锐化空间锐化Unsharp Masking频率域锐化对比测试 对比度增强常用算法对比测试 需求 对图像进行优化，使其看起来更清晰，同时保持尺寸不变，通常涉及到图像处理技术如锐化、降噪、对比度增强等 影响照片清晰度的因素 影响照片清晰度的因素有很多，主要可以从以下几个方面来分析 1. 拍摄设备 相机传感器：相机传
阅读更多...
在JS中的设计模式的单例模式、策略模式、代理模式、原型模式浅讲

在JS中的设计模式的单例模式、策略模式、代理模式、原型模式浅讲

1. 单例模式（Singleton Pattern） 确保一个类只有一个实例，并提供一个全局访问点。 示例代码： class Singleton {constructor() {if (Singleton.instance) {return Singleton.instance;}Singleton.instance = this;this.data = [];}addData(value)
阅读更多...
pdfmake生成pdf的使用

pdfmake生成pdf的使用

实际项目中有时会有根据填写的表单数据或者其他格式的数据，将数据自动填充到pdf文件中根据固定模板生成pdf文件的需求 文章目录 利用pdfmake生成pdf文件1.下载安装pdfmake第三方包2.封装生成pdf文件的共用配置3.生成pdf文件的文件模板内容4.调用方法生成pdf 利用pdfmake生成pdf文件 1.下载安装pdfmake第三方包 npm i pdfma
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2