Skip to content

PS [DOCS] - audit log filter updates 8.4#702

Open
patrickbirch wants to merge 4 commits into
8.4from
ps-audit-update-8.4
Open

PS [DOCS] - audit log filter updates 8.4#702
patrickbirch wants to merge 4 commits into
8.4from
ps-audit-update-8.4

Conversation

@patrickbirch

@patrickbirch patrickbirch commented Apr 7, 2026

Copy link
Copy Markdown
Collaborator

docs/audit-log-filter-formats.md
docs/audit-log-filter-json.md
docs/audit-log-filter-naming.md
docs/audit-log-filter-new.md
docs/audit-log-filter-overview.md
docs/audit-log-filter-restrictions.md
docs/audit-log-filter-security.md
docs/audit-log-filter-variables.md
docs/filter-audit-log-filter-files.md
docs/index-contents.md
docs/index.md
docs/manage-audit-log-filter.md
docs/reading-audit-log-filter-files.md
docs/write-filter-definitions.md
mkdocs-base.yml

@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from b8c8d84 to 0236849 Compare April 7, 2026 15:50
@patrickbirch patrickbirch changed the title Ps audit update 8.4 PS [DOCS] - audit log filter updates 8.4 Apr 7, 2026
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from 0236849 to 54e525f Compare April 7, 2026 20:01
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from 54e525f to 068ebde Compare April 7, 2026 20:04
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from 068ebde to b1e70ea Compare April 7, 2026 20:27
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from b1e70ea to 3254689 Compare April 7, 2026 20:55
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from 3254689 to 9678207 Compare April 7, 2026 20:55
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from 9678207 to d3ddba4 Compare April 7, 2026 22:31
@patrickbirch patrickbirch requested a review from inikep April 8, 2026 08:42
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from d3ddba4 to d3a4631 Compare April 8, 2026 09:38
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from d3a4631 to 9f239ec Compare April 8, 2026 11:06
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from 9f239ec to 9fc9bc8 Compare April 8, 2026 11:16
@patrickbirch patrickbirch force-pushed the ps-audit-update-8.4 branch from 9fc9bc8 to c06bf55 Compare April 8, 2026 13:19

@inikep inikep left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the audit_log_filter doc updates against the component source at components/audit_log_filter/ (PS 8.4). The bulk of the changes — system variables, UDFs, filter-definition JSON, formats, encryption/compression, file naming, and migration — verify correctly against the source.

Four factual errors need fixing (inline):

  1. install-audit-log-filter.mdINSTALL COMPONENT 'file://audit_log_filter' is missing the component_ prefix; as written it fails to load.
  2. block-statements-with-audit-filter.md — "Blocked statements are still logged" is backwards; blocked events go to the server error log, not the audit log.
  3. block-statements-with-audit-filter.md — the "Not every event is abortable" section describes a "Can be Aborted" column and an abortability gate that don't exist in the docs or the component.
  4. audit-log-filter-old.md — the OLD "Optional attributes" table lists five NEW-format-only elements (MYSQL_VERSION, OS_VERSION, STARTUP_OPTIONS, STATUS_CODE, VERSION).

Details and source citations are in the line comments.

Comment thread docs/install-audit-log-filter.md Outdated
Comment thread docs/block-statements-with-audit-filter.md Outdated
Comment thread docs/block-statements-with-audit-filter.md Outdated
Comment thread docs/audit-log-filter-old.md Outdated
# Audit Log Filter overview

The Audit Log Filter component allows you to monitor, log, and block a connection or query actively executed on the selected server.
The Audit Log Filter component records, audits, and can block matching connections or statements on the server you configure.

@inikep inikep Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like wording from upstream. We don't block anything. We just skip (don't log) events:
▎ The Audit Log Filter component audits activity on the server you configure by recording events to a
▎ log. Filtering rules control which events are recorded — matching connections and statements are
▎ either logged or excluded.

Comment thread docs/audit-log-filter-formats.md Outdated
Comment thread docs/audit-log-filter-formats.md Outdated

@inikep inikep left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Follow-up on the redact-audit-log-fields.md page: one factual correction on the count of replaceable fields (inline). The rest of the page verifies correctly against the component source.

Comment thread docs/redact-audit-log-fields.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants