NAME

过滤器名称。

FILTER

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

USER

帐户的用户名部分。对于一个帐户 user1@localhost， USER部分是user1。

HOST

帐户的主机名部分。对于一个帐户 user1@localhost， HOST部分是 localhost。

FILTERNAME

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

audit_log_encryption_password_get()

检索当前审计日志加密密码作为二进制字符串。密码是从 MySQL 密钥环中获取的，必须启用该密钥环，否则会发生错误。可以使用任何密钥环插件；有关说明，请参阅 第 6.4.4 节，“MySQL 密钥环”。

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

参数：

没有任何。

返回值：

成功的密码字符串（最多 766 字节），或 NULL失败的错误。

例子：

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

audit_log_encryption_password_set(password)

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

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

参数：

password: 密码字符串。允许的最大长度为 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。

参数：

返回值：

指示操作是否成功的字符串。 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 nullaudit_log_read()

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

参数：

arg: 该参数是可选的。如果省略，该函数将从当前位置读取事件。如果存在，该参数可以是 关闭读取序列的值或散列。在散列参数中，项目是可选的，并且控制读取操作的各个方面，例如开始读取的位置或要读取的事件数。以下项目很重要（其他项目被忽略）： JSON nullJSON

返回值：

如果调用成功，则返回值是一个 JSON包含审计事件数组的二进制字符串，或者是一个 值（如果该值作为参数传递以关闭读取序列）。如果调用失败，返回值为 ，并发生错误。 JSON nullNULL

例子：

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                   |
+------------------------+

audit_log_read_bookmark()

JSON 返回表示最近写入的审核日志事件的书签 的二进制字符串。如果审计日志格式不是 JSON，则会发生错误。

书签是一个带有和 项目的JSON散列，用于唯一标识事件在审核日志中的位置。它适合传递给 该函数以指示开始读取的位置。 timestampidaudit_log_read()

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

参数：

没有任何。

返回值：

JSON包含表示成功的书签或 NULL表示失败的错误 的二进制字符串。

例子：

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

--audit-log[=value]

此选项控制服务器 audit_log在启动时如何加载插件。仅当插件先前已注册INSTALL PLUGIN或加载 时才可用--plugin-load或 --plugin-load-add。请参阅 第 6.4.5.2 节，“安装或卸载 MySQL Enterprise Audit”。

选项值应该是可用于插件加载选项的值之一，如 第 5.5.1 节“安装和卸载插件”中所述。例如， --audit-log=FORCE_PLUS_PERMANENT 告诉服务器加载插件并防止它在服务器运行时被删除。

audit_log_buffer_size

当审计日志插件将事件异步写入日志时，它会在写入事件之前使用一个缓冲区来存储事件内容。此变量控制该缓冲区的大小（以字节为单位）。服务器将值调整为 4096 的倍数。插件使用单个缓冲区，它在初始化时分配并在终止时删除。仅当日志记录是异步的时，插件才会分配此缓冲区。

audit_log_disable

允许为所有连接和已连接的会话禁用审核日志记录。禁用审计日志记录需要 SUPER权限。请参阅 第 6.4.5.9 节，“禁用审计日志记录”。

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_encryption

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

audit_log_exclude_accounts

不应记录其事件的帐户。该值应该是NULL或一个字符串，其中包含一个或多个以逗号分隔的帐户名称的列表。有关详细信息，请参阅 第 6.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插件初始化和终止时发生的文件重命名的值和规则的详细信息，请参阅 审核日志文件的命名约定。

从 MySQL 5.7.21 开始，审计日志插件使用包含审计日志文件的目录（由audit_log_file值确定）作为搜索可读审计日志文件的位置。从这些日志文件和当前文件中，插件构建了一个列表，其中列出了要与审计日志书签和阅读功能一起使用的列表。请参阅 第 6.4.5.6 节，“读取审计日志文件”。

audit_log_filter_id

此变量的会话值指示内部维护的当前会话的审核过滤器的 ID。值 0 表示会话没有分配过滤器。

audit_log_flush

如果 audit_log_rotate_on_size 为 0，则禁用自动审计日志文件轮换，轮换仅在手动执行时发生。在这种情况下， audit_log_flush通过将其设置为 1 或ON导致审计日志插件关闭并重新打开其日志文件以刷新它来启用。（变量值保留OFF，因此您无需在再次启用它以执行另一次刷新之前明确禁用它。）有关更多信息，请参阅 第 6.4.5.5 节，“配置审计日志记录特征”。

audit_log_format

审核日志文件格式。允许的值是 OLD(old-style XML), NEW(new-style XML; default), and (as of MySQL 5.7.21) JSON。有关每种格式的详细信息，请参阅 第 6.4.5.4 节，“审计日志文件格式”。

audit_log_format_unix_timestamp

此变量仅适用于 JSON 格式的审计日志输出。如果为真，启用此变量会导致每个日志文件记录包含一个time 字段。字段值是一个整数，表示 UNIX 时间戳值，指示生成审计事件的日期和时间。

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

audit_log_include_accounts

应记录事件的帐户。该值应该是NULL或一个字符串，其中包含一个或多个以逗号分隔的帐户名称的列表。有关详细信息，请参阅 第 6.4.5.7 节，“审计日志过滤”。

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

audit_log_policy

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

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

audit_log_read_buffer_size

从审计日志文件中读取的缓冲区大小，以字节为单位。该audit_log_read() 函数读取的字节数不超过这么多。仅支持 JSON 日志格式的日志文件读取。有关详细信息，请参阅第 6.4.5.6 节，“读取审计日志文件”。

从 MySQL 5.7.23 开始，这个变量默认为 32KB，可以在运行时设置。每个客户端都应将其会话值设置为 audit_log_read_buffer_size 适合其对 audit_log_read(). 在 MySQL 5.7.23 之前， audit_log_read_buffer_size 默认值为 1MB，影响所有客户端，并且只能在服务器启动时更改。

audit_log_rotate_on_size

如果 audit_log_rotate_on_size 为 0，审计日志插件不会执行基于大小的日志文件自动轮换。如果要进行旋转，则必须手动执行；请参阅 手动审核日志文件轮换。

如果 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_event_max_drop_size

性能日志记录模式下最大丢弃事件的大小。有关日志记录模式的说明，请参阅 第 6.4.5.5 节，“配置审计日志记录特征”。

Audit_log_events

审计日志插件处理的事件数，无论它们是否根据过滤策略写入日志（请参阅 第 6.4.5.5 节，“配置审计日志记录特征”）。

Audit_log_events_filtered

The number of events handled by the audit log plugin that were filtered (not written to the log) based on filtering policy (see Section 6.4.5.5, “Configuring Audit Logging Characteristics”).

Audit_log_events_lost

The number of events lost in performance logging mode because an event was larger than the available audit log buffer space. This value may be useful for assessing how to set audit_log_buffer_size to size the buffer for performance mode. For a description of logging modes, see Section 6.4.5.5, “Configuring Audit Logging Characteristics”.

Audit_log_events_written

The number of events written to the audit log.

Audit_log_total_size

写入所有审计日志文件的事件的总大小。与 不同 的是， 即使轮换日志 Audit_log_current_size，值 也会增加。Audit_log_total_size

Audit_log_write_waits

在异步日志记录模式下，事件必须等待审计日志缓冲区中的空间的次数。有关日志记录模式的说明，请参阅 第 6.4.5.5 节，“配置审计日志记录特征”。