Skip to content

Commit 294da75

Browse files
committed
minor
1 parent 13a4c0a commit 294da75

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

dir.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,9 @@
395395
- title_en: Log Configuration
396396
title_cn: 日志配置
397397
path: admin/configuration-fields/log
398+
- title_en: Audit logs
399+
title_cn: 审计日志
400+
path: admin/configuration-fields/audit-logs
398401
- title_en: License Configuration
399402
title_cn: License 配置
400403
path: admin/configuration-fields/license

en_US/admin/configuration-fields/audit-logs.md

Whitespace-only changes.
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# 审计日志
2+
3+
Datalayers 提供数据库操作审计能力,可记录用户对数据库的查询、修改等操作。审计日志以文件形式存储,便于后续查询与分析。
4+
5+
## 开启审计日志
6+
7+
审计日志功能默认关闭,需要在配置文件中进行启用和配置:
8+
9+
```toml
10+
# 审计日志配置
11+
[audit]
12+
# 是否启用审计日志功能
13+
# 默认值:false
14+
enable = true
15+
16+
# 审计日志文件存储目录
17+
# 路径相对于 `base_dir` 配置项
18+
# 默认值:"audit"
19+
path = "audit"
20+
21+
# 审计日志文件最大保留数量
22+
# 系统每日生成新的日志文件
23+
# 默认值:30
24+
max_files = 30
25+
26+
# 需要记录的审计日志类型,多个类型用逗号分隔
27+
# 支持的类型:"read"(查询操作)
28+
# 特殊值:"all" 表示记录所有类型
29+
# 默认值:"ddl,admin"
30+
kinds = "ddl,admin"
31+
32+
# 需要记录的审计操作类型,多个操作用逗号分隔
33+
# 支持的操作:"select"(查询)、"update"(更新)等
34+
# 特殊值:"all" 表示记录所有操作
35+
# 默认值:"all"
36+
actions = "all"
37+
```
38+
39+
## 配置说明
40+
41+
- **enable**: 设置为 true 以启用审计日志功能
42+
- **path**: 指定日志存储路径,支持相对路径(基于 base_dir)或绝对路径
43+
- **max_files**: 控制日志文件轮转数量,避免磁盘空间过度占用
44+
- **kinds**: 精细化控制需要记录的日志类型,减少不必要的日志记录
45+
- **actions**: 根据实际安全需求,选择需要审计的具体数据库操作
46+
47+
## 查看审计日志
48+
49+
审计日志文件默认存储在以下目录:
50+
51+
``` text
52+
/var/lib/datalayers/audit
53+
```
54+
55+
您可以通过查看该目录下的日志文件来获取详细的审计信息。系统会按日期自动分割日志文件,便于管理和查询。
56+
57+
在生产环境中,建议根据实际安全合规要求,合理配置 kinds 和 actions 参数,平衡审计需求与系统性能。

0 commit comments

Comments
 (0)