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.
|
|
1 month ago | |
|---|---|---|
| .. | ||
| LINGYUN.Abp.AspNetCore.Auditing | 1 month ago | |
| LINGYUN.Abp.AuditLogging | 1 month ago | |
| LINGYUN.Abp.AuditLogging.Elasticsearch | 1 month ago | |
| LINGYUN.Abp.AuditLogging.EntityFrameworkCore | 1 month ago | |
| LINGYUN.Abp.AuditLogging.IP.Location | 1 month ago | |
| LINGYUN.Abp.AuditLogging.OpenObserve | 1 month ago | |
| README.md | 1 month ago | |
README.md
LINGYUN.Abp 审计模块
模块概述
审计模块提供了全面的日志记录和审计功能,支持多种存储方式和高度可配置的审计选项。
功能特性
核心功能
- 审计日志基础设施
- 审计日志仓储接口定义
- 审计日志管理器接口定义
- 支持忽略特定类型的审计日志记录
存储支持
- EntityFrameworkCore 实现
- Elasticsearch 实现
- OpenObserve 实现
注意: Elastic库限制, 兼容8.x; 9.x版本, 如需使用10.x版本, 请切换 Elastic.Clients.Elasticsearch 为9.x版本 参考: https://www.nuget.org/packages/Elastic.Clients.Elasticsearch#readme-body-tab
模块引用
核心模块
[DependsOn(typeof(AbpAuditLoggingModule))]
public class YouProjectModule : AbpModule
{
// other
}
EntityFrameworkCore 模块
[DependsOn(typeof(AbpAuditLoggingEntityFrameworkCoreModule))]
public class YouProjectModule : AbpModule
{
// other
}
Elasticsearch 模块
[DependsOn(typeof(AbpAuditLoggingElasticsearchModule))]
public class YouProjectModule : AbpModule
{
// other
}
OpenObserve 模块
[DependsOn(typeof(AbpAuditLoggingOpenObserveModule))]
public class YouProjectModule : AbpModule
{
// other
}
配置选项
审计日志配置
{
"Auditing": {
"IsEnabled": true, // 是否启用审计日志
"HideErrors": true, // 是否隐藏错误信息
"IsEnabledForAnonymousUsers": true, // 是否为匿名用户启用审计日志
"IsEnabledForGetRequests": false, // 是否为GET请求启用审计日志
"ApplicationName": null // 应用程序名称
},
// 审计日志增强配置
"AuditLogging": {
"IsAuditLogEnabled": true, // 是否启用审计日志记录
"UseAuditLogQueue": true, // 使用审计日志队列, 不启用队列则直接写入到持久化设施
"MaxAuditLogQueueSize": 10000, // 审计日志最大队列大小, 默认10000
"BatchAuditLogSize": 100, // 一次处理审计日志队列大小, 队列中同时写入100条记录后立即写入到持久化设施中
"IsSecurityLogEnabled": true, // 是否启用安全日志记录
"UseSecurityLogQueue": true, // 使用安全日志队列, 不启用队列则直接写入到持久化设施
"MaxSecurityLogQueueSize": 10000, // 安全日志最大队列大小, 默认10000
"BatchSecurityLogSize": 100 // 一次处理安全日志队列大小, 队列中同时写入100条记录后立即写入到持久化设施中
}
}
Elasticsearch 配置
{
"AuditLogging": {
"Elasticsearch": {
"IndexPrefix": "auditlogging", // 索引前缀
"ThrowIfIndexInitFailed": true // 索引初始化失败抛出异常, 默认为: true, 索引初始化失败后应用程序停止运行
}
}
}
OpenObserve 配置
{
"OpenObserve": {
"Endpoint": "http://localhost:5080", // OpenObserve 服务地址
"Organization": "default", // 组织名称
"AccessToken": "Basic XXXXXXXXXXX" // 授权头, 或使用 UserName/Password
},
"AuditLogging": {
"OpenObserve": {
"Organization": null, // 数据流所属组织, 为空时使用 OpenObserve:Organization
"AuditLogStream": "audit_log", // 审计日志主数据流(根)
"SecurityLogStream": "security_log", // 安全日志数据流
"WriteEntityChanges": true, // 是否把实体变更展平写入 {AuditLogStream}_entity_changes
"WriteActions": true, // 是否把操作展平写入 {AuditLogStream}_actions
"DefaultQueryDays": 365, // 未指定时间范围时的默认查询跨度(天)
"UseLogTimeAsTimestamp": true, // 是否用日志业务时间覆盖 _timestamp
"TimestampAllowedUptoHours": 5 // 覆盖 _timestamp 的最大回溯小时数, 需与服务端 ZO_INGEST_ALLOWED_UPTO 一致
}
}
}
子数据流名称由
AuditLogStream计算(实体变更 ={AuditLogStream}_entity_changes, 操作 ={AuditLogStream}_actions), 无需单独配置。
数据库连接配置
{
"ConnectionStrings": {
"AbpIdentity": "Server=127.0.0.1;Database=Identity;User Id=root;Password=*",
"AbpAuditLogging": "Server=127.0.0.1;Database=AuditLogging;User Id=root;Password=*"
}
}
高级功能
忽略特定类型
默认情况下,模块会忽略以下类型的审计日志:
- CancellationToken
- CancellationTokenSource
你可以通过配置添加更多需要忽略的类型:
Configure<AbpAuditingOptions>(options =>
{
options.IgnoredTypes.AddIfNotContains(typeof(YourType));
});
特殊说明
- Elasticsearch 实现支持跨租户,将根据租户自动切换索引
- EntityFrameworkCore 实现主要作为桥梁,具体实现交由 Abp 官方模块管理
- OpenObserve 实现同样按租户隔离数据流,租户数据流形如
audit_log_{tenantId:N}:写入按日志自身的租户,查询按当前租户,命名规则可通过IOpenObserveStreamNameNormalizer覆写 - OpenObserve 为 append-only 存储且不支持 SQL
DELETE/UPDATE,因此IAuditLogManager.DeleteAsync/DeleteManyAsync会抛出业务异常AuditLoggingOpenObserve:010001("当前日志设施不支持删除记录!"),数据清理请在 OpenObserve 侧配置保留策略或使用其按时间范围删除接口 - OpenObserve 会把嵌套数组保存为 JSON 字符串列(列名即字段名),因此实体变更与操作分别展平写入独立数据流;操作的
Actions.*条件采用两段式查询(先在操作数据流匹配auditlogid,再回主数据流按id in (...)过滤) - 数据流由 OpenObserve 在首次写入时自动创建,模块不探测、不创建、不修改数据流设置;查询尚未创建的数据流时返回空结果并记录警告日志