This is an automated email from the ASF dual-hosted git repository.
CalvinKirs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 81077becd6a [doc](audit) Clarify audit plugin defaults by Doris
version (#4310)
81077becd6a is described below
commit 81077becd6a77efa3e237ed9159bf413f36c9902
Author: Calvin Kirs <[email protected]>
AuthorDate: Thu Oct 15 11:53:33 2026 +0800
[doc](audit) Clarify audit plugin defaults by Doris version (#4310)
Clarify the built-in audit plugin and version-specific
enable_audit_plugin defaults, including default enablement since 3.1.2
and 4.0.0, across the English and Chinese current, 3.x, and 4.x
documentation.
---
docs/admin-manual/audit-plugin.md | 32 ++++++++++++++++++----
.../current/admin-manual/audit-plugin.md | 32 ++++++++++++++++++----
.../version-3.x/admin-manual/audit-plugin.md | 32 ++++++++++++++++++----
.../version-4.x/admin-manual/audit-plugin.md | 32 ++++++++++++++++++----
.../version-3.x/admin-manual/audit-plugin.md | 32 ++++++++++++++++++----
.../version-4.x/admin-manual/audit-plugin.md | 32 ++++++++++++++++++----
6 files changed, 156 insertions(+), 36 deletions(-)
diff --git a/docs/admin-manual/audit-plugin.md
b/docs/admin-manual/audit-plugin.md
index 60bcb169559..626515440eb 100644
--- a/docs/admin-manual/audit-plugin.md
+++ b/docs/admin-manual/audit-plugin.md
@@ -10,17 +10,37 @@ Doris provides auditing capabilities for database
operations, allowing the recor
## Enabling Audit Logs
-The audit log plugin can be enabled or disabled at any time using the global
variable `enable_audit_plugin` (disabled by default), for example:
+Doris has included a built-in audit log plugin since version 2.1.0; no
separate installation is required. The global variable `enable_audit_plugin`
controls whether audit logs are written to `__internal_schema.audit_log`. Its
default value depends on the Doris version:
-`set global enable_audit_plugin = true;`
+| Doris version | Default value of `enable_audit_plugin` |
+| --- | --- |
+| 2.1.x, 3.0.x, 3.1.0, and 3.1.1 | `false` (disabled) |
+| 3.1.2 and later 3.1.x releases | `true` (enabled) |
+| 4.0.0 and later releases | `true` (enabled) |
-Once enabled, Doris will write the audit logs to the `audit_log` table.
+The audit log plugin is enabled by default in 3.1.2 and later 3.1.x releases.
It is also enabled by default in 4.0.0 and later releases. In these versions,
`enable_audit_plugin` defaults to `true`.
-You can disable the audit log plugin at any time:
+Check the current value on your cluster:
-`set global enable_audit_plugin = false;`
+```sql
+SHOW GLOBAL VARIABLES LIKE 'enable_audit_plugin';
+```
-After disabling, Doris will stop writing to the `audit_log` table. The already
written audit logs will remain unchanged.
+If it is `false`, you can enable it at any time:
+
+```sql
+SET GLOBAL enable_audit_plugin = true;
+```
+
+Once enabled, Doris writes subsequent audit logs to
`__internal_schema.audit_log`.
+
+To disable writing to the audit log table:
+
+```sql
+SET GLOBAL enable_audit_plugin = false;
+```
+
+Disabling the plugin stops new writes to `__internal_schema.audit_log` and
preserves existing records. This variable does not control the `fe.audit.log`
files described below.
## Viewing the Audit Log Table
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/audit-plugin.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/audit-plugin.md
index 32eab53da7b..1611bd01f24 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/audit-plugin.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/audit-plugin.md
@@ -10,17 +10,37 @@ Doris 提供了对于数据库操作的审计能力，可以记录用户对数
## 开启审计日志
-通过全局变量 `enable_audit_plugin` 可以随时开启或关闭审计日志插件（默认为关闭状态），如：
+Doris 自 2.1.0 起内置审计日志插件，无需单独安装。全局变量 `enable_audit_plugin` 控制是否将审计日志写入
`__internal_schema.audit_log` 表，其默认值随 Doris 版本而不同：
-`set global enable_audit_plugin = true;`
+| Doris 版本 | `enable_audit_plugin` 默认值 |
+| --- | --- |
+| 2.1.x、3.0.x、3.1.0 和 3.1.1 | `false`（关闭） |
+| 3.1.2 及后续 3.1.x 版本 | `true`（开启） |
+| 4.0.0 及后续版本 | `true`（开启） |
-开启后，Doris 会将开启后的审计日志写入 `audit_log` 表。
+3.1.2 及后续 3.1.x 版本默认开启审计日志插件；4.0.0 及后续版本也默认开启，即 `enable_audit_plugin` 的默认值为
`true`。
-可以随时关闭审计日志插件：
+可以通过以下语句查看当前集群的实际值：
-`set global enable_audit_plugin = false;`
+```sql
+SHOW GLOBAL VARIABLES LIKE 'enable_audit_plugin';
+```
-关闭后，Doris 将会停止 `audit_log` 表的写入。已写入的审计日志不会变化。
+如果当前值为 `false`，可以随时开启：
+
+```sql
+SET GLOBAL enable_audit_plugin = true;
+```
+
+开启后，Doris 会将后续产生的审计日志写入 `__internal_schema.audit_log` 表。
+
+如需停止向审计日志表写入数据，可以关闭插件：
+
+```sql
+SET GLOBAL enable_audit_plugin = false;
+```
+
+关闭插件后，Doris 将停止向 `__internal_schema.audit_log` 表写入新记录，已写入的记录仍然保留。该变量不控制下文介绍的
`fe.audit.log` 文件。
## 查看审计日志表
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/admin-manual/audit-plugin.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/admin-manual/audit-plugin.md
index c6777575ae6..d17540b85f3 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/admin-manual/audit-plugin.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/admin-manual/audit-plugin.md
@@ -10,17 +10,37 @@ Doris 提供了对于数据库操作的审计能力，可以记录用户对数
## 开启审计日志
-通过全局变量 `enable_audit_plugin` 可以随时开启或关闭审计日志插件（默认为关闭状态），如：
+Doris 自 2.1.0 起内置审计日志插件，无需单独安装。全局变量 `enable_audit_plugin` 控制是否将审计日志写入
`__internal_schema.audit_log` 表，其默认值随 Doris 版本而不同：
-`set global enable_audit_plugin = true;`
+| Doris 版本 | `enable_audit_plugin` 默认值 |
+| --- | --- |
+| 2.1.x、3.0.x、3.1.0 和 3.1.1 | `false`（关闭） |
+| 3.1.2 及后续 3.1.x 版本 | `true`（开启） |
+| 4.0.0 及后续版本 | `true`（开启） |
-开启后，Doris 会将开启后的审计日志写入 `audit_log` 表。
+3.1.2 及后续 3.1.x 版本默认开启审计日志插件；4.0.0 及后续版本也默认开启，即 `enable_audit_plugin` 的默认值为
`true`。
-可以随时关闭审计日志插件：
+可以通过以下语句查看当前集群的实际值：
-`set global enable_audit_plugin = false;`
+```sql
+SHOW GLOBAL VARIABLES LIKE 'enable_audit_plugin';
+```
-关闭后，Doris 将会停止 `audit_log` 表的写入。已写入的审计日志不会变化。
+如果当前值为 `false`，可以随时开启：
+
+```sql
+SET GLOBAL enable_audit_plugin = true;
+```
+
+开启后，Doris 会将后续产生的审计日志写入 `__internal_schema.audit_log` 表。
+
+如需停止向审计日志表写入数据，可以关闭插件：
+
+```sql
+SET GLOBAL enable_audit_plugin = false;
+```
+
+关闭插件后，Doris 将停止向 `__internal_schema.audit_log` 表写入新记录，已写入的记录仍然保留。该变量不控制下文介绍的
`fe.audit.log` 文件。
## 查看审计日志表
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/audit-plugin.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/audit-plugin.md
index 32eab53da7b..1611bd01f24 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/audit-plugin.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/audit-plugin.md
@@ -10,17 +10,37 @@ Doris 提供了对于数据库操作的审计能力，可以记录用户对数
## 开启审计日志
-通过全局变量 `enable_audit_plugin` 可以随时开启或关闭审计日志插件（默认为关闭状态），如：
+Doris 自 2.1.0 起内置审计日志插件，无需单独安装。全局变量 `enable_audit_plugin` 控制是否将审计日志写入
`__internal_schema.audit_log` 表，其默认值随 Doris 版本而不同：
-`set global enable_audit_plugin = true;`
+| Doris 版本 | `enable_audit_plugin` 默认值 |
+| --- | --- |
+| 2.1.x、3.0.x、3.1.0 和 3.1.1 | `false`（关闭） |
+| 3.1.2 及后续 3.1.x 版本 | `true`（开启） |
+| 4.0.0 及后续版本 | `true`（开启） |
-开启后，Doris 会将开启后的审计日志写入 `audit_log` 表。
+3.1.2 及后续 3.1.x 版本默认开启审计日志插件；4.0.0 及后续版本也默认开启，即 `enable_audit_plugin` 的默认值为
`true`。
-可以随时关闭审计日志插件：
+可以通过以下语句查看当前集群的实际值：
-`set global enable_audit_plugin = false;`
+```sql
+SHOW GLOBAL VARIABLES LIKE 'enable_audit_plugin';
+```
-关闭后，Doris 将会停止 `audit_log` 表的写入。已写入的审计日志不会变化。
+如果当前值为 `false`，可以随时开启：
+
+```sql
+SET GLOBAL enable_audit_plugin = true;
+```
+
+开启后，Doris 会将后续产生的审计日志写入 `__internal_schema.audit_log` 表。
+
+如需停止向审计日志表写入数据，可以关闭插件：
+
+```sql
+SET GLOBAL enable_audit_plugin = false;
+```
+
+关闭插件后，Doris 将停止向 `__internal_schema.audit_log` 表写入新记录，已写入的记录仍然保留。该变量不控制下文介绍的
`fe.audit.log` 文件。
## 查看审计日志表
diff --git a/versioned_docs/version-3.x/admin-manual/audit-plugin.md
b/versioned_docs/version-3.x/admin-manual/audit-plugin.md
index 60bcb169559..626515440eb 100644
--- a/versioned_docs/version-3.x/admin-manual/audit-plugin.md
+++ b/versioned_docs/version-3.x/admin-manual/audit-plugin.md
@@ -10,17 +10,37 @@ Doris provides auditing capabilities for database
operations, allowing the recor
## Enabling Audit Logs
-The audit log plugin can be enabled or disabled at any time using the global
variable `enable_audit_plugin` (disabled by default), for example:
+Doris has included a built-in audit log plugin since version 2.1.0; no
separate installation is required. The global variable `enable_audit_plugin`
controls whether audit logs are written to `__internal_schema.audit_log`. Its
default value depends on the Doris version:
-`set global enable_audit_plugin = true;`
+| Doris version | Default value of `enable_audit_plugin` |
+| --- | --- |
+| 2.1.x, 3.0.x, 3.1.0, and 3.1.1 | `false` (disabled) |
+| 3.1.2 and later 3.1.x releases | `true` (enabled) |
+| 4.0.0 and later releases | `true` (enabled) |
-Once enabled, Doris will write the audit logs to the `audit_log` table.
+The audit log plugin is enabled by default in 3.1.2 and later 3.1.x releases.
It is also enabled by default in 4.0.0 and later releases. In these versions,
`enable_audit_plugin` defaults to `true`.
-You can disable the audit log plugin at any time:
+Check the current value on your cluster:
-`set global enable_audit_plugin = false;`
+```sql
+SHOW GLOBAL VARIABLES LIKE 'enable_audit_plugin';
+```
-After disabling, Doris will stop writing to the `audit_log` table. The already
written audit logs will remain unchanged.
+If it is `false`, you can enable it at any time:
+
+```sql
+SET GLOBAL enable_audit_plugin = true;
+```
+
+Once enabled, Doris writes subsequent audit logs to
`__internal_schema.audit_log`.
+
+To disable writing to the audit log table:
+
+```sql
+SET GLOBAL enable_audit_plugin = false;
+```
+
+Disabling the plugin stops new writes to `__internal_schema.audit_log` and
preserves existing records. This variable does not control the `fe.audit.log`
files described below.
## Viewing the Audit Log Table
diff --git a/versioned_docs/version-4.x/admin-manual/audit-plugin.md
b/versioned_docs/version-4.x/admin-manual/audit-plugin.md
index 60bcb169559..626515440eb 100644
--- a/versioned_docs/version-4.x/admin-manual/audit-plugin.md
+++ b/versioned_docs/version-4.x/admin-manual/audit-plugin.md
@@ -10,17 +10,37 @@ Doris provides auditing capabilities for database
operations, allowing the recor
## Enabling Audit Logs
-The audit log plugin can be enabled or disabled at any time using the global
variable `enable_audit_plugin` (disabled by default), for example:
+Doris has included a built-in audit log plugin since version 2.1.0; no
separate installation is required. The global variable `enable_audit_plugin`
controls whether audit logs are written to `__internal_schema.audit_log`. Its
default value depends on the Doris version:
-`set global enable_audit_plugin = true;`
+| Doris version | Default value of `enable_audit_plugin` |
+| --- | --- |
+| 2.1.x, 3.0.x, 3.1.0, and 3.1.1 | `false` (disabled) |
+| 3.1.2 and later 3.1.x releases | `true` (enabled) |
+| 4.0.0 and later releases | `true` (enabled) |
-Once enabled, Doris will write the audit logs to the `audit_log` table.
+The audit log plugin is enabled by default in 3.1.2 and later 3.1.x releases.
It is also enabled by default in 4.0.0 and later releases. In these versions,
`enable_audit_plugin` defaults to `true`.
-You can disable the audit log plugin at any time:
+Check the current value on your cluster:
-`set global enable_audit_plugin = false;`
+```sql
+SHOW GLOBAL VARIABLES LIKE 'enable_audit_plugin';
+```
-After disabling, Doris will stop writing to the `audit_log` table. The already
written audit logs will remain unchanged.
+If it is `false`, you can enable it at any time:
+
+```sql
+SET GLOBAL enable_audit_plugin = true;
+```
+
+Once enabled, Doris writes subsequent audit logs to
`__internal_schema.audit_log`.
+
+To disable writing to the audit log table:
+
+```sql
+SET GLOBAL enable_audit_plugin = false;
+```
+
+Disabling the plugin stops new writes to `__internal_schema.audit_log` and
preserves existing records. This variable does not control the `fe.audit.log`
files described below.
## Viewing the Audit Log Table
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
