This section describes the command options and system variables that control operation of the audit log plugin. If values specified at startup time are incorrect, the plugin may fail to initialize properly and the server does not load it. In this case, the server may also produce error messages for other audit log settings because it will not recognize them.
To control the activation of the audit_log
plugin, use this option:
-
Version Introduced 5.6.10 Command-Line Format --audit-log[=value]Option-File Format audit-log[=value]Permitted Values Type enumerationDefault ONValid Values ONOFFFORCEFORCE_PLUS_PERMANENTThis option controls how the server loads the
audit_logplugin at startup. It is available only if the audit log plugin has been previously registered withINSTALL PLUGINor is loaded with--plugin-load. See Section 5.11.1, “Installing the Audit Log Plugin”.The option value should be one of those available for plugin-loading options, as described in Installing and Uninstalling Plugins. For example,
--audit-log=FORCE_PLUS_PERMANENTtells the server to load the plugin and prevent it from being removed while the server is running.This option was added in MySQL 5.6.10.
If the audit_log plugin is installed, it
exposes several system variables that permit control over
logging:
mysql> SHOW VARIABLES LIKE 'audit_log%';
+--------------------------+--------------+
| Variable_name | Value |
+--------------------------+--------------+
| audit_log_buffer_size | 1048576 |
| audit_log_file | audit.log |
| audit_log_flush | OFF |
| audit_log_policy | ALL |
| audit_log_rotate_on_size | 0 |
| audit_log_strategy | ASYNCHRONOUS |
+--------------------------+--------------+
You can set any of these variables at server startup, and some of them at runtime.
-
Version Introduced 5.6.10 Variable Name audit_log_buffer_sizeVariable Scope Global Dynamic Variable No Permitted Values Platform Bit Size 32Type numericDefault 1048576Range 4096 .. 4294967295Permitted Values Platform Bit Size 64Type numericDefault 1048576Range 4096 .. 18446744073709547520When the audit log plugin writes events to the log asynchronously, it uses a buffer to store event contents prior to writing them. This variable controls the size of that buffer, in bytes. The server adjusts the value to a multiple of 4096. The plugin uses a single buffer, which it allocates when it initializes and removes when it terminates. The plugin allocates this buffer only if logging is asynchronous.
This variable was added in MySQL 5.6.10. It is available only if the
audit_logplugin is enabled. -
Version Introduced 5.6.10 Variable Name audit_log_fileVariable Scope Global Dynamic Variable No Permitted Values Type stringDefault audit.logThe name of the file to which the audit log plugin writes events. The default value is
audit.log. If the file name is a relative path, the server interprets it relative to the data directory. For security reasons, the audit log file should be written to a directory accessible only to the MySQL server and users with a legitimate reason to view the log.This variable was added in MySQL 5.6.10. It is available only if the
audit_logplugin is enabled. -
Version Introduced 5.6.10 Variable Name audit_log_flushVariable Scope Global Dynamic Variable Yes Permitted Values Type booleanDefault OFFWhen this variable is set to enabled (1 or
ON), the audit log plugin closes and reopens its log file to flush it. (The value remainsOFFso that you need not disable it explicitly before enabling it again to perform another flush.) Enabling this variable has no effect unlessaudit_log_rotate_on_sizeis 0.This variable was added in MySQL 5.6.10. It is available only if the
audit_logplugin is enabled. -
Version Introduced 5.6.10 Variable Name audit_log_policyVariable Scope Global Dynamic Variable Yes Permitted Values Type enumerationDefault ALLValid Values ALLNONELOGINSQUERIESThe policy controlling the information written by the audit log plugin to its log file. The following table shows the permitted values.
Value Description ALLLog all events NONELog nothing (disable the audit stream) LOGINSLog only login events QUERIESLog only query events This variable was added in MySQL 5.6.10. It is available only if the
audit_logplugin is enabled. -
Version Introduced 5.6.10 Variable Name audit_log_rotate_on_sizeVariable Scope Global Dynamic Variable Yes Permitted Values Type numericDefault 0If the
audit_log_rotate_on_sizevalue is greater than 0, the audit log plugin closes and reopens its log file if a write to the file causes its size to exceed this value. The original file is renamed to have a timestamp extension.If the
audit_log_rotate_on_sizevalue is 0, the plugin does not close and reopen its log based on size. Instead, useaudit_log_flushto close and reopen the log on demand. In this case, rename the file externally to the server before flushing it.For more information about audit log file rotation and timestamp interpretation, see Section 5.11.4, “Audit Log Plugin Logging Control”.
If you set this variable to a value that is not a multiple of 4096, it is truncated to the nearest multiple.
This variable was added in MySQL 5.6.10. It is available only if the
audit_logplugin is enabled. -
Version Introduced 5.6.10 Variable Name audit_log_strategyVariable Scope Global Dynamic Variable No Permitted Values Type enumerationDefault ASYNCHRONOUSValid Values ASYNCHRONOUSPERFORMANCESEMISYNCHRONOUSSYNCHRONOUSThe logging method used by the audit log plugin. The following table describes the permitted values.
Table 5.10. Audit Log Strategies
Value Meaning ASYNCHRONOUSLog asynchronously, wait for space in output buffer PERFORMANCELog asynchronously, drop request if insufficient space in output buffer SEMISYNCHRONOUSLog synchronously, permit caching by operating system SYNCHRONOUSLog synchronously, call sync()after each requestThis variable was added in MySQL 5.6.10. It is available only if the
audit_logplugin is enabled.
User Comments
Add your own comment.