abp-next-admin2/docs/wiki/模块化设计/功能模块/审计日志模块.md

审计日志模块

**本文档引用的文件** - [AuditLog.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/AuditLog.cs) - [AuditLogAction.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/AuditLogAction.cs) - [EntityChange.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/EntityChange.cs) - [DefaultAuditLogManager.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/DefaultAuditLogManager.cs) - [ElasticsearchAuditLogManager.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging.Elasticsearch/LINGYUN/Abp/AuditLogging/Elasticsearch/ElasticsearchAuditLogManager.cs) - [AbpAuditLoggingElasticsearchOptions.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging.Elasticsearch/LINGYUN/Abp/AuditLogging/Elasticsearch/AbpAuditLoggingElasticsearchOptions.cs) - [AuditLogManager.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging.EntityFrameworkCore/LINGYUN/Abp/AuditLogging/EntityFrameworkCore/AuditLogManager.cs) - [IAuditLogAppService.cs](file://aspnet-core/modules/auditing/LINGYUN.Abp.Auditing.Application.Contracts/LINGYUN/Abp/Auditing/AuditLogs/IAuditLogAppService.cs)

目录

1. 简介
2. 项目结构
3. 核心组件
4. 架构概述
5. 详细组件分析
6. 依赖分析
7. 性能考虑
8. 故障排除指南
9. 结论

简介

本文档详细介绍了基于ABP框架的审计日志模块，涵盖操作日志的自动记录机制、日志数据结构与存储方式、Elasticsearch集成用于高效查询分析、API接口设计、管理界面展示及配置选项等内容。该模块实现了对系统操作的全面审计功能，支持多种存储后端和灵活的查询能力。

项目结构

审计日志模块采用分层架构设计，包含核心审计功能、数据库持久化、Elasticsearch集成和应用服务层。模块通过ABP框架的审计机制自动捕获操作日志，并提供丰富的查询和管理功能。

graph TB
subgraph "核心审计"
AuditLog[AuditLog 实体]
AuditLogAction[AuditLogAction 实体]
EntityChange[EntityChange 实体]
DefaultAuditLogManager[DefaultAuditLogManager]
end
subgraph "存储实现"
EntityFramework[EntityFrameworkCore]
Elasticsearch[Elasticsearch]
end
subgraph "应用服务"
AppService[IAuditLogAppService]
end
DefaultAuditLogManager --> EntityFramework
DefaultAuditLogManager --> Elasticsearch
EntityFramework --> AuditLog
Elasticsearch --> AuditLog
AppService --> DefaultAuditLogManager

图示来源

• AuditLog.cs
• AuditLogAction.cs
• EntityChange.cs
• DefaultAuditLogManager.cs
• ElasticsearchAuditLogManager.cs
• AuditLogManager.cs

节来源

• AuditLog.cs
• AuditLogAction.cs
• EntityChange.cs

核心组件

审计日志模块的核心组件包括审计日志实体、审计日志管理器和应用服务接口。这些组件共同实现了操作日志的记录、存储和查询功能。

节来源

• AuditLog.cs
• AuditLogAction.cs
• EntityChange.cs

架构概述

审计日志模块采用分层架构，基于ABP框架的审计功能实现。模块支持多种存储后端，包括Entity Framework Core和Elasticsearch，通过依赖注入实现灵活的存储策略切换。

graph TD
A[客户端请求] --> B[ABP审计拦截]
B --> C[AuditLogInfo]
C --> D[IAuditLogManager]
D --> E{存储策略}
E --> F[EntityFrameworkCore]
E --> G[Elasticsearch]
F --> H[数据库]
G --> I[Elasticsearch集群]
D --> J[应用服务]
J --> K[管理界面]

图示来源

• DefaultAuditLogManager.cs
• ElasticsearchAuditLogManager.cs
• AuditLogManager.cs

详细组件分析

审计日志实体分析

审计日志实体定义了操作日志的数据结构，包含用户信息、请求信息、执行时间和变更记录等。

类图

classDiagram
class AuditLog {
+Guid Id
+string? ApplicationName
+Guid? UserId
+string? UserName
+Guid? TenantId
+string? TenantName
+DateTime ExecutionTime
+int ExecutionDuration
+string? ClientIpAddress
+string? ClientName
+string? ClientId
+string? CorrelationId
+string? BrowserInfo
+string? HttpMethod
+string? Url
+string? Exceptions
+string? Comments
+int? HttpStatusCode
+EntityChange[] EntityChanges
+AuditLogAction[] Actions
+ExtraPropertyDictionary ExtraProperties
}
class AuditLogAction {
+Guid Id
+Guid? TenantId
+Guid AuditLogId
+string ServiceName
+string MethodName
+string Parameters
+DateTime ExecutionTime
+int ExecutionDuration
+ExtraPropertyDictionary ExtraProperties
}
class EntityChange {
+Guid Id
+Guid AuditLogId
+Guid? TenantId
+DateTime ChangeTime
+EntityChangeType ChangeType
+Guid? EntityTenantId
+string? EntityId
+string? EntityTypeFullName
+EntityPropertyChange[] PropertyChanges
+ExtraPropertyDictionary ExtraProperties
}
class EntityPropertyChange {
+Guid Id
+Guid EntityChangeId
+string? PropertyName
+string? NewValue
+string? OriginalValue
}
AuditLog "1" *-- "0..*" AuditLogAction : 包含
AuditLog "1" *-- "0..*" EntityChange : 包含
EntityChange "1" *-- "0..*" EntityPropertyChange : 包含

图示来源

• AuditLog.cs
• AuditLogAction.cs
• EntityChange.cs

节来源

• AuditLog.cs
• AuditLogAction.cs
• EntityChange.cs

Elasticsearch集成分析

Elasticsearch实现提供了高性能的日志存储和查询能力，利用Elasticsearch的全文搜索和聚合功能实现高效的日志分析。

序列图

sequenceDiagram
participant App as "应用服务"
participant Manager as "ElasticsearchAuditLogManager"
participant Client as "Elasticsearch客户端"
participant ES as "Elasticsearch集群"
App->>Manager : SaveAsync(auditInfo)
Manager->>Manager : ConvertAsync(auditInfo)
Manager->>Client : Create()
Client->>ES : Bulk索引请求
ES-->>Client : 响应
Client-->>Manager : 返回结果
Manager-->>App : 返回ID
App->>Manager : GetListAsync(查询条件)
Manager->>Client : Create()
Client->>ES : Search查询
ES-->>Client : 返回文档
Client-->>Manager : 转换结果
Manager-->>App : 返回日志列表

图示来源

• ElasticsearchAuditLogManager.cs
• AbpAuditLoggingElasticsearchOptions.cs

节来源

• ElasticsearchAuditLogManager.cs
• AbpAuditLoggingElasticsearchOptions.cs

应用服务分析

应用服务层提供了审计日志的API接口，支持分页查询、详情获取和删除操作。

序列图

sequenceDiagram
participant Client as "客户端"
participant Service as "IAuditLogAppService"
participant Manager as "IAuditLogManager"
Client->>Service : GetListAsync(input)
Service->>Manager : GetListAsync(参数转换)
Manager-->>Service : 返回日志列表
Service-->>Client : 返回分页结果
Client->>Service : GetAsync(id)
Service->>Manager : GetAsync(id)
Manager-->>Service : 返回单个日志
Service-->>Client : 返回日志详情
Client->>Service : DeleteAsync(id)
Service->>Manager : DeleteAsync(id)
Manager-->>Service : 完成
Service-->>Client : 完成

图示来源

• IAuditLogAppService.cs

节来源

• IAuditLogAppService.cs

依赖分析

审计日志模块依赖于ABP框架的核心审计功能，并与多种技术栈集成以提供完整的日志管理解决方案。

graph TD
A[审计日志模块] --> B[ABP框架]
A --> C[Entity Framework Core]
A --> D[Elasticsearch]
A --> E[Nest客户端]
A --> F[对象映射]
A --> G[工作单元]
B --> H[审计拦截]
B --> I[依赖注入]
C --> J[数据库持久化]
D --> K[分布式搜索]
E --> L[ES API封装]
F --> M[DTO转换]
G --> N[事务管理]

图示来源

• ElasticsearchAuditLogManager.cs
• AuditLogManager.cs
• DefaultAuditLogManager.cs

节来源

• ElasticsearchAuditLogManager.cs
• AuditLogManager.cs
• DefaultAuditLogManager.cs

性能考虑

Elasticsearch实现通过批量索引操作和优化的查询构建器提高了日志写入和查询性能。使用Bulk API减少网络往返次数，通过字段映射优化查询效率，支持大规模日志数据的高效处理。

故障排除指南

当审计日志功能出现问题时，可检查以下方面：

1. 确认审计模块已正确注册到依赖注入容器
2. 检查Elasticsearch连接配置是否正确
3. 验证索引名称规范化设置
4. 查看日志输出中的错误信息
5. 确认审计开关配置是否启用

节来源

• ElasticsearchAuditLogManager.cs
• DefaultAuditLogManager.cs

结论

审计日志模块提供了完整的操作审计解决方案，通过ABP框架的审计机制自动记录系统操作，支持多种存储后端和高效的查询分析功能。Elasticsearch集成提供了卓越的搜索性能，适用于大规模日志数据的管理和分析场景。