Skip to content

PS-10333 [DOCS] Minimum and maximum values should be mentioned for au… #638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
patrickbirch wants to merge 1 commit into
base: 8.0
Choose a base branch
from
Open

PS-10333 [DOCS] Minimum and maximum values should be mentioned for au… #638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/audit-log-filter-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,8 @@ mysql> SELECT audit_log_read_bookmark();
| Data type | Integer |
| Unit | Bytes |
| Default | 32768 |
| Minimum value | 0 |
| Maximum value | 18446744073709551615 |

This option is only supported for JSON-format files.

Expand Down Expand Up @@ -611,6 +613,10 @@ Pruning requires the following options:
| Scope | Global |
| Data type | Integer |
| Default | 1GB |
| Minimum value | 0 |
| Maximum value | 18446744073709551615 |
| Unit | bytes |
| Block size | 4096 |

Performs an automatic log file rotation based on the size. The default value is 1GB. If the value is greater than 0, when the log file size exceeds the value, the plugin renames the current file and opens a new log file using the original name.

Expand All @@ -626,7 +632,7 @@ If you set the value to less than 4096, the plugin does not automatically rotate
| Data type | Integer |
| Default | 0 |
| Minimum value | 0 |
| Maximum value | 1844674073709551615 |
| Maximum value | 18446744073709551615 |
| Unit | seconds |

Defines when the audit log filter file is pruned. This pruning is based on the age of the file. The value is measured in seconds.
Expand Down Expand Up @@ -904,6 +910,9 @@ For high-security environments, consider increasing this value to 100000 or high
| Scope | Global |
| Data type | Integer |
| Default | 0 |
| Minimum value | 0 |
| Maximum value | 18446744073709551615 |
| Unit | days |

Defines when passwords may be removed and measured in days.

Expand Down
24 changes: 20 additions & 4 deletions docs/audit-log-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ As of [Percona Server for MySQL 8.4.7-7](https://docs.percona.com/percona-server

The audit Log plugin is installed, but, by default, is not enabled when you install Percona Server for MySQL. To check if the plugin is enabled run the following command. This command searches for plugins with names containing the word "audit" in the `information_schema.PLUGINS` table.

```{.bash data-prompt="mysql>"}
mysql> SELECT * FROM information_schema.PLUGINS WHERE PLUGIN_NAME LIKE '%audit%';
```sql
SELECT * FROM information_schema.PLUGINS WHERE PLUGIN_NAME LIKE '%audit%';
```

The empty result suggests that no such plugins are installed or loaded.
Expand Down Expand Up @@ -699,8 +699,14 @@ When this variable is set to `ON` log file will be closed and reopened.
| Dynamic: | No |
| Data type | Numeric |
| Default value | 1 Mb |
| Minimum value | 4096 |
| Maximum value | 1073741824 (1 GB) |
| Unit | bytes |
| Block size | 4096 |

This variable specifies the size of the memory buffer used for logging. It is only effective when `audit_log_strategy` is set to `ASYNCHRONOUS` or `PERFORMANCE` and `audit_log_handler` is set to `FILE`.

This variable can be used to specify the size of memory buffer used for logging, used when audit_log_strategy variable is set to `ASYNCHRONOUS` or `PERFORMANCE` values. This variable has effect only when audit_log_handler is set to `FILE`.
The value is automatically rounded to the nearest multiple of 4096.

### `audit_log_exclude_accounts`

Expand Down Expand Up @@ -831,13 +837,19 @@ are:
| Dynamic: | Yes |
| Data type | Numeric |
| Default value | 0 |
| Minimum value | 0 |
| Maximum value | 18446744073709551615 |
| Unit | bytes |
| Block size | 4096 |

This variable is measured in bytes and specifies the maximum size of the audit log file. Upon reaching
this size, the audit log will be rotated. The rotated log files are present in
the same directory as the current log file. The sequence number is appended to
the log file name upon rotation.

If the value is set to 0 (the default), the audit log files won’t rotate.
If the value is set to 0 (the default), the audit log files won't rotate.

If you set the value to less than 4096, the plugin does not automatically rotate the log files. If the value is not a multiple of 4096, the plugin truncates the value to the nearest multiple.

Set the `audit_log_handler` to FILE to enable this variable.

Expand All @@ -850,11 +862,15 @@ Set the `audit_log_handler` to FILE to enable this variable.
| Dynamic: | Yes |
| Data type | Numeric |
| Default value | 0 |
| Minimum value | 0 |
| Maximum value | 100 |

This variable is used to specify how many log files should be kept when
audit_log_rotate_on_size variable is set to non-zero value. This
variable has effect only when audit_log_handler is set to `FILE`.

The maximum value is typically capped at 100 to prevent excessive file handle or disk overhead, though some internal implementations may allow up to 4294967295.

### `audit_log_handler`

| Option | Description |
Expand Down
Loading