You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/audit-log-filter-restrictions.md
+11-4Lines changed: 11 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,17 @@
4
4
5
5
The Audit Log Filter has the following general restrictions:
6
6
7
-
* Logs only SQL statements. Statements made by NoSQL APIs, such as the Memcached API, are not logged.
7
+
The Audit Log Filter has the following general restrictions:
8
+
9
+
* Log only SQL statements. Statements made by NoSQL APIs, such as the
10
+
Memcached API, are not logged.
8
11
9
-
* Logs only the top-level statement. Statements within a stored procedure or a trigger are not logged. Does not log the file contents for statements like `LOAD_DATA`.
12
+
* Log only the top-level statement. Statements within a stored procedure
13
+
or a trigger are not logged. Do not log the file contents for statements
14
+
like `LOAD_DATA`.
10
15
11
-
* If used with a cluster, the component must be installed on each server used to execute SQL on the cluster.
16
+
* Require the component to be installed on each server used to execute SQL
17
+
on the cluster if used with a cluster.
12
18
13
-
* If used with a cluster, the application or user is responsible for aggregating all the data of each server used in the cluster.
19
+
* Hold the application or user responsible for aggregating all the data from
20
+
each server used in the cluster if used with a cluster.
@@ -505,7 +505,7 @@ This option does nothing when used with other format types.
505
505
506
506
Defines where the component writes the audit log filter file. The following values are available:
507
507
508
-
*`FILE` - component writes the log to a location specified in [`audit_log_filter.file`](#audit_log_filter_file)
508
+
*`FILE` - component writes the log to a location specified in [`audit_log_filter.file`](#audit_log_filterfile)
509
509
*`SYSLOG` - component writes to the syslog
510
510
511
511
@@ -547,13 +547,15 @@ A value greater than 0 (zero) enables pruning based on size and defines the comb
547
547
548
548
The value is based on 4096 (block size). A value is truncated to the nearest multiple of the block size. If the value is less than 4096, the value is treated as 0 (zero).
549
549
550
-
If the values for `audit_log_filter.rotate_on_size` and `audit_log_filter.max_size` are greater than 0, we recommend that `audit_log_filter.max_size` value should be at least seven times the `audit_log_filter.rotate_on_size` value.
550
+
If the values for [`audit_log_filter.rotate_on_size`](#audit_log_filterrotate_on_size) and [`audit_log_filter.max_size`](#audit_log_filtermax_size) are greater than 0, we recommend that `audit_log_filter.max_size` value should be at least seven times the `audit_log_filter.rotate_on_size` value.
@@ -574,7 +576,7 @@ The default value is 0 (zero). This value disables the expiration of passwords.
574
576
575
577
If the component starts and encryption is enabled, the component checks for an audit log filter encryption password. If a password is not found, the component generates a random password.
576
578
577
-
Call `audit_log_filter_encryption_set()` to set a specific password.
579
+
Call [`audit_log_filter_encryption_set()`](#audit_log_filter_encryption_set) to set a specific password.
578
580
579
581
580
582
### `audit_log_filter.prune_seconds`
@@ -598,8 +600,8 @@ A value greater than 0 enables pruning. An audit log filter file can be pruned a
598
600
599
601
To enable log pruning, you must set one of the following:
600
602
601
-
* Enable log rotation by setting `audit_log_filter.rotate_on_size`
602
-
* Add a value greater than 0 (zero) for either `audit_log_filter.max_size` or `audit_log_filter.prune_seconds`
603
+
* Enable log rotation by setting [`audit_log_filter.rotate_on_size`](audit_log_filterrotate_on_size)
604
+
* Add a value greater than 0 (zero) for either [`audit_log_filter.max_size`](audit_log_filtermax_size) or [`audit_log_filter.prune_seconds`](audit_log_filterprune_seconds)
603
605
604
606
605
607
### `audit_log_filter.read_buffer_size`
@@ -615,7 +617,7 @@ To enable log pruning, you must set one of the following:
615
617
616
618
This option is only supported for JSON-format files.
617
619
618
-
The size of the buffer for reading from the audit log filter file. The `audit_log_filter_read()` reads only from this buffer size.
620
+
The size of the buffer for reading from the audit log filter file. The [`audit_log_filter_read()`](audit_log_filter_read) reads only from this buffer size.
*[`audit_log_read_bookmark()](audit-log-filter-variables.md#audit_log_read_bookmark) - for the most recently read event, returns a bookmark. The bookmark can be passed to `audit_log_read()`.
12
+
13
+
*[`audit_log_read_bookmark`](audit-log-filter-variables.md#audit_log_read_bookmark) - for the most recently read event, returns a bookmark. This bookmark can be passed to `audit_log_read()`.
13
14
14
15
Initialize a read sequence by using a bookmark or an argument that specifies the start position:
0 commit comments