NAME

过滤器名称。

FILTER

与过滤器名称关联的过滤器定义。定义存储为 JSON 值。

USER

帐户的用户名部分。例如，对于帐户 user1@localhost，用户名部分是 user1。

HOST

帐户的主机名部分。例如，对于帐户 user1@localhost，主机名部分是 localhost。

FILTERNAME

账户分配的过滤器名称。该名称将账户与audit_log_filter表中的定义的过滤器相关联。

audit_log_encryption_password_get([keyring_id])

该函数从 MySQL 密钥环中检索审计日志加密密码，必须启用密钥环，否则将发生错误。任何密钥环组件或插件都可以使用；有关说明，请参阅第 8.4.4 节，“MySQL 密钥环”。

如果不提供参数，该函数将检索当前加密密码作为二进制字符串。可以提供参数来指定要检索的审计日志加密密码。参数必须是当前密码或存档密码的密钥 ID。

有关审计日志加密的更多信息，请参阅加密审计日志文件。

参数：

keyring_id: 该可选参数指定要检索的密码的密钥 ID。最大允许长度为 766 字节。如果省略，该函数将检索当前密码。

返回值：

成功时返回密码字符串（最多 766 字节），否则返回 NULL 和错误。

示例：

检索当前密码：

mysql> SELECT audit_log_encryption_password_get();
+-------------------------------------+
| audit_log_encryption_password_get() |
+-------------------------------------+
| secret                              |
+-------------------------------------+

通过 ID 检索密码，可以通过查询性能模式keyring_keys表来确定哪些审核日志密钥环 ID 存在：

mysql> SELECT KEY_ID FROM performance_schema.keyring_keys
       WHERE KEY_ID LIKE 'audit_log%'
       ORDER BY KEY_ID;
+-----------------------------+
| KEY_ID                      |
+-----------------------------+
| audit_log-20190415T152248-1 |
| audit_log-20190415T153507-1 |
| audit_log-20190416T125122-1 |
| audit_log-20190416T141608-1 |
+-----------------------------+
mysql> SELECT audit_log_encryption_password_get('audit_log-20190416T125122-1');
+------------------------------------------------------------------+
| audit_log_encryption_password_get('audit_log-20190416T125122-1') |
+------------------------------------------------------------------+
| segreto                                                          |
+------------------------------------------------------------------+

audit_log_encryption_password_set(密码)

将当前审核日志加密密码设置为参数，并将密码存储在 MySQL 密钥环中。密码以 utf8mb4 字符串形式存储。以前，密码以二进制形式存储。

如果启用了加密，则该函数执行日志文件轮换操作，重命名当前日志文件，并以密码加密开始新的日志文件。密钥环必须启用，否则将发生错误。任何密钥环组件或插件都可以使用；有关说明，请参阅第 8.4.4 节，“MySQL 密钥环”。

有关审核日志加密的更多信息，请参阅加密审核日志文件。

参数：

密码：密码字符串。最大允许长度为 766 字节。

返回值：

成功返回 1，失败返回 0。

示例：

mysql> SELECT audit_log_encryption_password_set(password);
+---------------------------------------------+
| audit_log_encryption_password_set(password) |
+---------------------------------------------+
| 1                                           |
+---------------------------------------------+

audit_log_filter_flush()

调用任何其他过滤函数都会立即影响操作审核日志过滤，并更新审核日志表。如果您直接修改这些表的内容，例如使用INSERT、UPDATE和DELETE语句，变化不会立即影响过滤。要刷新更改并使其生效，请调用audit_log_filter_flush()。

如果此函数失败，将返回错误消息并禁用审核日志，直到下一次成功调用audit_log_filter_flush()。

参数：

无。

返回值：

一个字符串，指示操作是否成功。OK 表示成功。ERROR: message 表示失败。

示例：

mysql> SELECT audit_log_filter_flush();
+--------------------------+
| audit_log_filter_flush() |
+--------------------------+
| OK                       |
+--------------------------+

audit_log_filter_remove_filter(filter_name)

给定一个过滤器名称，从当前过滤器集中删除该过滤器。如果过滤器不存在，不会出错。

如果删除的过滤器分配给任何用户账户，那些用户将停止被过滤（它们将从 audit_log_user 表中删除）。过滤的终止包括当前会话：它们将从过滤器中分离，并且不再记录。

参数：

返回值：

一个字符串，指示操作是否成功。OK 表示成功。ERROR: message 表示失败。

示例：

mysql> SELECT audit_log_filter_remove_filter('SomeFilter');
+----------------------------------------------+
| audit_log_filter_remove_filter('SomeFilter') |
+----------------------------------------------+
| OK                                           |
+----------------------------------------------+

audit_log_filter_remove_user(user_name)

给定一个用户账户名称，使该用户不再分配给过滤器。如果用户没有分配过滤器，不会出错。当前会话的过滤不受影响。新的连接将使用默认账户过滤器，如果存在；否则，不会记录。

如果名称是 %，该函数将删除默认账户过滤器，该过滤器用于任何没有明确分配过滤器的用户账户。

参数：

返回值：

一个字符串，指示操作是否成功。OK 表示成功。ERROR: message 表示失败。

示例：

mysql> SELECT audit_log_filter_remove_user('user1@localhost');
+-------------------------------------------------+
| audit_log_filter_remove_user('user1@localhost') |
+-------------------------------------------------+
| OK                                              |
+-------------------------------------------------+

audit_log_filter_set_filter(filter_name, definition)

给定一个过滤器名称和定义，将该过滤器添加到当前过滤器集中。如果该过滤器已经存在并且被任何当前会话使用，那些会话将从过滤器中分离，并且不再记录。这是因为新的过滤器定义具有一个新的过滤器 ID，该 ID 与其之前的 ID 不同。

参数：

返回值：

一个字符串，指示操作是否成功。 OK 表示成功。 ERROR: message 表示失败。

示例：

mysql> SET @f = '{ "filter": { "log": false } }';
mysql> SELECT audit_log_filter_set_filter('SomeFilter', @f);
+-----------------------------------------------+
| audit_log_filter_set_filter('SomeFilter', @f) |
+-----------------------------------------------+
| OK                                            |
+-----------------------------------------------+

audit_log_filter_set_user(user_name, filter_name)

给定用户账户名称和过滤器名称，将过滤器分配给用户。一个用户只能分配一个过滤器，因此如果用户已经分配了过滤器，则分配将被替换。当前会话的过滤器保持不变。新的连接将使用新的过滤器。

作为特殊情况，名称 % 代表默认账户。过滤器用于来自任何用户账户的连接，该账户没有明确分配的过滤器。

参数：

返回值：

一个字符串，指示操作是否成功。 OK 表示成功。 ERROR: message 表示失败。

示例：

mysql> SELECT audit_log_filter_set_user('user1@localhost', 'SomeFilter');
+------------------------------------------------------------+
| audit_log_filter_set_user('user1@localhost', 'SomeFilter') |
+------------------------------------------------------------+
| OK                                                         |
+------------------------------------------------------------+

audit_log_read([arg])

读取审核日志并返回一个 JSON 字符串结果。如果审核日志格式不是 JSON，则发生错误。

无参数或 JSON 哈希参数，audit_log_read() 读取审核日志事件并返回一个 JSON 字符串，包含审核事件数组。哈希参数中的项目影响读取方式，如后面所述。返回数组中的每个元素都是一个事件，表示为 JSON 哈希，除了最后一个元素可能是 JSON null 值，表示没有更多事件可供读取。

带有 JSON null 值参数，audit_log_read() 关闭当前读取序列。

有关审核日志读取过程的更多详细信息，请参阅第 8.4.5.6 节，“读取审核日志文件”。

参数：

要获取最新事件的书签，请调用audit_log_read_bookmark()。

arg：参数是可选的。如果省略，则函数从当前位置读取事件。如果存在，参数可以是JSON null值以关闭读取序列，或者是一个JSON 哈希值。在哈希参数中，项目是可选的，控制读取操作的方面，例如从何处开始读取或读取多少事件。以下项目是重要的（其他项目将被忽略）：

要指定audit_log_read()的起始位置，请传递一个哈希参数，该参数包括一个 start 项目或一个由 timestamp 和 id 项目组成的书签。如果哈希参数包括这两个项目，将发生错误。

如果哈希参数未指定起始位置，读取将从当前位置继续。

如果时间戳值不包括时间部分，将假设时间部分为 00:00:00。

返回值：

如果调用成功，返回值是一个包含审核事件数组的JSON 字符串，或者是一个JSON null 值，以关闭读取序列。如果调用失败，返回值为 NULL，并发生错误。

示例：

mysql> SELECT audit_log_read(audit_log_read_bookmark());
+-----------------------------------------------------------------------+
| audit_log_read(audit_log_read_bookmark())                             |
+-----------------------------------------------------------------------+
| [ {"timestamp":"2020-05-18 22:41:24","id":0,"class":"connection", ... |
+-----------------------------------------------------------------------+
mysql> SELECT audit_log_read('null');
+------------------------+
| audit_log_read('null') |
+------------------------+
| null                   |
+------------------------+

注意：

在 MySQL 8.3 之前，字符串返回值可以是二进制 JSON 字符串。有关将这些值转换为非二进制字符串的信息，请参见 第 8.4.5.6 节，“读取审计日志文件”。

audit_log_read_bookmark()

返回一个表示最新写入审计日志事件的书签的 JSON 字符串。如果审计日志格式不是 JSON，则发生错误。

该书签是一个 JSON 哈希表，包含 timestamp 和 id 项，唯一标识审计日志中的事件位置。它适合传递给 audit_log_read() 函数，以指示该函数从何处开始读取。

有关审计日志读取过程的更多详细信息，请参见 第 8.4.5.6 节，“读取审计日志文件”。

参数：

无。

返回值：

一个包含书签的 JSON 字符串，或者在失败时返回 NULL 和错误。

示例：

mysql> SELECT audit_log_read_bookmark();
+-------------------------------------------------+
| audit_log_read_bookmark()                       |
+-------------------------------------------------+
| { "timestamp": "2019-10-03 21:03:44", "id": 0 } |
+-------------------------------------------------+

注意：

在 MySQL 8.3 之前，字符串返回值可以是二进制 JSON 字符串。有关将这些值转换为非二进制字符串的信息，请参见 第 8.4.5.6 节，“读取审计日志文件”。

audit_log_rotate()

参数：

无。

返回值：

重命名的文件名。

示例：

mysql> SELECT audit_log_rotate();

使用 audit_log_rotate() 需要 AUDIT_ADMIN 权限。

--audit-log[=值]

该选项控制服务器在启动时如何加载 audit_log 插件。它仅在插件之前注册了 INSTALL PLUGIN 或加载了 --plugin-load 或 --plugin-load-add 时可用。请参阅 第 8.4.5.2 节，“安装或卸载 MySQL 企业审核”。

选项值应为插件加载选项之一，如 第 7.6.1 节，“安装和卸载插件” 所述。例如，--audit-log=FORCE_PLUS_PERMANENT 告诉服务器加载插件并防止其在服务器运行时被删除。

audit_log_buffer_size

当审核日志插件异步写入事件到日志时，它使用缓冲区来存储事件内容，然后写入日志。该变量控制该缓冲区的大小，以字节为单位。服务器将该值调整为 4096 的倍数。插件在初始化时分配该缓冲区，并在终止时释放该缓冲区。只有在异步日志记录时，插件才分配该缓冲区。

audit_log_compression

审核日志文件的压缩类型。允许的值是 NONE（无压缩，默认）和 GZIP（GNU Zip 压缩）。有关更多信息，请参阅 压缩审核日志文件。

audit_log_connection_policy

控制审核日志插件如何将连接事件写入其日志文件的策略。下表显示了允许的值。

audit_log_current_session

是否启用当前会话的审核日志记录。会话值是只读的，它是在会话开始时根据audit_log_include_accounts和audit_log_exclude_accounts系统变量的值设置的。审核日志插件使用会话值来确定是否审核会话事件。（有一个全局值，但插件不使用它。）

audit_log_database

指定审核日志插件使用的数据库。该变量是只读的。有关更多信息，请参阅第 8.4.5.2 节，“安装或卸载 MySQL 企业审核”。

audit_log_disable

允许禁用所有连接和连接会话的审核日志记录。此外，还需要 SYSTEM_VARIABLES_ADMIN 权限和 AUDIT_ADMIN 权限。请参阅 第 8.4.5.9 节，“禁用审核日志记录”。

audit_log_encryption

审核日志文件的加密类型。允许的值是 NONE（无加密，默认）和 AES（AES-256-CBC 密码加密）。更多信息，请参阅 加密审核日志文件。

audit_log_exclude_accounts

这些事件不应记录的账户。该值应为 NULL 或包含一个或多个逗号分隔的账户名称的字符串。有关更多信息，请参阅 第 8.4.5.7 节，“审核日志过滤”。

对 audit_log_exclude_accounts 的修改仅影响后续创建的连接，而不影响现有的连接。

audit_log_file

审核日志插件写入事件的文件的基本名称和后缀。默认值是 audit.log，无论日志格式如何。要使名称后缀对应于格式，请显式设置名称，选择不同的后缀（例如，audit.xml 用于 XML 格式，audit.json 用于 JSON 格式）。

如果 audit_log_file 的值是一个相对路径名，插件将其解释为相对于数据目录的路径。如果值是一个完整的路径名，插件将其作为是。完整的路径名可能有助于将审核日志文件位于一个单独的文件系统或目录中。出于安全原因，请将审核日志文件写入仅供 MySQL 服务器和有合法理由查看日志的用户访问的目录。

关于审计日志插件如何解释audit_log_file值和插件初始化和终止时的文件重命名规则，请参阅审计日志文件命名约定。

审计日志插件使用包含审计日志文件的目录（由audit_log_file值确定）作为搜索可读审计日志文件的位置。从这些日志文件和当前文件中，插件构建了一个可用于审计日志书签和读取函数的列表。请参阅第 8.4.5.6 节，“读取审计日志文件”。

audit_log_filter_id

该变量的会话值表示当前会话的审计过滤器的内部维护 ID。如果值为 0，则表示会话没有分配过滤器。

audit_log_flush

如果 audit_log_rotate_on_size 为 0，则自动审核日志文件轮换被禁用，仅在手动执行时进行轮换。在这种情况下，启用 audit_log_flush 通过将其设置为 1 或 ON 导致审核日志插件关闭并重新打开其日志文件以刷新它。（变量值保持 OFF，因此您不需要在启用它之前显式禁用它，以便执行另一个刷新。）有关更多信息，请参阅 第 8.4.5.5 节，“配置审核日志特征”。

audit_log_flush_interval_seconds

该系统变量依赖于 scheduler 组件，该组件必须安装并启用（请参阅 第 7.5.5 节，“Scheduler 组件”）。要检查组件的状态：

SHOW VARIABLES LIKE 'component_scheduler%';
+-----------------------------+-------+
| Variable_name               | Value |
+-----------------------------+-------|
| component_scheduler.enabled | On    |
+-----------------------------+-------+

当 audit_log_flush_interval_seconds 的值为零（默认值）时，即使 scheduler 组件启用（ON），也不会发生自动刷新权限。

值在 0 和 60 之间（1 到 59）不被确认；相反，这些值将自动调整为 60，服务器将发出警告。值大于 60 定义了 scheduler 组件从启动或从上一次执行开始等待的秒数，直到它尝试安排另一个执行。

要将该全局系统变量持久化到 mysqld-auto.cnf 文件中，而不设置全局变量的运行时值，请在变量名前加上 PERSIST_ONLY 关键字或 @@PERSIST_ONLY. 限定符。

审核日志格式

审核日志文件格式。允许的值是 OLD（旧式 XML）、NEW（新式 XML；默认）和 JSON。有关每种格式的详细信息，请参阅 第 8.4.5.4 节，“审核日志文件格式”。

audit_log_format_unix_timestamp

该变量仅适用于 JSON 格式的审核日志输出。当该变量为 true 时，启用该变量将导致每个日志文件记录包含一个 time 字段。该字段值是一个整数，表示审核事件生成的 UNIX 时间戳。

在运行时更改该变量的值将导致日志文件轮换，以便在给定的 JSON 格式日志文件中，所有记录都包含或不包含 time 字段。

设置audit_log_format_unix_timestamp的运行时值需要AUDIT_ADMIN权限，除了通常需要设置全局系统变量运行时值的SYSTEM_VARIABLES_ADMIN权限（或已弃用的SUPER权限）.

audit_log_include_accounts

应记录事件的账户。该值应为 NULL 或包含一个或多个以逗号分隔的账户名称的字符串。有关更多信息，请参见第 8.4.5.7 节，“审核日志过滤”。

对audit_log_include_accounts的修改仅影响创建于修改后的连接，而不影响现有连接。

audit_log_max_size

audit_log_max_size 与审核日志文件修剪有关，仅支持 JSON 格式日志文件。它控制基于组合日志文件大小的修剪：

如果您将 audit_log_max_size 设置为不是 4096 的倍数的值，它将被截断到最近的倍数。特别是，将其设置为小于 4096 的值将其设置为 0，且不进行基于大小的修剪。

如果 audit_log_max_size 和 audit_log_rotate_on_size 都大于 0，audit_log_max_size 应该大于 audit_log_rotate_on_size 的 7 倍。否则，将在服务器错误日志中写入警告，因为在这种情况下基于大小的修剪的“粒度”可能不足以防止每次修剪时删除所有或大多数旋转日志文件。

audit_log_password_history_keep_days

审核日志插件使用MySQL密钥环（见Encrypting Audit Log Files）来实现日志文件加密。插件还实现了密码历史记录，包括密码存档和过期（删除）。

当审核日志插件创建新的加密密码时，它存档了以前的密码（如果存在），以便日后使用。audit_log_password_history_keep_days变量控制已存档的加密密码的自动删除。其值表示已存档的加密密码在多少天后被删除。默认值为0，表示密码保留期限为永久。

新的审核日志加密密码在以下情况下创建：

在每种情况下，插件将新密码存储在密钥环中，并使用它来加密新的日志文件。

已过期的审核日志加密密码删除发生在以下情况下：

当密码删除发生时，当前的 audit_log_password_history_keep_days 值确定要删除哪些密码：

如果您通常禁用密码过期（即 audit_log_password_history_keep_days 的值为 0），那么可以通过临时将变量设置为大于零的值来执行按需清理操作。例如，要删除超过 365 天的密码，可以这样做：

SET GLOBAL audit_log_password_history_keep_days = 365;
SET GLOBAL audit_log_password_history_keep_days = 0;

设置 audit_log_password_history_keep_days 的运行时值需要 AUDIT_ADMIN 权限，除了需要设置全局系统变量运行时值的 SYSTEM_VARIABLES_ADMIN 权限（或已弃用的 SUPER 权限）。

audit_log_policy

控制审核日志插件如何将事件写入其日志文件的策略。下表显示了允许的值。

audit_log_policy 只能在服务器启动时设置。在运行时，它是一个只读变量。两个其他系统变量，audit_log_connection_policy 和 audit_log_statement_policy，提供了更细粒度的日志策略控制，可以在启动时或运行时设置。如果您在启动时使用 audit_log_policy 而不是其他两个变量，服务器将使用其值来设置那些变量。有关策略变量及其交互的更多信息，请参见 第 8.4.5.5 节，“配置审核日志特性”。

audit_log_prune_seconds

audit_log_prune_seconds 与审核日志文件修剪有关，仅支持 JSON 格式日志文件。它控制基于日志文件年龄的修剪：

audit_log_read_buffer_size

审核日志文件读取缓冲区的大小，以字节为单位。audit_log_read() 函数最多读取这么多字节。日志文件读取仅支持 JSON 日志格式。有关更多信息，请参阅 第 8.4.5.6 节，“读取审核日志文件”。

该变量的默认值为 32KB，可以在运行时设置。每个客户端都应该根据其使用 audit_log_read() 函数的方式设置其会话值 audit_log_read_buffer_size。

audit_log_rotate_on_size

如果 audit_log_rotate_on_size 为 0，则审核日志插件不执行基于大小的日志文件旋转。如果需要旋转，必须手动执行；见 手动审核日志文件旋转（在 MySQL 8.0.31 之前）。

如果 audit_log_rotate_on_size 大于 0，则自动基于大小的日志文件旋转将发生。每当写入日志文件时，如果其大小超过 audit_log_rotate_on_size 值，审核日志插件将重命名当前日志文件，并使用原始名称打开新的当前日志文件。

如果您将 audit_log_rotate_on_size 设置为不是 4096 的倍数的值，它将被截断到最近的倍数。特别是，将其设置为小于 4096 的值将其设置为 0，并且不会发生旋转，除非手动执行。

audit_log_statement_policy

控制审核日志插件如何将语句事件写入其日志文件的策略。下表显示了允许的值。

audit_log_strategy

审核日志插件使用的日志方法。这些策略值是允许的：

Audit_log_current_size

当前审核日志文件的大小。当事件写入日志时，值将增加，并在日志轮换时重置为 0。

Audit_log_direct_writes

当审核日志插件将事件写入 JSON 格式审核日志时，它使用缓冲区来存储事件内容，然后写入日志。如果查询长度大于缓冲区的大小，那么插件将事件直接写入日志，绕过缓冲区。该变量显示直接写入的次数。插件根据当前使用的写入策略（见 audit_log_strategy）来确定计数。

Audit_log_event_max_drop_size

性能日志模式下最大的已删除事件大小。有关日志模式的描述，请参见 第 8.4.5.5 节，“配置审核日志特性”。

Audit_log_events

审核日志插件处理的事件数量，无论它们是否根据过滤策略写入日志（见 第 8.4.5.5 节，“配置审核日志特性”）。

Audit_log_events_filtered

审核日志插件处理的事件数量，因为过滤策略而未写入日志（见第 8.4.5.5 节，“配置审核日志特征”）。

Audit_log_events_filtered

在性能日志模式下，因审核日志缓冲区空间不足而丢失的事件数量。该值可能有助于评估如何设置audit_log_buffer_size以调整缓冲区大小以适应性能模式。有关日志模式的描述，请见第 8.4.5.5 节，“配置审核日志特征”。

Audit_log_events_written

写入审核日志的事件数量。

Audit_log_total_size

写入所有审核日志文件的总大小。与Audit_log_current_size不同的是，Audit_log_total_size的值即使日志被旋转也会增加。

Audit_log_write_waits

在异步日志模式下，事件等待审核日志缓冲区空间的次数。有关日志模式的描述，请见第 8.4.5.5 节，“配置审核日志特征”。