PS-10193 [DOCS] - Update Audit Log Filter variables, options in 8.0 #575
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
1dd9fc8 to
4c0ad75
Compare
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
4c0ad75 to
96d9724
Compare
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
96d9724 to
1ecc915
Compare
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
1ecc915 to
c6873aa
Compare
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
c6873aa to
6da6429
Compare
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
6da6429 to
89f34e5
Compare
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
89f34e5 to
2b76817
Compare
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
2b76817 to
718097f
Compare
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
718097f to
35ef1d9
Compare
it-percona
temporarily deployed
to
ps-10193-8.0 - percona-server-docs-8.0 PR #575
Render
Destroyed
Your branch is up to date with 'origin/8.0'. modified: docs/audit-log-filter-variables.md
patrickbirch
force-pushed
the
ps-10193-8.0
branch
from
35ef1d9 to
7a240fc
Compare
| Audit‑log functions always accept and return strings in `utf8mb4`. | ||
|
|
||
| The following audit log filter functions are available. | ||
| !!! warning "Plugin Compatibility" |
There was a problem hiding this comment.
Plugin compatibility
|
|
||
| The following sections describe the audit log filter plugin functionality organized by purpose: | ||
|
|
||
| ## Plugin Management |
There was a problem hiding this comment.
Plugin management
| | [`audit_log_filter_disable`](#audit_log_filter_disable) | Variable | Disable plugin logging | | ||
|
|
||
| `keyring_id` - If the function does not contain a keyring_id, the function returns the current encryption password. You can also request a specific encryption password with the keyring ID of either the current password or an archived password. | ||
| ## Filter Management |
There was a problem hiding this comment.
Filter management
| | [`audit_log_filter_filter_id`](#audit_log_filter_filter_id) | Variable | Current session filter ID | | ||
|
|
||
| #### Example | ||
| ## Log Reading and Navigation |
There was a problem hiding this comment.
Log reading and navigation
| | {"password":"passw0rd","iterations":5689} | | ||
| +---------------------------------------------+ | ||
| ``` | ||
| ## Log File Management |
There was a problem hiding this comment.
Log file management
| #### Parameters | ||
|
|
||
| If this function is used with [`audit_log_read()](#audit_log_read), the `audit_log_read()` function starts reading at that position. | ||
| * `filter_name` - a selected filter name as a string. |
There was a problem hiding this comment.
We should have the same format everywhere. Previously, the first word after the hyphen started with a capital letter, for example, * ON - Load the plugin if it is available (line 123), * FORCE - Load the plugin even if it has been disabled (line 127)
I suggest using lowercase after the hyphen everywhere.
| * `filter_name` - a selected filter name as a string. | ||
|
|
||
| #### Parameters | ||
| * `definition` - The filter definition as a `JSON` value. The `JSON` structure defines |
There was a problem hiding this comment.
Use lowercase after the hyphen since the previous bullet also uses lowercase
filter_name - a selected filter name as a string.
| The new filter has a different filter ID. Generates an error if the filter name exists. | ||
| The default value is 0 (zero) - the session has no assigned filter. | ||
|
|
||
| ## Log Reading and Navigation |
There was a problem hiding this comment.
Log reading and navigation
| * OFF | ||
| * FORCE | ||
| * FORCE_PLUS_PERMANENT | ||
| ## Log File Management |
There was a problem hiding this comment.
Log file management
| | SYNCHRONOUS | Calls sync() after each event (safest, slowest performance) | | ||
|
|
||
| Pruning requires the following options: | ||
| ## Encryption and Security |
There was a problem hiding this comment.
Encryption and security
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Your branch is up to date with 'origin/8.0'.
modified: docs/audit-log-filter-variables.md