日志输出

更新: 1/20/2025 字数: 0 字时长: 0 分钟

概述

日志系统是应用程序中不可或缺的组成部分，它能帮助开发人员了解应用程序的运行状态、排查问题和监控系统性能。

本项目使用 Winston 作为日志框架，它是 Node.js 最流行的日志库之一，具有以下优势：

注：本项目内封装的Winston不会覆盖Nest的默认logger，仅在显式调用WinstonLoggerService时使用Winston。

参考

在src/common/logger目录下封装了Winston的日志服务逻辑，并将WinstonLoggerService导出为全局的提供者：

src/common/logger/
├── logger.module.ts       # 日志模块定义
├── winston.config.ts      # Winston配置
└── winston.service.ts     # Winston服务实现

winston.config.ts中定义了Winston的核心配置：

日志文件分类：
- logs/request/%DATE%.log - 记录普通请求日志
- logs/error/%DATE%.log - 记录错误日志
- logs/other/%DATE%.log - 记录其他手动调用的输出日志（如info、warn、debug、verbose）
日志文件特性：
- 按日期自动分割（每天一个文件）
- 超过指定大小（20MB）自动分割
- 自动压缩存档
- 保留14天的日志文件
日志格式定制：
- 包含时间戳
- 日志级别
- 消息内容
- 额外元数据（JSON格式，2空格缩进）
Loki支持（可选）：
- 通过环境配置开启/关闭
- 支持将日志推送到Grafana Loki
- 自动处理连接错误
相关环境配置项(.env.development)：
bash
```
# Loki日志配置
LOKI_ENABLED=false    # 是否启用Loki日志推送
LOKI_HOST=localhost:3100   # Loki服务器地址含端口
LOKI_BASIC_AUTH=     # Loki认证信息 没有认证则留空
```
1
2
3
4
TIP
- 默认不启用Loki日志推送
- 如需使用，请确保已正确部署Grafana Loki服务
- 生产环境请修改为实际的Loki服务地址

winston.service.ts实现了LoggerService接口，提供以下日志级别：

每个方法都支持传入额外的元数据。

logger.module.ts使用@Global()装饰器将日志服务注册为全局模块：

@Global()
@Module({
  providers: [WinstonLoggerService],
  exports: [WinstonLoggerService],
})
export class LoggerModule {}

这样其他模块无需重复导入，直接注入即可使用。

TIP