tsai
/
abp-next-admin2
mirror of https://github.com/colinin/abp-next-admin.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
这是基于vue-vben-admin 模板适用于abp vNext的前端管理项目
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3165 Commits
72 Branches
53 Tags
76 MiB
 
 
 
 
 
 
Tree: f6e753eaeb
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f6e753eaeb'
${ noResults }
abp-next-admin2/docs/wiki/微服务架构/认证服务/安全策略/审计与监控.md

13 KiB
Raw Blame History

审计与监控

**本文档引用的文件** - [AbpAuditLoggingModule.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/AbpAuditLoggingModule.cs) - [AuditLog.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/AuditLog.cs) - [SecurityLog.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/SecurityLog.cs) - [DefaultAuditLogManager.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/DefaultAuditLogManager.cs) - [DefaultSecurityLogManager.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/DefaultSecurityLogManager.cs) - [ElasticsearchAuditLogManager.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging.Elasticsearch/LINGYUN/Abp/AuditLogging/Elasticsearch/ElasticsearchAuditLogManager.cs) - [ElasticsearchSecurityLogManager.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging.Elasticsearch/LINGYUN/Abp/AuditLogging/Elasticsearch/ElasticsearchSecurityLogManager.cs) - [EntityChange.cs](file://aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/LINGYUN/Abp/AuditLogging/EntityChange.cs) - [AuditingFeatureDefinitionProvider.cs](file://aspnet-core/modules/auditing/LINGYUN.Abp.Auditing.Application.Contracts/LINGYUN/Abp/Auditing/Features/AuditingFeatureDefinitionProvider.cs) - [SerilogElasticsearchLoggingManager.cs](file://aspnet-core/framework/logging/LINGYUN.Abp.Logging.Serilog.Elasticsearch/LINGYUN/Abp/AuditLogging/Serilog/Elasticsearch/SerilogElasticsearchLoggingManager.cs) - [AbpUINavigationVueVbenAdminNavigationDefinitionProvider.cs](file://aspnet-core/modules/platform/LINGYUN.Abp.UI.Navigation.VueVbenAdmin/LINGYUN/Abp/UI/Navigation/VueVbenAdmin/AbpUINavigationVueVbenAdminNavigationDefinitionProvider.cs)

目录

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

引言

本文档全面介绍了ABP框架中的审计与监控系统，重点阐述了安全事件日志记录机制、异常行为检测和告警系统、安全日志的存储与检索方法、安全仪表板实现以及安全事件响应流程。该系统为微服务架构提供了完整的审计跟踪和实时监控能力。

项目结构

审计与监控功能主要分布在框架的核心模块中，采用分层架构设计，包括基础审计日志、安全日志、实体变更跟踪和Elasticsearch集成等组件。

graph TD
subgraph "审计框架"
A[Abp.AuditLogging] --> B[核心数据模型]
A --> C[管理器接口]
A --> D[默认实现]
end
subgraph "持久化扩展"
E[Abp.AuditLogging.Elasticsearch] --> F[Elasticsearch集成]
E --> G[索引管理]
E --> H[查询构建]
end
subgraph "应用层"
I[Abp.Auditing.Application] --> J[应用服务]
I --> K[权限控制]
I --> L[特性管理]
end
subgraph "前端集成"
M[VueVbenAdmin] --> N[导航菜单]
M --> O[实时监控界面]
end
B --> |实现| C
D --> |提供默认| C
F --> |替换实现| C
J --> |调用| C
N --> |展示| J

图示来源

  • AbpAuditLoggingModule.cs
  • AbpUINavigationVueVbenAdminNavigationDefinitionProvider.cs

章节来源

  • AbpAuditLoggingModule.cs
  • AbpUINavigationVueVbenAdminNavigationDefinitionProvider.cs

核心组件

系统的核心组件包括审计日志、安全日志、实体变更跟踪和Elasticsearch集成管理器。这些组件共同构成了完整的审计与监控体系，支持对关键操作的全面跟踪和分析。

章节来源

  • AuditLog.cs
  • SecurityLog.cs
  • EntityChange.cs

架构概述

系统采用分层架构设计，从数据采集到存储再到展示形成完整闭环。通过模块化设计实现了功能解耦，支持灵活的存储后端替换。

graph LR
A[应用操作] --> B[审计拦截]
B --> C{日志类型}
C --> D[审计日志]
C --> E[安全日志]
C --> F[实体变更]
D --> G[管理器接口]
E --> G
F --> G
G --> H[默认实现]
G --> I[Elasticsearch实现]
H --> J[本地日志]
I --> K[Elasticsearch集群]
K --> L[应用服务]
L --> M[API接口]
M --> N[前端界面]
N --> O[安全仪表板]
style H fill:#f9f,stroke:#333
style I fill:#bbf,stroke:#333

图示来源

  • DefaultAuditLogManager.cs
  • ElasticsearchAuditLogManager.cs
  • SerilogElasticsearchLoggingManager.cs

详细组件分析

审计日志组件分析

审计日志组件负责记录所有关键业务操作的详细信息，包括请求上下文、执行时间和结果状态等。

数据模型

classDiagram
class AuditLog {
+Guid Id
+string? ApplicationName
+Guid? UserId
+string? UserName
+DateTime ExecutionTime
+int ExecutionDuration
+string? ClientIpAddress
+string? HttpMethod
+string? Url
+EntityChange[] EntityChanges
+AuditLogAction[] Actions
+ExtraPropertyDictionary ExtraProperties
}
class SecurityLog {
+Guid Id
+Guid? TenantId
+string? ApplicationName
+string? Identity
+string? Action
+Guid? UserId
+string? UserName
+DateTime CreationTime
+ExtraPropertyDictionary ExtraProperties
}
class EntityChange {
+Guid Id
+Guid AuditLogId
+DateTime ChangeTime
+EntityChangeType ChangeType
+string? EntityId
+string? EntityTypeFullName
+EntityPropertyChange[] PropertyChanges
}
AuditLog --> EntityChange : "包含"
AuditLog --> AuditLogAction : "包含"
SecurityLog --> ExtraPropertyDictionary : "实现"
AuditLog --> ExtraPropertyDictionary : "实现"

图示来源

  • AuditLog.cs
  • SecurityLog.cs
  • EntityChange.cs

管理器实现

sequenceDiagram
participant App as 应用程序
participant Manager as AuditLogManager
participant ES as ElasticsearchClient
participant Index as 索引管理器
App->>Manager : SaveAsync(auditInfo)
Manager->>ES : Create()
ES-->>Manager : 客户端实例
Manager->>Index : CreateIndex()
Index-->>Manager : 索引名称
Manager->>ES : IndexAsync(securityLog)
ES-->>Manager : 响应
Manager-->>App : 任务完成
Note over Manager,ES : 使用Elasticsearch存储审计日志

图示来源

  • ElasticsearchAuditLogManager.cs
  • ElasticsearchSecurityLogManager.cs

章节来源

  • ElasticsearchAuditLogManager.cs
  • ElasticsearchSecurityLogManager.cs

特性管理组件

特性管理组件提供了对审计功能的动态控制能力，支持按需启用或禁用不同类型的日志记录。

flowchart TD
Start([启动]) --> CheckFeature["检查特性配置"]
CheckFeature --> FeatureEnabled{"审计功能已启用?"}
FeatureEnabled --> |是| EnableLogging["启用日志记录"]
FeatureEnabled --> |否| DisableLogging["禁用日志记录"]
EnableLogging --> LogTypes["配置日志类型"]
LogTypes --> AuditLogEnabled{"审计日志启用?"}
LogTypes --> SecurityLogEnabled{"安全日志启用?"}
LogTypes --> SystemLogEnabled{"系统日志启用?"}
AuditLogEnabled --> |是| ConfigureAuditLog["配置审计日志"]
SecurityLogEnabled --> |是| ConfigureSecurityLog["配置安全日志"]
SystemLogEnabled --> |是| ConfigureSystemLog["配置系统日志"]
ConfigureAuditLog --> End
ConfigureSecurityLog --> End
ConfigureSystemLog --> End
DisableLogging --> End
style EnableLogging fill:#aqua,stroke:#333
style DisableLogging fill:#ffcccb,stroke:#333

图示来源

  • AuditingFeatureDefinitionProvider.cs

章节来源

  • AuditingFeatureDefinitionProvider.cs

依赖分析

系统依赖关系清晰，各组件之间通过接口进行通信，实现了良好的解耦。

graph TD
A[AbpAuditLoggingModule] --> B[AbpAuditingModule]
A --> C[AbpGuidsModule]
A --> D[AbpExceptionHandlingModule]
E[ElasticsearchAuditLogManager] --> F[IElasticsearchClientFactory]
E --> G[IIndexNameNormalizer]
E --> H[IAuditLogInfoToAuditLogConverter]
E --> I[IClock]
J[AbpLoggingSerilogElasticsearchModule] --> K[AbpElasticsearchModule]
J --> L[AbpAutoMapperModule]
J --> M[AbpJsonModule]
style A fill:#f9f,stroke:#333
style E fill:#bbf,stroke:#333
style J fill:#f96,stroke:#333

图示来源

  • AbpAuditLoggingModule.cs
  • AbpLoggingSerilogElasticsearchModule.cs

章节来源

  • AbpAuditLoggingModule.cs
  • AbpLoggingSerilogElasticsearchModule.cs

性能考虑

系统在设计时充分考虑了性能因素，通过异步操作、批量处理和索引优化等手段确保高并发场景下的稳定运行。

  • 异步写入: 所有日志写入操作均为异步执行，避免阻塞主业务流程
  • 批量处理: 支持批量日志写入，减少数据库连接开销
  • 索引优化: 针对常用查询字段建立Elasticsearch索引，提升查询效率
  • 缓存机制: 对频繁访问的日志数据进行缓存，降低数据库压力
  • 分页查询: 提供分页查询接口，避免一次性加载大量数据

故障排除指南

当遇到审计与监控相关问题时，可按照以下步骤进行排查：

  1. 检查特性配置: 确认审计功能是否已正确启用
  2. 验证Elasticsearch连接: 检查Elasticsearch集群是否可达
  3. 查看日志输出: 检查应用程序日志中是否有相关错误信息
  4. 确认索引状态: 验证Elasticsearch索引是否存在且状态正常
  5. 检查权限设置: 确保应用服务具有足够的权限访问日志数据

章节来源

  • DefaultAuditLogManager.cs
  • DefaultSecurityLogManager.cs

结论

本系统提供了一套完整的审计与监控解决方案，涵盖了从日志采集、存储到展示的全流程。通过模块化设计和Elasticsearch集成，实现了高性能、可扩展的安全审计能力。系统支持灵活的配置管理和实时监控，能够有效满足企业级应用的安全合规需求。