当前位置：首页 > news >正文

cool-admin(midway版)后端日志管理：日志聚合与集中式存储终极指南

news 2026/5/27 15:13:57

cool-admin(midway版)后端日志管理：日志聚合与集中式存储终极指南

【免费下载链接】cool-admin-midway🔥 cool-admin(midway版)一个很酷的后台权限管理框架，模块化、插件化、CRUD极速开发，永久开源免费，基于midway.js 3.x、typescript、typeorm、mysql、jwt、vue3、vite、element-ui等构建项目地址: https://gitcode.com/gh_mirrors/co/cool-admin-midway

cool-admin(midway版)是一个基于Midway.js 3.x构建的现代化后台权限管理框架，它提供了强大而灵活的后端日志管理功能。本文将详细介绍如何利用cool-admin的日志聚合与集中式存储功能，帮助开发者构建可靠的系统监控体系。

🎯 为什么需要专业的日志管理系统？

在现代Web应用中，日志管理不仅仅是简单的控制台输出。一个完善的日志系统应该具备以下特性：

集中存储：所有日志统一存储，便于查询和分析
结构化数据：日志信息包含用户ID、操作行为、IP地址、请求参数等关键信息
自动清理：根据配置自动清理过期日志，避免存储空间无限增长
实时记录：每个API请求都会被自动记录，无需手动添加日志代码

cool-admin的日志管理模块完美实现了这些需求，让开发者可以专注于业务逻辑，而无需担心日志管理的复杂性。

🔧 核心日志模块架构

cool-admin的日志管理采用模块化设计，主要包含以下几个核心组件：

1. 日志实体定义 (src/modules/base/entity/sys/log.ts)

系统日志实体定义了日志的基本结构，包括用户ID、操作行为、IP地址和请求参数等字段：

@Entity('base_sys_log') export class BaseSysLogEntity extends BaseEntity { @Index() @Column({ comment: '用户ID', nullable: true }) userId: number; @Index() @Column({ comment: '行为' }) action: string; @Index() @Column({ comment: 'ip', nullable: true }) ip: string; @Column({ comment: '参数', nullable: true, type: 'json', transformer: transformerJson, }) params: string; }

2. 日志服务层 (src/modules/base/service/sys/log.ts)

日志服务提供了核心的业务逻辑，包括日志记录和自动清理功能：

自动记录用户操作：记录用户ID、IP地址、请求路径和参数
智能清理机制：支持按时间自动清理过期日志
灵活的配置：日志保留时间可通过系统配置动态调整

3. 日志中间件 (src/modules/base/middleware/log.ts)

全局日志中间件自动拦截所有请求并记录日志，开发者无需在每个控制器中手动添加日志代码：

@Middleware() export class BaseLogMiddleware implements IMiddleware<Context, NextFunction> { resolve() { return async (ctx: Context, next: NextFunction) => { const baseSysLogService = await ctx.requestContext.getAsync( BaseSysLogService ); baseSysLogService.record( ctx, ctx.url, ctx.req.method === 'GET' ? ctx.request.query : ctx.request.body, ctx.admin ? ctx.admin.userId : null ); await next(); }; } }

cool-admin日志系统采用模块化架构，实现自动化的日志收集与存储

🚀 快速配置与使用指南

1. 启用日志中间件

在基础模块配置中，日志中间件已默认启用：

// src/modules/base/config.ts globalMiddlewares: [ BaseTranslateMiddleware, BaseAuthorityMiddleware, BaseLogMiddleware, // 日志中间件 ],

2. 配置日志保留时间

通过系统配置界面可以轻松设置日志保留时间：

// 通过API设置日志保留时间（单位：天） POST /admin/base/sys/log/setKeep { "value": 30 // 保留30天 } // 获取当前日志保留时间 GET /admin/base/sys/log/getKeep

3. 手动清理日志

系统提供了手动清理日志的接口：

// 清理所有日志 POST /admin/base/sys/log/clear // 清理过期日志（基于配置的保留时间） // 自动执行，无需手动调用

⏰ 自动化日志清理机制

cool-admin内置了定时任务，每天自动清理过期日志：

// src/modules/base/job/log.ts @Job({ cronTime: FORMAT.CRONTAB.EVERY_DAY, // 每天执行一次 start: true, }) export class BaseLogJob implements IJob { async onTick() { this.logger.info('清除日志定时任务开始执行'); const startTime = Date.now(); await this.baseSysLogService.clear(); // 自动清理过期日志 this.logger.info(`清除日志定时任务结束，耗时:${Date.now() - startTime}ms`); } }

📊 日志查询与分析

系统提供了强大的日志查询功能：

1. 分页查询接口

// 获取日志分页列表 POST /admin/base/sys/log/page { "page": 1, "size": 20, "sort": "createTime", "order": "desc" }

2. 关联用户信息查询

日志查询会自动关联用户表，可以同时获取操作用户的姓名信息：

// 在日志控制器中配置的关联查询 pageQueryOp: { keyWordLikeFields: ['b.name', 'a.action', 'a.ip'], select: ['a.*', 'b.name'], // 包含用户姓名 join: [ { entity: BaseSysUserEntity, alias: 'b', condition: 'a.userId = b.id', type: 'leftJoin', }, ], }

🔍 高级日志功能扩展

1. 任务日志管理

除了系统操作日志，cool-admin还提供了任务日志管理模块：

// src/modules/task/entity/log.ts @Entity('task_log') export class TaskLogEntity extends BaseEntity { @Index() @Column({ comment: '任务ID', nullable: true }) taskId: number; @Column({ comment: '状态 0-失败 1-成功', default: 0 }) status: number; @Column({ comment: '详情描述', nullable: true, type: 'text' }) detail: string; }