Skip to content

Commit

Permalink
Merge pull request #412 from percona/ps-9518
Browse files Browse the repository at this point in the history
PS-9518 Mark audit log filter GA in 8.0
  • Loading branch information
patrickbirch authored Oct 25, 2024
2 parents b7572ed + cef00e5 commit 903b229
Show file tree
Hide file tree
Showing 16 changed files with 0 additions and 32 deletions.
2 changes: 0 additions & 2 deletions docs/audit-log-filter-compression-encryption.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter compression and encryption

The feature is in [tech preview](glossary.md#tech-preview).

## Compression

You can enable compression for any [format](audit-log-filter-formats.md) by setting the `audit_log_filter_compression` system variable when the server starts.
Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-formats.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter file format overview

The feature is in [tech preview](glossary.md#tech-preview).

When an auditable event occurs, the plugin writes a record to the log file.

After the plugin starts, the first record lists the description of the server and the options at startup. After the first record, the auditable events are connections, disconnections, SQL statements executed, and so on. Statements within stored procedures or triggers are not logged, only the top-level statements.
Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-json.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter format - JSON

The feature is in [tech preview](glossary.md#tech-preview).

The JSON format has one top-level JSON array, which contain JSON objects with key-value pairs. These objects represent an event in the audit. Some pairs are listed in every audit record. The audit record type determines if other key-value pairs are listed. The order of the pairs within an audit record is not guaranteed. The value description may be truncated.

Certain statistics, such as query time and size, are only available in the JSON format and help detect activity outliers when analyzed.
Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-naming.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter file naming conventions

The feature is in [tech preview](glossary.md#tech-preview).

## Name qualities

The audit log filter file name has the following qualities:
Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-new.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter format - XML (new style)

The feature is in [tech preview](glossary.md#tech-preview).

The filter writes the audit log filter file in XML. The XML file uses
UTF-8.

Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-old.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter format - XML (old style)

The feature is in [tech preview](glossary.md#tech-preview).

The old style XML format uses `<AUDIT>` tag as the root element and adds the `</AUDIT>` tag when the file closes. Each audited event is contained in an <AUDIT_RECORD> element.

The order of the attributes within an <AUDIT_RECORD> can vary. Certain attributes are in every element. Other attributes are optional and depend on the type of audit record.
Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter overview

The feature is in [tech preview](glossary.md#tech-preview).

The Audit Log Filter plugin allows you to monitor, log, and block a connection or query actively executed on the selected server.

Enabling the plugin produces a log file that contains a record of server activity. The log file has information on connections and databases accessed by that connection.
Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-restrictions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter restrictions

The feature is in [tech preview](glossary.md#tech-preview).

## General restrictions

The Audit Log Filter has the following general restrictions:
Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-security.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit Log Filter security

The feature is in [tech preview](glossary.md#tech-preview).

The Audit Log Filter plugin generates audit log filter files. The directory
that contains these files should be accessible only to the following:

Expand Down
2 changes: 0 additions & 2 deletions docs/audit-log-filter-variables.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audit log filter functions, options and variables

This feature is in [technical preview](glossary.md#tech-preview).

The following sections describe the [functions](#audit-log-filter-functions), [options, and variables](#audit-log-filter-options-and-variables) available in the audit log filter plugin.

## Audit log filter functions
Expand Down
2 changes: 0 additions & 2 deletions docs/disable-audit-log-filter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Disable Audit Log Filter logging

The feature is in [tech preview](glossary.md#tech-preview).

The `audit_log_filter_disable` system variable lets you disable or enable logging for all connections.

You can set the variable in the following ways:
Expand Down
2 changes: 0 additions & 2 deletions docs/filter-audit-log-filter-files.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Filter the Audit Log Filter logs

The feature is in [tech preview](glossary.md#tech-preview).

The audit filter log filtering is based on rules. The filter rule definition has the ability to include or exclude events based on the following attributes:

* User account
Expand Down
2 changes: 0 additions & 2 deletions docs/install-audit-log-filter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Install the Audit Log Filter

The feature is in [tech preview](glossary.md#tech-preview).

The `plugin_dir` system variable defines the plugin library location. If needed, at server startup, set the `plugin_dir` variable.

When upgrading a MySQL installation, plugins are not automatically upgraded. You may need to manually load the plugin after the MySQL upgrade.
Expand Down
2 changes: 0 additions & 2 deletions docs/manage-audit-log-filter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Manage the Audit Log Filter files

The feature is in [tech preview](glossary.md#tech-preview).

The Audit Log Filter files have the following potential results:

* Consume a large amount of disk space
Expand Down
2 changes: 0 additions & 2 deletions docs/reading-audit-log-filter-files.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Reading Audit Log Filter files

The feature is in [tech preview](glossary.md#tech-preview).

The Audit Log Filter functions can provide a SQL interface to read JSON-format audit log files. The functions cannot read log files in other formats. Configuring the plugin for JSON logging lets the functions use the directory that contains the current audit log filter file and search in that location for readable files. The value of the `audit_log_filter_file` system variable provides the file location, base name, and the suffix and then searches for names that match the pattern.

If the file is renamed and no longer fits the pattern, the file is ignored.
Expand Down
2 changes: 0 additions & 2 deletions docs/uninstall-audit-log-filter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Uninstall Audit Log Filter

The feature is in [tech preview](glossary.md#tech-preview).

To remove the plugin, run the following:

```{.bash data-prompt="mysql>"}
Expand Down

0 comments on commit 903b229

Please sign in to comment.