Skip to content

Commit 4ad68db

Browse files
shiyuhang0github-actions[bot]zhangyangyu
authored
Audit log filter (#280)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: zhangyangyu <angwerzx@126.com>
1 parent 9637095 commit 4ad68db

38 files changed

+4056
-278
lines changed

‎docs/generate_doc/ticloud_serverless_audit-log.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ Manage TiDB Cloud Serverless database audit logging
2121
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
2222
* [ticloud serverless audit-log config](ticloud_serverless_audit-log_config.md) - Configure the database audit logging
2323
* [ticloud serverless audit-log describe](ticloud_serverless_audit-log_describe.md) - Describe the database audit logging configuration
24-
* [ticloud serverless audit-log disable](ticloud_serverless_audit-log_disable.md) - Disable the database audit logging
2524
* [ticloud serverless audit-log download](ticloud_serverless_audit-log_download.md) - Download the database audit logs
26-
* [ticloud serverless audit-log enable](ticloud_serverless_audit-log_enable.md) - Enable the database audit logging
25+
* [ticloud serverless audit-log filter-rule](ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
2726

‎docs/generate_doc/ticloud_serverless_audit-log_config.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,22 @@ ticloud serverless audit-log config [flags]
1313
$ ticloud serverless audit-log config
1414
1515
Unredacted the database audit logging in non-interactive mode:
16-
$ ticloud serverless audit-log config -c <cluster-id> --auditlog.unredacted
16+
$ ticloud serverless audit-log config -c <cluster-id> --unredacted
17+
18+
Enable the database audit logging in non-interactive mode:
19+
$ ticloud serverless audit-log config -c <cluster-id> --enabled
20+
21+
Disable the database audit logging in non-interactive mode:
22+
$ ticloud serverless audit-log config -c <cluster-id> --enabled=false
1723
```
1824

1925
### Options
2026

2127
```
2228
-c, --cluster-id string The ID of the cluster to be updated.
29+
--enabled enable or disable the database audit logging.
2330
-h, --help help for config
24-
--unredacted Unredacted the database audit logging.
31+
--unredacted unredacted or redacted the database audit logging.
2532
```
2633

2734
### Options inherited from parent commands

‎docs/generate_doc/ticloud_serverless_audit-log_filter-rule.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## ticloud serverless audit-log filter-rule
2+
3+
Manage TiDB Cloud Serverless database audit logging filter rules
4+
5+
### Options
6+
7+
```
8+
-h, --help help for filter-rule
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
-D, --debug Enable debug mode
15+
--no-color Disable color output
16+
-P, --profile string Profile to use from your configuration file
17+
```
18+
19+
### SEE ALSO
20+
21+
* [ticloud serverless audit-log](ticloud_serverless_audit-log.md) - Manage TiDB Cloud Serverless database audit logging
22+
* [ticloud serverless audit-log filter-rule create](ticloud_serverless_audit-log_filter-rule_create.md) - Create an audit log filter rule
23+
* [ticloud serverless audit-log filter-rule delete](ticloud_serverless_audit-log_filter-rule_delete.md) - Delete an audit log filter rule
24+
* [ticloud serverless audit-log filter-rule describe](ticloud_serverless_audit-log_filter-rule_describe.md) - Describe an audit log filter rule
25+
* [ticloud serverless audit-log filter-rule list](ticloud_serverless_audit-log_filter-rule_list.md) - List audit log filter rules
26+
* [ticloud serverless audit-log filter-rule template](ticloud_serverless_audit-log_filter-rule_template.md) - Show audit log filter rule templates
27+
* [ticloud serverless audit-log filter-rule update](ticloud_serverless_audit-log_filter-rule_update.md) - Update an audit log filter rule
28+

‎docs/generate_doc/ticloud_serverless_audit-log_filter-rule_create.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## ticloud serverless audit-log filter-rule create
2+
3+
Create an audit log filter rule
4+
5+
```
6+
ticloud serverless audit-log filter-rule create [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Create a filter rule in interactive mode:
13+
$ ticloud serverless audit-log filter create
14+
15+
Create a filter rule which filters all audit logs in non-interactive mode:
16+
$ ticloud serverless audit-log filter create --cluster-id <cluster-id> --name <rule-name> --rule '{"users":["%@%"],"filters":[{}]}'
17+
18+
Create a filter rule which filters QUERY and EXECUTE for test.t and filter QUERY for all tables in non-interactive mode:
19+
$ ticloud serverless audit-log filter create --cluster-id <cluster-id> --name <rule-name> --rule '{"users":["%@%"],"filters":[{"classes":["QUERY","EXECUTE"],"tables":["test.t"]},{"classes":["QUERY"]}]}'
20+
21+
```
22+
23+
### Options
24+
25+
```
26+
-c, --cluster-id string The ID of the cluster.
27+
-h, --help help for create
28+
--name string The name of the filter rule.
29+
--rule string Filter rule expressions, use "ticloud serverless audit-log filter template" to see filter templates.
30+
```
31+
32+
### Options inherited from parent commands
33+
34+
```
35+
-D, --debug Enable debug mode
36+
--no-color Disable color output
37+
-P, --profile string Profile to use from your configuration file
38+
```
39+
40+
### SEE ALSO
41+
42+
* [ticloud serverless audit-log filter-rule](ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
43+

‎docs/generate_doc/ticloud_serverless_audit-log_filter-rule_delete.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## ticloud serverless audit-log filter-rule delete
2+
3+
Delete an audit log filter rule
4+
5+
```
6+
ticloud serverless audit-log filter-rule delete [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Delete an audit log filter rule in interactive mode:
13+
$ ticloud serverless audit-log filter delete
14+
15+
Delete an audit log filter rule in non-interactive mode:
16+
$ ticloud serverless audit-log filter delete --cluster-id <cluster-id> --name <rule-name>
17+
18+
```
19+
20+
### Options
21+
22+
```
23+
-c, --cluster-id string The ID of the cluster.
24+
--force Delete a cluster without confirmation.
25+
-h, --help help for delete
26+
--name string The name of the filter rule.
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-D, --debug Enable debug mode
33+
--no-color Disable color output
34+
-P, --profile string Profile to use from your configuration file
35+
```
36+
37+
### SEE ALSO
38+
39+
* [ticloud serverless audit-log filter-rule](ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
40+

‎docs/generate_doc/ticloud_serverless_audit-log_filter-rule_describe.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## ticloud serverless audit-log filter-rule describe
2+
3+
Describe an audit log filter rule
4+
5+
```
6+
ticloud serverless audit-log filter-rule describe [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Describe an audit log filter rule in interactive mode:
13+
$ ticloud serverless audit-log filter describe
14+
15+
Describe an audit log filter rule in non-interactive mode:
16+
$ ticloud serverless audit-log filter describe --cluster-id <cluster-id> --name <rule-name>
17+
18+
```
19+
20+
### Options
21+
22+
```
23+
-c, --cluster-id string The ID of the cluster.
24+
-h, --help help for describe
25+
--name string The name of the filter rule.
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-D, --debug Enable debug mode
32+
--no-color Disable color output
33+
-P, --profile string Profile to use from your configuration file
34+
```
35+
36+
### SEE ALSO
37+
38+
* [ticloud serverless audit-log filter-rule](ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
39+

‎docs/generate_doc/ticloud_serverless_audit-log_filter-rule_disable.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## ticloud serverless audit-log filter-rule disable
2+
3+
Disable an audit log filter rule
4+
5+
```
6+
ticloud serverless audit-log filter-rule disable [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Disable an audit log filter rule in interactive mode:
13+
$ ticloud serverless auditlog filter-rule disable
14+
15+
Disable an audit log filter rule in non-interactive mode:
16+
$ ticloud serverless auditlog filter-rule disable --cluster-id <cluster-id> --rule-name <rule-name>
17+
18+
```
19+
20+
### Options
21+
22+
```
23+
-c, --cluster-id string The ID of the cluster.
24+
-h, --help help for disable
25+
--rule-name string The name of the filter rule.
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-D, --debug Enable debug mode
32+
--no-color Disable color output
33+
-P, --profile string Profile to use from your configuration file
34+
```
35+
36+
### SEE ALSO
37+
38+
* [ticloud serverless audit-log filter-rule](ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
39+

‎docs/generate_doc/ticloud_serverless_audit-log_filter-rule_enable.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## ticloud serverless audit-log filter-rule enable
2+
3+
Enable an audit log filter rule
4+
5+
```
6+
ticloud serverless audit-log filter-rule enable [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Enable an audit log filter rule in interactive mode:
13+
$ ticloud serverless auditlog filter-rule enable
14+
15+
Enable an audit log filter rule in non-interactive mode:
16+
$ ticloud serverless auditlog filter-rule enable --cluster-id <cluster-id> --rule-name <rule-name>
17+
18+
```
19+
20+
### Options
21+
22+
```
23+
-c, --cluster-id string The ID of the cluster.
24+
-h, --help help for enable
25+
--rule-name string The name of the filter rule.
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-D, --debug Enable debug mode
32+
--no-color Disable color output
33+
-P, --profile string Profile to use from your configuration file
34+
```
35+
36+
### SEE ALSO
37+
38+
* [ticloud serverless audit-log filter-rule](ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
39+

‎docs/generate_doc/ticloud_serverless_audit-log_filter-rule_list.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## ticloud serverless audit-log filter-rule list
2+
3+
List audit log filter rules
4+
5+
```
6+
ticloud serverless audit-log filter-rule list [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
List all audit log filter rules in interactive mode:
13+
$ ticloud serverless audit-log filter list
14+
15+
List all audit log filter rules in non-interactive mode:
16+
$ ticloud serverless audit-log filter list -c <cluster-id>
17+
18+
List all audit log filter rules with json format in non-interactive mode:
19+
$ ticloud serverless audit-log filter list -c <cluster-id> -o json
20+
```
21+
22+
### Options
23+
24+
```
25+
-c, --cluster-id string The cluster ID of the audit log filter rules to be listed.
26+
-h, --help help for list
27+
-o, --output string Output format, one of ["human" "json"]. For the complete result, please use json format. (default "human")
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-D, --debug Enable debug mode
34+
--no-color Disable color output
35+
-P, --profile string Profile to use from your configuration file
36+
```
37+
38+
### SEE ALSO
39+
40+
* [ticloud serverless audit-log filter-rule](ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
41+

‎docs/generate_doc/ticloud_serverless_audit-log_filter-rule_template.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## ticloud serverless audit-log filter-rule template
2+
3+
Show audit log filter rule templates
4+
5+
```
6+
ticloud serverless audit-log filter-rule template [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Show filter templates in interactive mode:
13+
$ ticloud serverless audit-log filter template
14+
15+
Show filter templates in non-interactive mode:
16+
$ ticloud serverless audit-log filter template --cluster-id <cluster-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --cluster-id string The ID of the cluster.
23+
-h, --help help for template
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-D, --debug Enable debug mode
30+
--no-color Disable color output
31+
-P, --profile string Profile to use from your configuration file
32+
```
33+
34+
### SEE ALSO
35+
36+
* [ticloud serverless audit-log filter-rule](ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
37+

0 commit comments

Comments
 (0)