跳转到正文

系统日志组件

springboot-component-system-log 用于采集接口操作日志,记录谁在什么时候执行了什么操作,以及服务端返回了什么结果

例如,用户修改资料后,可以记录用户身份、操作名称、请求路径、响应码和处理耗时。登录与其他操作使用同一套日志模型。

组件负责什么

组件在标注的 Spring MVC 接口上采集日志,将请求与响应整理成 SystemLog,再异步交给应用提供的保存器。

text
接口请求 → 采集发起人和操作 → 提取响应 → 生成日志 → 异步调用保存器

组件提供采集注解、配置、日志模型和保存接口。数据库、文件和消息队列的具体实现由 Business 系统日志提供,也可以由应用自行实现。

一条日志包含什么

内容示例
发起人用户 ID、姓名、客户端、IP
操作用户管理 / 修改资料、请求方法与路径、开始时间
响应HTTP 状态、业务响应码、消息、响应数据、完成时间
关联信息日志 ID、链路 ID、服务名、处理耗时

默认只记录带 @AopSystemLogRecord 注解的接口,不采集未标注接口;请求参数默认不采集,响应数据默认采集。

从哪里开始

  • 自行实现日志保存:阅读快速开始,用一个输出到应用日志的保存器跑通采集。
  • 直接保存到文件或数据库:阅读 Business 快速开始,使用已有存储实现。
  • 调整采集内容或扩展行为:阅读使用与配置

当前 Maven 坐标为 com.own.component:springboot-component-system-log,Java 包名为 com.own.component.log

按文件查阅方法

重点文件与方法逐项说明核心类、接口和方法重载的用途、参数、返回值、调用示例与注意事项,并链接到公开仓库对应源码。