Skip to content

Commit f8a60af

Browse files
committed
add supported types
1 parent 294da75 commit f8a60af

File tree

2 files changed

+50
-57
lines changed

2 files changed

+50
-57
lines changed

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

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
Datalayers 提供数据库操作审计能力,可记录用户对数据库的查询、修改等操作。审计日志以文件形式存储,便于后续查询与分析。
44

5-
## 开启审计日志
6-
7-
审计日志功能默认关闭,需要在配置文件中进行启用和配置:
5+
## 配置示例
86

97
```toml
108
# 审计日志配置
@@ -24,13 +22,15 @@ path = "audit"
2422
max_files = 30
2523

2624
# 需要记录的审计日志类型,多个类型用逗号分隔
27-
# 支持的类型:"read"(查询操作)
25+
# 支持的类型:"read", "write", "ddl", "admin", "misc"
2826
# 特殊值:"all" 表示记录所有类型
2927
# 默认值:"ddl,admin"
3028
kinds = "ddl,admin"
3129

3230
# 需要记录的审计操作类型,多个操作用逗号分隔
33-
# 支持的操作:"select"(查询)、"update"(更新)等
31+
# 支持的操作:"update", "delete", "create", "alter", "drop", "truncate", "trim",
32+
# "desc", "show", "create_user", "drop_user", "set_password", "grant", "revoke",
33+
# "flush", "cluster", "migrate", "compact", "export", "misc",
3434
# 特殊值:"all" 表示记录所有操作
3535
# 默认值:"all"
3636
actions = "all"
@@ -43,15 +43,4 @@ actions = "all"
4343
- **max_files**: 控制日志文件轮转数量,避免磁盘空间过度占用
4444
- **kinds**: 精细化控制需要记录的日志类型,减少不必要的日志记录
4545
- **actions**: 根据实际安全需求,选择需要审计的具体数据库操作
46-
47-
## 查看审计日志
48-
49-
审计日志文件默认存储在以下目录:
50-
51-
``` text
52-
/var/lib/datalayers/audit
53-
```
54-
55-
您可以通过查看该目录下的日志文件来获取详细的审计信息。系统会按日期自动分割日志文件,便于管理和查询。
56-
57-
在生产环境中,建议根据实际安全合规要求,合理配置 kinds 和 actions 参数,平衡审计需求与系统性能。
46+
- 同时满足 **kinds****actions** 条件的日志才会被记录

zh_CN/user-security/audit-logs.md

Lines changed: 44 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,52 @@
11
# 审计日志
22

3-
Datalayers 提供数据库操作审计能力,可记录用户对数据库的查询、修改等操作。审计日志以文件形式存储,便于后续查询与分析。
3+
Datalayers 提供数据库操作审计能力,可记录用户对数据库的查询、修改等操作。审计日志以文件形式存储,每条记录采用 `JSON` 格式,便于后续查询与分析。
44

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-
```
5+
::: tip
6+
Datalayers 采用事件开始前记录审计日志的方式,审计日志的记录数有可能多于实际操作完成数。
7+
:::
388

39-
## 配置说明
9+
## 开启审计日志
4010

41-
- **enable**: 设置为 true 以启用审计日志功能
42-
- **path**: 指定日志存储路径,支持相对路径(基于 base_dir)或绝对路径
43-
- **max_files**: 控制日志文件轮转数量,避免磁盘空间过度占用
44-
- **kinds**: 精细化控制需要记录的日志类型,减少不必要的日志记录
45-
- **actions**: 根据实际安全需求,选择需要审计的具体数据库操作
11+
审计日志功能默认关闭,需要在配置文件中进行启用和配置,配置方法可参考 [配置审计日志](../admin/configuration-fields/audit-logs.md)
12+
13+
## 各操作的审计约束
14+
15+
| 操作 | kind | action |
16+
|-------------------|---------|---------|
17+
| UPDATE | write | update |
18+
| DELETE | write | delete |
19+
| CREATE ROLE | admin | create_user |
20+
| CREATE USER | admin | create_user |
21+
| DROP ROLE | admin | drop_user |
22+
| DROP USER | admin | drop_user |
23+
| GRANT | admin | grant |
24+
| REVOKE | admin | revoke |
25+
| SET PASSWORD | admin | set_password |
26+
| CREATE DATABASE | ddl | create |
27+
| DROP DATABASE | ddl | drop |
28+
| TRIM DATABASE | ddl | trim |
29+
| CREATE TABLE | ddl | create |
30+
| DROP TABLE | ddl | drop |
31+
| ALTER TABLE | ddl | alter |
32+
| TRUNCATE TABLE | ddl | truncate |
33+
| CREATE INDEX | ddl | alter |
34+
| DROP INDEX | ddl | alter |
35+
| FLUSH | admin | flush |
36+
| COMPACT | admin | compact |
37+
| EXPORT | admin | export |
38+
| EXCLUDE NODE | admin | cluster |
39+
| INCLUDE NODE | admin | cluster |
40+
| DROP NODE | admin | cluster |
41+
| REBALANCE | admin | migrate |
42+
| STOP MIGRATION | admin | migrate |
43+
| DESC TABLE | admin | desc |
44+
| SHOW | admin | show |
45+
46+
47+
::: tip
48+
目前不支持对 SELECT 和 INSERT 语句的审计。
49+
:::
4650

4751
## 查看审计日志
4852

0 commit comments

Comments
 (0)