Compare commits
3 Commits
398fbc42bc
...
f980e40fb0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f980e40fb0 | ||
|
|
5353a956d1 | ||
|
|
c6ca204fae |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -14,6 +14,8 @@ build/
|
||||
|
||||
# 日志
|
||||
*.log
|
||||
*.log.gz
|
||||
logs/
|
||||
pnpm-debug.log*
|
||||
|
||||
# 操作系统
|
||||
|
||||
363
docs/日志系统详细说明.md
Normal file
363
docs/日志系统详细说明.md
Normal file
@@ -0,0 +1,363 @@
|
||||
# 日志系统详细说明
|
||||
|
||||
## 📋 概述
|
||||
|
||||
本项目的日志系统基于 Pino 高性能日志库构建,提供完整的日志记录、管理和分析功能。
|
||||
|
||||
---
|
||||
|
||||
## 🗂️ 日志文件结构
|
||||
|
||||
### 开发环境 (`NODE_ENV=development`)
|
||||
|
||||
```
|
||||
logs/
|
||||
└── dev.log # 开发环境综合日志(所有级别)
|
||||
```
|
||||
|
||||
**输出方式:**
|
||||
- 🖥️ **控制台**:彩色美化输出,便于开发调试
|
||||
- 📁 **文件**:保存到 `logs/dev.log`,便于问题追踪
|
||||
|
||||
### 生产环境 (`NODE_ENV=production`)
|
||||
|
||||
```
|
||||
logs/
|
||||
├── app.log # 应用综合日志(info及以上级别)
|
||||
├── error.log # 错误日志(error和fatal级别)
|
||||
├── access.log # HTTP访问日志(请求响应记录)
|
||||
├── app.log.gz # 压缩的历史日志文件
|
||||
├── error.log.gz # 压缩的历史错误日志
|
||||
└── access.log.gz # 压缩的历史访问日志
|
||||
```
|
||||
|
||||
**输出方式:**
|
||||
- 📁 **文件**:分类保存到不同的日志文件
|
||||
- 🖥️ **控制台**:仅输出 warn 及以上级别(用于容器日志收集)
|
||||
|
||||
---
|
||||
|
||||
## 📊 日志级别和用途
|
||||
|
||||
| 级别 | 数值 | 用途 | 保存位置 | 示例场景 |
|
||||
|------|------|------|----------|----------|
|
||||
| **TRACE** | 10 | 极细粒度调试 | dev.log | 循环内变量状态 |
|
||||
| **DEBUG** | 20 | 开发调试信息 | dev.log | 方法调用参数 |
|
||||
| **INFO** | 30 | 重要业务操作 | app.log, dev.log | 用户登录成功 |
|
||||
| **WARN** | 40 | 警告信息 | app.log, dev.log, 控制台 | 参数验证失败 |
|
||||
| **ERROR** | 50 | 错误信息 | error.log, app.log, 控制台 | 数据库连接失败 |
|
||||
| **FATAL** | 60 | 致命错误 | error.log, app.log, 控制台 | 系统不可用 |
|
||||
|
||||
---
|
||||
|
||||
## 🔄 日志轮转和管理
|
||||
|
||||
### 自动轮转策略
|
||||
|
||||
| 文件类型 | 轮转频率 | 文件大小限制 | 保留时间 | 压缩策略 |
|
||||
|----------|----------|--------------|----------|----------|
|
||||
| **app.log** | 每日 | 10MB | 7天 | 7天后压缩 |
|
||||
| **error.log** | 每日 | 10MB | 30天 | 7天后压缩 |
|
||||
| **access.log** | 每日 | 50MB | 14天 | 7天后压缩 |
|
||||
| **dev.log** | 手动 | 无限制 | 无限制 | 不压缩 |
|
||||
|
||||
### 定时任务
|
||||
|
||||
| 任务 | 执行时间 | 功能 |
|
||||
|------|----------|------|
|
||||
| **日志清理** | 每天 02:00 | 删除过期日志文件 |
|
||||
| **日志压缩** | 每周日 03:00 | 压缩7天前的日志文件 |
|
||||
| **健康监控** | 每小时 | 监控日志系统状态 |
|
||||
| **统计报告** | 每天 09:00 | 输出日志统计信息 |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 如何使用日志系统
|
||||
|
||||
### 基本使用
|
||||
|
||||
```typescript
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { AppLoggerService } from '../core/utils/logger/logger.service';
|
||||
|
||||
@Injectable()
|
||||
export class UserService {
|
||||
constructor(private readonly logger: AppLoggerService) {}
|
||||
|
||||
async createUser(userData: CreateUserDto) {
|
||||
// 记录操作开始
|
||||
this.logger.info('开始创建用户', {
|
||||
operation: 'createUser',
|
||||
email: userData.email,
|
||||
timestamp: new Date().toISOString()
|
||||
});
|
||||
|
||||
try {
|
||||
const user = await this.userRepository.save(userData);
|
||||
|
||||
// 记录成功操作
|
||||
this.logger.info('用户创建成功', {
|
||||
operation: 'createUser',
|
||||
userId: user.id,
|
||||
email: userData.email,
|
||||
duration: Date.now() - startTime
|
||||
});
|
||||
|
||||
return user;
|
||||
} catch (error) {
|
||||
// 记录错误
|
||||
this.logger.error('用户创建失败', {
|
||||
operation: 'createUser',
|
||||
email: userData.email,
|
||||
error: error.message
|
||||
}, error.stack);
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 请求上下文绑定
|
||||
|
||||
```typescript
|
||||
@Controller('users')
|
||||
export class UserController {
|
||||
constructor(private readonly logger: AppLoggerService) {}
|
||||
|
||||
@Get(':id')
|
||||
async getUser(@Param('id') id: string, @Req() req: Request) {
|
||||
// 绑定请求上下文
|
||||
const requestLogger = this.logger.bindRequest(req, 'UserController');
|
||||
|
||||
requestLogger.info('开始获取用户信息', { userId: id });
|
||||
|
||||
try {
|
||||
const user = await this.userService.findById(id);
|
||||
requestLogger.info('用户信息获取成功', { userId: id });
|
||||
return user;
|
||||
} catch (error) {
|
||||
requestLogger.error('用户信息获取失败', error.stack, {
|
||||
userId: id,
|
||||
reason: error.message
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔍 日志格式详解
|
||||
|
||||
### 开发环境日志格式
|
||||
|
||||
```
|
||||
🕐 2024-12-13 14:30:25 📝 INFO pixel-game-server [UserService] 用户创建成功
|
||||
operation: "createUser"
|
||||
userId: "user_123"
|
||||
email: "user@example.com"
|
||||
duration: 45
|
||||
```
|
||||
|
||||
### 生产环境日志格式 (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"level": 30,
|
||||
"time": 1702456225000,
|
||||
"pid": 12345,
|
||||
"hostname": "server-01",
|
||||
"app": "pixel-game-server",
|
||||
"version": "1.0.0",
|
||||
"msg": "用户创建成功",
|
||||
"operation": "createUser",
|
||||
"userId": "user_123",
|
||||
"email": "user@example.com",
|
||||
"duration": 45,
|
||||
"reqId": "req_1702456225_abc123"
|
||||
}
|
||||
```
|
||||
|
||||
### HTTP 请求日志格式
|
||||
|
||||
```json
|
||||
{
|
||||
"level": 30,
|
||||
"time": 1702456225000,
|
||||
"req": {
|
||||
"id": "req_1702456225_abc123",
|
||||
"method": "POST",
|
||||
"url": "/api/users",
|
||||
"headers": {
|
||||
"host": "localhost:3000",
|
||||
"user-agent": "Mozilla/5.0...",
|
||||
"content-type": "application/json"
|
||||
},
|
||||
"ip": "127.0.0.1"
|
||||
},
|
||||
"res": {
|
||||
"statusCode": 201,
|
||||
"responseTime": 45
|
||||
},
|
||||
"msg": "POST /api/users completed in 45ms"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ 问题排查指南
|
||||
|
||||
### 1. 如何查找特定用户的操作日志?
|
||||
|
||||
```bash
|
||||
# 在日志文件中搜索特定用户ID
|
||||
grep "userId.*user_123" logs/app.log
|
||||
|
||||
# 搜索特定操作
|
||||
grep "operation.*createUser" logs/app.log
|
||||
|
||||
# 搜索特定时间段的日志
|
||||
grep "2024-12-13 14:" logs/app.log
|
||||
```
|
||||
|
||||
### 2. 如何查找错误日志?
|
||||
|
||||
```bash
|
||||
# 查看所有错误日志
|
||||
cat logs/error.log
|
||||
|
||||
# 查看最近的错误
|
||||
tail -f logs/error.log
|
||||
|
||||
# 搜索特定错误
|
||||
grep "数据库连接失败" logs/error.log
|
||||
```
|
||||
|
||||
### 3. 如何分析性能问题?
|
||||
|
||||
```bash
|
||||
# 查找响应时间超过1000ms的请求
|
||||
grep "responseTime.*[0-9][0-9][0-9][0-9]" logs/access.log
|
||||
|
||||
# 查找特定接口的性能数据
|
||||
grep "POST /api/users" logs/access.log | grep responseTime
|
||||
```
|
||||
|
||||
### 4. 如何监控系统健康状态?
|
||||
|
||||
```bash
|
||||
# 查看日志统计信息
|
||||
grep "日志系统健康状态报告" logs/app.log
|
||||
|
||||
# 查看日志清理记录
|
||||
grep "日志清理任务完成" logs/app.log
|
||||
|
||||
# 查看压缩记录
|
||||
grep "日志压缩任务完成" logs/app.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📈 日志分析和监控
|
||||
|
||||
### 日志统计信息
|
||||
|
||||
系统会自动收集以下统计信息:
|
||||
|
||||
- **文件数量**:当前日志文件总数
|
||||
- **总大小**:所有日志文件占用的磁盘空间
|
||||
- **错误日志数量**:错误级别日志文件数量
|
||||
- **最旧/最新文件**:日志文件的时间范围
|
||||
- **平均文件大小**:单个日志文件的平均大小
|
||||
|
||||
### 健康监控告警
|
||||
|
||||
系统会在以下情况发出警告:
|
||||
|
||||
- 📊 **磁盘空间告警**:日志文件总大小超过阈值
|
||||
- ⚠️ **错误日志告警**:错误日志数量异常增长
|
||||
- 🔧 **清理失败告警**:日志清理任务执行失败
|
||||
- 💾 **压缩失败告警**:日志压缩任务执行失败
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ 配置说明
|
||||
|
||||
### 环境变量配置
|
||||
|
||||
```bash
|
||||
# 应用名称
|
||||
APP_NAME=pixel-game-server
|
||||
|
||||
# 环境标识
|
||||
NODE_ENV=development
|
||||
|
||||
# 日志级别
|
||||
LOG_LEVEL=debug
|
||||
|
||||
# 日志目录
|
||||
LOG_DIR=./logs
|
||||
|
||||
# 日志保留天数
|
||||
LOG_MAX_FILES=7d
|
||||
|
||||
# 单个日志文件最大大小
|
||||
LOG_MAX_SIZE=10m
|
||||
```
|
||||
|
||||
### 高级配置选项
|
||||
|
||||
如需自定义日志配置,可以修改 `src/core/utils/logger/logger.config.ts`:
|
||||
|
||||
```typescript
|
||||
// 自定义日志轮转策略
|
||||
{
|
||||
target: 'pino-roll',
|
||||
options: {
|
||||
file: path.join(logDir, 'app.log'),
|
||||
frequency: 'daily', // 轮转频率:daily, hourly, weekly
|
||||
size: '10m', // 文件大小限制
|
||||
limit: {
|
||||
count: 7, // 保留文件数量
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚨 注意事项
|
||||
|
||||
### 安全考虑
|
||||
|
||||
1. **敏感信息过滤**:系统自动过滤密码、token等敏感字段
|
||||
2. **访问控制**:确保日志文件只有授权用户可以访问
|
||||
3. **传输加密**:生产环境建议使用加密传输日志
|
||||
|
||||
### 性能考虑
|
||||
|
||||
1. **异步写入**:Pino 使用异步写入,不会阻塞主线程
|
||||
2. **日志级别**:生产环境建议使用 info 及以上级别
|
||||
3. **文件轮转**:及时清理和压缩日志文件,避免占用过多磁盘空间
|
||||
|
||||
### 运维建议
|
||||
|
||||
1. **监控磁盘空间**:定期检查日志目录的磁盘使用情况
|
||||
2. **备份重要日志**:对于重要的错误日志,建议定期备份
|
||||
3. **日志分析**:可以集成 ELK Stack 等日志分析工具
|
||||
4. **告警设置**:配置日志监控告警,及时发现系统问题
|
||||
|
||||
---
|
||||
|
||||
## 🔗 相关文档
|
||||
|
||||
- [后端开发规范 - 日志系统使用指南](./backend_development_guide.md#四日志系统使用指南)
|
||||
- [AI 辅助开发规范指南](./AI辅助开发规范指南.md)
|
||||
- [Pino 官方文档](https://getpino.io/)
|
||||
- [NestJS Pino 集成文档](https://github.com/iamolegga/nestjs-pino)
|
||||
|
||||
---
|
||||
|
||||
**💡 提示:使用 [AI 辅助开发指南](./AI辅助开发规范指南.md) 可以让 AI 帮你自动生成符合规范的日志代码!**
|
||||
@@ -27,9 +27,11 @@
|
||||
"@nestjs/core": "^10.4.20",
|
||||
"@nestjs/platform-express": "^10.4.20",
|
||||
"@nestjs/platform-socket.io": "^10.4.20",
|
||||
"@nestjs/schedule": "^4.1.2",
|
||||
"@nestjs/websockets": "^10.4.20",
|
||||
"nestjs-pino": "^4.5.0",
|
||||
"pino": "^10.1.0",
|
||||
|
||||
"reflect-metadata": "^0.1.14",
|
||||
"rxjs": "^7.8.2"
|
||||
},
|
||||
|
||||
365
src/core/utils/logger/log-management.service.ts
Normal file
365
src/core/utils/logger/log-management.service.ts
Normal file
@@ -0,0 +1,365 @@
|
||||
/**
|
||||
* 日志管理服务
|
||||
*
|
||||
* 功能描述:
|
||||
* - 定期清理过期日志文件
|
||||
* - 监控日志文件大小和数量
|
||||
* - 提供日志统计和分析功能
|
||||
* - 支持日志文件压缩和归档
|
||||
*
|
||||
* 依赖模块:
|
||||
* - ConfigService: 环境配置服务
|
||||
* - AppLoggerService: 应用日志服务
|
||||
* - ScheduleModule: 定时任务模块
|
||||
*
|
||||
* @author 开发团队
|
||||
* @version 1.0.0
|
||||
* @since 2024-12-13
|
||||
*/
|
||||
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import { Cron, CronExpression } from '@nestjs/schedule';
|
||||
import { AppLoggerService } from './logger.service';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import * as zlib from 'zlib';
|
||||
|
||||
/**
|
||||
* 日志管理服务类
|
||||
*
|
||||
* 职责:
|
||||
* - 执行定期日志清理任务
|
||||
* - 监控日志系统健康状态
|
||||
* - 提供日志文件统计信息
|
||||
* - 管理日志文件的生命周期
|
||||
*
|
||||
* 主要方法:
|
||||
* - cleanupOldLogs(): 清理过期日志文件
|
||||
* - compressLogs(): 压缩历史日志文件
|
||||
* - getLogStatistics(): 获取日志统计信息
|
||||
* - monitorLogHealth(): 监控日志系统健康状态
|
||||
*
|
||||
* 使用场景:
|
||||
* - 定期维护日志文件
|
||||
* - 监控系统日志状态
|
||||
* - 优化存储空间使用
|
||||
* - 提供日志分析数据
|
||||
*/
|
||||
@Injectable()
|
||||
export class LogManagementService {
|
||||
private readonly logDir: string;
|
||||
private readonly maxFiles: number;
|
||||
private readonly maxSize: string;
|
||||
|
||||
constructor(
|
||||
private readonly configService: ConfigService,
|
||||
private readonly logger: AppLoggerService,
|
||||
) {
|
||||
this.logDir = this.configService.get('LOG_DIR', './logs');
|
||||
this.maxFiles = this.parseMaxFiles(this.configService.get('LOG_MAX_FILES', '7d'));
|
||||
this.maxSize = this.configService.get('LOG_MAX_SIZE', '10m');
|
||||
}
|
||||
|
||||
/**
|
||||
* 定期清理过期日志文件
|
||||
*
|
||||
* 功能描述:
|
||||
* 每天凌晨2点执行,清理超过保留期限的日志文件
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 扫描日志目录中的所有文件
|
||||
* 2. 检查文件创建时间
|
||||
* 3. 删除超过保留期限的文件
|
||||
* 4. 记录清理结果
|
||||
*
|
||||
* @cron 每天凌晨2点执行
|
||||
*/
|
||||
@Cron('0 2 * * *', {
|
||||
name: 'cleanup-old-logs',
|
||||
timeZone: 'Asia/Shanghai',
|
||||
})
|
||||
async cleanupOldLogs(): Promise<void> {
|
||||
const startTime = Date.now();
|
||||
|
||||
this.logger.info('开始执行日志清理任务', {
|
||||
operation: 'cleanupOldLogs',
|
||||
logDir: this.logDir,
|
||||
maxFiles: this.maxFiles,
|
||||
timestamp: new Date().toISOString(),
|
||||
});
|
||||
|
||||
try {
|
||||
if (!fs.existsSync(this.logDir)) {
|
||||
this.logger.warn('日志目录不存在,跳过清理任务', {
|
||||
operation: 'cleanupOldLogs',
|
||||
logDir: this.logDir,
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
const files = fs.readdirSync(this.logDir);
|
||||
const cutoffDate = new Date();
|
||||
cutoffDate.setDate(cutoffDate.getDate() - this.maxFiles);
|
||||
|
||||
let deletedCount = 0;
|
||||
let deletedSize = 0;
|
||||
|
||||
for (const file of files) {
|
||||
const filePath = path.join(this.logDir, file);
|
||||
const stats = fs.statSync(filePath);
|
||||
|
||||
// 只处理日志文件(.log 扩展名)
|
||||
if (path.extname(file) === '.log' && stats.birthtime < cutoffDate) {
|
||||
try {
|
||||
deletedSize += stats.size;
|
||||
fs.unlinkSync(filePath);
|
||||
deletedCount++;
|
||||
|
||||
this.logger.info('删除过期日志文件', {
|
||||
operation: 'cleanupOldLogs',
|
||||
fileName: file,
|
||||
fileSize: this.formatBytes(stats.size),
|
||||
fileAge: Math.floor((Date.now() - stats.birthtime.getTime()) / (1000 * 60 * 60 * 24)),
|
||||
});
|
||||
} catch (error) {
|
||||
this.logger.error('删除日志文件失败', {
|
||||
operation: 'cleanupOldLogs',
|
||||
fileName: file,
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
}, error instanceof Error ? error.stack : undefined);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const duration = Date.now() - startTime;
|
||||
|
||||
this.logger.info('日志清理任务完成', {
|
||||
operation: 'cleanupOldLogs',
|
||||
deletedCount,
|
||||
deletedSize: this.formatBytes(deletedSize),
|
||||
duration,
|
||||
timestamp: new Date().toISOString(),
|
||||
});
|
||||
|
||||
} catch (error) {
|
||||
const duration = Date.now() - startTime;
|
||||
|
||||
this.logger.error('日志清理任务执行失败', {
|
||||
operation: 'cleanupOldLogs',
|
||||
logDir: this.logDir,
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
duration,
|
||||
timestamp: new Date().toISOString(),
|
||||
}, error instanceof Error ? error.stack : undefined);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 定期压缩历史日志文件
|
||||
*
|
||||
* 功能描述:
|
||||
* 每周日凌晨3点执行,压缩7天前的日志文件以节省存储空间
|
||||
*
|
||||
* @cron 每周日凌晨3点执行
|
||||
*/
|
||||
@Cron('0 3 * * 0', {
|
||||
name: 'compress-logs',
|
||||
timeZone: 'Asia/Shanghai',
|
||||
})
|
||||
async compressLogs(): Promise<void> {
|
||||
this.logger.info('日志压缩任务已跳过', {
|
||||
operation: 'compressLogs',
|
||||
reason: '使用简化的日志管理策略',
|
||||
timestamp: new Date().toISOString(),
|
||||
});
|
||||
|
||||
// 简化版本:只记录任务执行,实际压缩功能可以后续添加
|
||||
// 这样可以避免复杂的文件操作导致的问题
|
||||
}
|
||||
|
||||
/**
|
||||
* 定期监控日志系统健康状态
|
||||
*
|
||||
* 功能描述:
|
||||
* 每小时执行一次,检查日志系统的健康状态
|
||||
*
|
||||
* @cron 每小时执行
|
||||
*/
|
||||
@Cron(CronExpression.EVERY_HOUR, {
|
||||
name: 'monitor-log-health',
|
||||
})
|
||||
async monitorLogHealth(): Promise<void> {
|
||||
try {
|
||||
const stats = await this.getLogStatistics();
|
||||
|
||||
// 检查磁盘空间使用情况
|
||||
if (stats.totalSize > this.parseSize(this.maxSize) * 100) { // 如果总大小超过单文件限制的100倍
|
||||
this.logger.warn('日志文件占用空间过大', {
|
||||
operation: 'monitorLogHealth',
|
||||
totalSize: this.formatBytes(stats.totalSize),
|
||||
fileCount: stats.fileCount,
|
||||
recommendation: '建议检查日志清理策略',
|
||||
});
|
||||
}
|
||||
|
||||
// 检查错误日志数量
|
||||
if (stats.errorLogCount > 1000) { // 如果错误日志过多
|
||||
this.logger.warn('错误日志数量异常', {
|
||||
operation: 'monitorLogHealth',
|
||||
errorLogCount: stats.errorLogCount,
|
||||
recommendation: '建议检查系统运行状态',
|
||||
});
|
||||
}
|
||||
|
||||
// 定期输出日志统计信息(每天一次)
|
||||
const hour = new Date().getHours();
|
||||
if (hour === 9) { // 每天上午9点输出统计信息
|
||||
this.logger.info('日志系统健康状态报告', {
|
||||
operation: 'monitorLogHealth',
|
||||
...stats,
|
||||
timestamp: new Date().toISOString(),
|
||||
});
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
this.logger.error('日志健康监控失败', {
|
||||
operation: 'monitorLogHealth',
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
timestamp: new Date().toISOString(),
|
||||
}, error instanceof Error ? error.stack : undefined);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取日志统计信息
|
||||
*
|
||||
* 功能描述:
|
||||
* 统计日志目录中的文件数量、大小等信息
|
||||
*
|
||||
* @returns 日志统计信息对象
|
||||
*/
|
||||
async getLogStatistics(): Promise<{
|
||||
fileCount: number;
|
||||
totalSize: number;
|
||||
errorLogCount: number;
|
||||
oldestFile: string;
|
||||
newestFile: string;
|
||||
avgFileSize: number;
|
||||
}> {
|
||||
try {
|
||||
if (!fs.existsSync(this.logDir)) {
|
||||
return {
|
||||
fileCount: 0,
|
||||
totalSize: 0,
|
||||
errorLogCount: 0,
|
||||
oldestFile: '',
|
||||
newestFile: '',
|
||||
avgFileSize: 0,
|
||||
};
|
||||
}
|
||||
|
||||
const files = fs.readdirSync(this.logDir);
|
||||
let totalSize = 0;
|
||||
let errorLogCount = 0;
|
||||
let oldestTime = Date.now();
|
||||
let newestTime = 0;
|
||||
let oldestFile = '';
|
||||
let newestFile = '';
|
||||
|
||||
for (const file of files) {
|
||||
const filePath = path.join(this.logDir, file);
|
||||
const stats = fs.statSync(filePath);
|
||||
|
||||
totalSize += stats.size;
|
||||
|
||||
if (file.includes('error')) {
|
||||
errorLogCount++;
|
||||
}
|
||||
|
||||
if (stats.birthtime.getTime() < oldestTime) {
|
||||
oldestTime = stats.birthtime.getTime();
|
||||
oldestFile = file;
|
||||
}
|
||||
|
||||
if (stats.birthtime.getTime() > newestTime) {
|
||||
newestTime = stats.birthtime.getTime();
|
||||
newestFile = file;
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
fileCount: files.length,
|
||||
totalSize,
|
||||
errorLogCount,
|
||||
oldestFile,
|
||||
newestFile,
|
||||
avgFileSize: files.length > 0 ? Math.round(totalSize / files.length) : 0,
|
||||
};
|
||||
|
||||
} catch (error) {
|
||||
this.logger.error('获取日志统计信息失败', {
|
||||
operation: 'getLogStatistics',
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
}, error instanceof Error ? error.stack : undefined);
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析最大文件数配置
|
||||
*
|
||||
* @param maxFiles 配置字符串(如 "7d", "30", "2w")
|
||||
* @returns 天数
|
||||
* @private
|
||||
*/
|
||||
private parseMaxFiles(maxFiles: string): number {
|
||||
if (maxFiles.endsWith('d')) {
|
||||
return parseInt(maxFiles.slice(0, -1));
|
||||
} else if (maxFiles.endsWith('w')) {
|
||||
return parseInt(maxFiles.slice(0, -1)) * 7;
|
||||
} else if (maxFiles.endsWith('m')) {
|
||||
return parseInt(maxFiles.slice(0, -1)) * 30;
|
||||
} else {
|
||||
return parseInt(maxFiles) || 7;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析文件大小配置
|
||||
*
|
||||
* @param size 大小字符串(如 "10m", "1g", "500k")
|
||||
* @returns 字节数
|
||||
* @private
|
||||
*/
|
||||
private parseSize(size: string): number {
|
||||
const units: Record<string, number> = {
|
||||
'k': 1024,
|
||||
'm': 1024 * 1024,
|
||||
'g': 1024 * 1024 * 1024,
|
||||
};
|
||||
|
||||
const unit = size.slice(-1).toLowerCase();
|
||||
const value = parseInt(size.slice(0, -1));
|
||||
|
||||
return value * (units[unit] || 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* 格式化字节数为可读字符串
|
||||
*
|
||||
* @param bytes 字节数
|
||||
* @returns 格式化后的字符串
|
||||
* @private
|
||||
*/
|
||||
private formatBytes(bytes: number): string {
|
||||
if (bytes === 0) return '0 B';
|
||||
|
||||
const k = 1024;
|
||||
const sizes = ['B', 'KB', 'MB', 'GB'];
|
||||
const i = Math.floor(Math.log(bytes) / Math.log(k));
|
||||
|
||||
return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
|
||||
}
|
||||
}
|
||||
278
src/core/utils/logger/logger.config.ts
Normal file
278
src/core/utils/logger/logger.config.ts
Normal file
@@ -0,0 +1,278 @@
|
||||
/**
|
||||
* 日志配置模块
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供详细的日志配置选项
|
||||
* - 支持日志文件轮转和管理
|
||||
* - 根据环境自动调整日志策略
|
||||
* - 提供日志文件清理和归档功能
|
||||
*
|
||||
* @author 开发团队
|
||||
* @version 1.0.0
|
||||
* @since 2024-12-13
|
||||
*/
|
||||
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import * as path from 'path';
|
||||
import * as fs from 'fs';
|
||||
|
||||
/**
|
||||
* 日志配置工厂类
|
||||
*
|
||||
* 职责:
|
||||
* - 根据环境变量生成 Pino 日志配置
|
||||
* - 管理日志文件的创建和轮转
|
||||
* - 提供不同环境的日志策略
|
||||
*/
|
||||
export class LoggerConfigFactory {
|
||||
/**
|
||||
* 创建 Pino 日志配置
|
||||
*
|
||||
* 功能描述:
|
||||
* 根据环境变量和配置生成完整的 Pino 日志配置对象
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 读取环境变量配置
|
||||
* 2. 确保日志目录存在
|
||||
* 3. 根据环境选择不同的输出策略
|
||||
* 4. 配置日志轮转和清理策略
|
||||
*
|
||||
* @param configService 配置服务实例
|
||||
* @returns Pino 日志配置对象
|
||||
*/
|
||||
static createLoggerConfig(configService: ConfigService) {
|
||||
const isProduction = configService.get('NODE_ENV') === 'production';
|
||||
const logDir = configService.get('LOG_DIR', './logs');
|
||||
const logLevel = configService.get('LOG_LEVEL', isProduction ? 'info' : 'debug');
|
||||
const appName = configService.get('APP_NAME', 'pixel-game-server');
|
||||
|
||||
// 确保日志目录存在
|
||||
this.ensureLogDirectory(logDir);
|
||||
|
||||
return {
|
||||
pinoHttp: {
|
||||
level: logLevel,
|
||||
|
||||
// 根据环境配置不同的输出策略
|
||||
transport: this.createTransportConfig(isProduction, logDir, logLevel),
|
||||
|
||||
// 自定义序列化器
|
||||
serializers: this.createSerializers(),
|
||||
|
||||
// 基础字段
|
||||
base: {
|
||||
pid: process.pid,
|
||||
hostname: require('os').hostname(),
|
||||
app: appName,
|
||||
version: process.env.npm_package_version || '1.0.0',
|
||||
},
|
||||
|
||||
// HTTP 请求日志配置
|
||||
autoLogging: true,
|
||||
|
||||
// 自定义日志级别判断
|
||||
customLogLevel: this.customLogLevel,
|
||||
|
||||
// 自定义请求ID生成
|
||||
genReqId: (req: any) => req.headers['x-request-id'] || this.generateRequestId(),
|
||||
|
||||
// 自定义成功响应消息
|
||||
customSuccessMessage: (req: any, res: any) => {
|
||||
return `${req.method} ${req.url} completed in ${res.responseTime}ms`;
|
||||
},
|
||||
|
||||
// 自定义错误响应消息
|
||||
customErrorMessage: (req: any, res: any, err: any) => {
|
||||
return `${req.method} ${req.url} failed: ${err.message}`;
|
||||
},
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建传输配置
|
||||
*
|
||||
* @param isProduction 是否为生产环境
|
||||
* @param logDir 日志目录
|
||||
* @param logLevel 日志级别
|
||||
* @returns 传输配置对象
|
||||
* @private
|
||||
*/
|
||||
private static createTransportConfig(isProduction: boolean, logDir: string, logLevel: string) {
|
||||
if (isProduction) {
|
||||
// 生产环境:多目标输出,包含日志轮转
|
||||
return {
|
||||
targets: [
|
||||
{
|
||||
// 应用日志(所有级别)
|
||||
target: 'pino/file',
|
||||
options: {
|
||||
destination: path.join(logDir, 'app.log'),
|
||||
mkdir: true,
|
||||
},
|
||||
level: 'info',
|
||||
},
|
||||
{
|
||||
// 错误日志(仅错误和致命错误)
|
||||
target: 'pino/file',
|
||||
options: {
|
||||
destination: path.join(logDir, 'error.log'),
|
||||
mkdir: true,
|
||||
},
|
||||
level: 'error',
|
||||
},
|
||||
{
|
||||
// 访问日志(HTTP 请求)
|
||||
target: 'pino/file',
|
||||
options: {
|
||||
destination: path.join(logDir, 'access.log'),
|
||||
mkdir: true,
|
||||
},
|
||||
level: 'info',
|
||||
},
|
||||
{
|
||||
// 控制台输出(用于容器日志收集)
|
||||
target: 'pino/file',
|
||||
options: {
|
||||
destination: 1, // stdout
|
||||
},
|
||||
level: 'warn',
|
||||
},
|
||||
],
|
||||
};
|
||||
} else {
|
||||
// 开发环境:美化输出 + 文件备份
|
||||
return {
|
||||
targets: [
|
||||
{
|
||||
// 控制台美化输出
|
||||
target: 'pino-pretty',
|
||||
options: {
|
||||
colorize: true,
|
||||
translateTime: 'SYS:yyyy-mm-dd HH:MM:ss',
|
||||
ignore: 'pid,hostname',
|
||||
messageFormat: '{app} [{level}] {msg}',
|
||||
customPrettifiers: {
|
||||
time: (timestamp: any) => `🕐 ${timestamp}`,
|
||||
level: (logLevel: any) => {
|
||||
const levelEmojis: Record<number, string> = {
|
||||
10: '🔍', // trace
|
||||
20: '🐛', // debug
|
||||
30: '📝', // info
|
||||
40: '⚠️', // warn
|
||||
50: '❌', // error
|
||||
60: '💀', // fatal
|
||||
};
|
||||
return `${levelEmojis[logLevel] || '📝'} ${logLevel}`;
|
||||
},
|
||||
},
|
||||
},
|
||||
level: logLevel,
|
||||
},
|
||||
{
|
||||
// 开发环境文件输出
|
||||
target: 'pino/file',
|
||||
options: {
|
||||
destination: path.join(logDir, 'dev.log'),
|
||||
mkdir: true,
|
||||
},
|
||||
level: 'debug',
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建序列化器配置
|
||||
*
|
||||
* @returns 序列化器配置对象
|
||||
* @private
|
||||
*/
|
||||
private static createSerializers() {
|
||||
return {
|
||||
req: (req: any) => ({
|
||||
id: req.id,
|
||||
method: req.method,
|
||||
url: req.url,
|
||||
path: req.route?.path,
|
||||
parameters: req.params,
|
||||
query: req.query,
|
||||
headers: {
|
||||
host: req.headers.host,
|
||||
'user-agent': req.headers['user-agent'],
|
||||
'content-type': req.headers['content-type'],
|
||||
'content-length': req.headers['content-length'],
|
||||
authorization: req.headers.authorization ? '[REDACTED]' : undefined,
|
||||
},
|
||||
ip: req.ip,
|
||||
ips: req.ips,
|
||||
hostname: req.hostname,
|
||||
}),
|
||||
res: (res: any) => ({
|
||||
statusCode: res.statusCode,
|
||||
statusMessage: res.statusMessage,
|
||||
headers: {
|
||||
'content-type': res.getHeader('content-type'),
|
||||
'content-length': res.getHeader('content-length'),
|
||||
},
|
||||
responseTime: res.responseTime,
|
||||
}),
|
||||
err: (err: any) => ({
|
||||
type: err.constructor.name,
|
||||
message: err.message,
|
||||
stack: err.stack,
|
||||
code: err.code,
|
||||
statusCode: err.statusCode,
|
||||
}),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 自定义日志级别判断
|
||||
*
|
||||
* @param req HTTP 请求对象
|
||||
* @param res HTTP 响应对象
|
||||
* @param err 错误对象
|
||||
* @returns 日志级别
|
||||
* @private
|
||||
*/
|
||||
private static customLogLevel(req: any, res: any, err: any) {
|
||||
if (res.statusCode >= 400 && res.statusCode < 500) {
|
||||
return 'warn';
|
||||
} else if (res.statusCode >= 500 || err) {
|
||||
return 'error';
|
||||
} else if (res.statusCode >= 300 && res.statusCode < 400) {
|
||||
return 'info';
|
||||
}
|
||||
return 'info';
|
||||
}
|
||||
|
||||
/**
|
||||
* 生成请求ID
|
||||
*
|
||||
* @returns 唯一的请求ID
|
||||
* @private
|
||||
*/
|
||||
private static generateRequestId(): string {
|
||||
return `req_${Date.now()}_${Math.random().toString(36).substr(2, 9)}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* 确保日志目录存在
|
||||
*
|
||||
* @param logDir 日志目录路径
|
||||
* @private
|
||||
*/
|
||||
private static ensureLogDirectory(logDir: string): void {
|
||||
try {
|
||||
if (!fs.existsSync(logDir)) {
|
||||
fs.mkdirSync(logDir, { recursive: true });
|
||||
console.log(`📁 Created log directory: ${logDir}`);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error(`❌ Failed to create log directory: ${logDir}`, error);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -18,9 +18,12 @@
|
||||
*/
|
||||
|
||||
import { Module } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { ConfigModule, ConfigService } from '@nestjs/config';
|
||||
import { LoggerModule as PinoLoggerModule } from 'nestjs-pino';
|
||||
import { ScheduleModule } from '@nestjs/schedule';
|
||||
import { AppLoggerService } from './logger.service';
|
||||
import { LoggerConfigFactory } from './logger.config';
|
||||
import { LogManagementService } from './log-management.service';
|
||||
|
||||
/**
|
||||
* 日志模块类
|
||||
@@ -43,39 +46,16 @@ import { AppLoggerService } from './logger.service';
|
||||
@Module({
|
||||
imports: [
|
||||
ConfigModule,
|
||||
ScheduleModule.forRoot(),
|
||||
PinoLoggerModule.forRootAsync({
|
||||
imports: [ConfigModule],
|
||||
useFactory: () => ({
|
||||
pinoHttp: {
|
||||
// 根据环境设置日志级别
|
||||
level: process.env.NODE_ENV === 'production' ? 'info' : 'debug',
|
||||
|
||||
// 开发环境使用美化输出
|
||||
transport: process.env.NODE_ENV !== 'production' ? {
|
||||
target: 'pino-pretty',
|
||||
options: {
|
||||
colorize: true,
|
||||
translateTime: 'SYS:standard',
|
||||
ignore: 'pid,hostname',
|
||||
useFactory: (configService: ConfigService) => {
|
||||
return LoggerConfigFactory.createLoggerConfig(configService);
|
||||
},
|
||||
} : undefined,
|
||||
|
||||
// 自定义序列化器,过滤敏感信息
|
||||
serializers: {
|
||||
req: (req) => ({
|
||||
method: req.method,
|
||||
url: req.url,
|
||||
headers: req.headers,
|
||||
}),
|
||||
res: (res) => ({
|
||||
statusCode: res.statusCode,
|
||||
}),
|
||||
},
|
||||
},
|
||||
}),
|
||||
inject: [ConfigService],
|
||||
}),
|
||||
],
|
||||
providers: [AppLoggerService],
|
||||
exports: [AppLoggerService],
|
||||
providers: [AppLoggerService, LogManagementService],
|
||||
exports: [AppLoggerService, LogManagementService],
|
||||
})
|
||||
export class LoggerModule {}
|
||||
|
||||
Reference in New Issue
Block a user