This is an automated email from the ASF dual-hosted git repository.
morningman 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 6a3efb39534 [opt] opt audit log related doc (#1325)
6a3efb39534 is described below
commit 6a3efb39534a0fdc995db8ac9e37416d31236483
Author: Mingyu Chen (Rayner) <[email protected]>
AuthorDate: Sun Nov 10 22:51:12 2024 +0800
[opt] opt audit log related doc (#1325)
# Versions
- [x] dev
- [x] 3.0
- [x] 2.1
- [ ] 2.0
# Languages
- [x] Chinese
- [x] English
---
docs/admin-manual/audit-plugin.md | 8 +++
.../system-tables/internal_schema/audit_log.md | 20 ++++++-
docs/admin-manual/system-tables/overview.md | 28 +++++++++-
.../docusaurus-plugin-content-docs/current.json | 14 ++---
.../current/admin-manual/audit-plugin.md | 8 +++
.../system-tables/internal_schema/audit_log.md | 62 +++++++++++++---------
.../current/admin-manual/system-tables/overview.md | 32 +++++++++--
.../version-2.1.json | 8 +--
.../version-2.1/admin-manual/audit-plugin.md | 19 +++++++
.../system-tables/internal_schema/audit_log.md | 62 +++++++++++++---------
.../admin-manual/system-tables/overview.md | 30 ++++++++++-
.../version-3.0.json | 8 +--
.../version-3.0/admin-manual/audit-plugin.md | 14 +++--
.../system-tables/internal_schema/audit_log.md | 62 +++++++++++++---------
.../admin-manual/system-tables/overview.md | 32 +++++++++--
sidebars.json | 8 +--
.../version-2.1/admin-manual/audit-plugin.md | 21 +++++++-
.../system-tables/internal_schema/audit_log.md | 20 ++++++-
.../admin-manual/system-tables/overview.md | 28 +++++++++-
.../version-3.0/admin-manual/audit-plugin.md | 8 +++
.../system-tables/internal_schema/audit_log.md | 20 ++++++-
.../admin-manual/system-tables/overview.md | 28 +++++++++-
versioned_sidebars/version-2.1-sidebars.json | 8 +--
versioned_sidebars/version-3.0-sidebars.json | 8 +--
24 files changed, 433 insertions(+), 123 deletions(-)
diff --git a/docs/admin-manual/audit-plugin.md
b/docs/admin-manual/audit-plugin.md
index 42e4fe67da6..e766379e2f2 100644
--- a/docs/admin-manual/audit-plugin.md
+++ b/docs/admin-manual/audit-plugin.md
@@ -53,6 +53,14 @@ The audit log plugin can be turned off at any time:
After disable, Doris will stop writing to the `audit_log` table. Audit logs
that have been written will not change.
+### Audit log table
+
+With the upgrade of Doris version, the fields of the audit log table will also
increase. For details, please refer to
[audit_log](./system-tables/internal_schema/audit_log.md)
+
+Starting from version 2.1.8 and 3.0.3, the `audit_log` system table will
automatically add new fields of `audit_log` table as the Doris version is
upgraded.
+
+In previous versions, users need to manually add fields to the `audit_log`
system table through the `ALTER TABLE` command.
+
### Related configuration
The audit log table is a dynamic partitioned table, partitioned by day, and
retains the data of the last 30 days by default.
diff --git a/docs/admin-manual/system-tables/internal_schema/audit_log.md
b/docs/admin-manual/system-tables/internal_schema/audit_log.md
index 4d77bb2796e..47428a19e76 100644
--- a/docs/admin-manual/system-tables/internal_schema/audit_log.md
+++ b/docs/admin-manual/system-tables/internal_schema/audit_log.md
@@ -39,7 +39,7 @@ Store audit logs
| Column Name | Type | Description
|
| ----------------- | ------------ |
------------------------------------------------------------ |
| query_id | varchar(48) | ID of the Query
|
-| time | datetime(3) | Time when the query was executed
|
+| time | datetime(3) | Time when the query was executed(in
milliseconds) |
| client_ip | varchar(128) | IP address of the client sending the
query |
| user | varchar(128) | User
|
| catalog | varchar(128) | Current Catalog during statement
execution |
@@ -51,12 +51,28 @@ Store audit logs
| scan_bytes | bigint | Amount of data scanned
|
| scan_rows | bigint | Number of rows scanned
|
| return_rows | bigint | Number of rows returned
|
+| shuffleSendRows | bigint | The number of rows transferred
between nodes during statement execution. Supported since version 3.0. |
+| shuffleSendBytes | bigint | The amount of data transferred
between nodes during statement execution. Supported since version 3.0. |
+| scanBytesFromLocalStorage | bigint | The amount of data read from the
local disk. Supported since version 3.0. |
+| scanBytesFromRemoteStorage | bigint | The amount of data read from the
remote storage. Supported since version 3.0. |
| stmt_id | bigint | Statement ID
|
+| stmt_type | string | Statement type. Supported since
version 3.0. |
| is_query | tinyint | Whether it is a query
|
+| is_nereids | booean | Is using Nereids Optimizer. |
| frontend_ip | varchar(128) | IP address of the connected Frontend
|
| cpu_time_ms | bigint | Cumulative CPU time (in milliseconds)
consumed by the Backend for statement execution |
| sql_hash | varchar(128) | Hash value of the statement
|
| sql_digest | varchar(128) | Digest (signature) of the statement
|
| peak_memory_bytes | bigint | Peak memory usage of the Backend during
statement execution |
| workload_group | text | Workload Group used for statement
execution |
-| stmt | text | Statement text
|
\ No newline at end of file
+| compute_group | string | In storage and computation
decouped mode, the compute group used by the execution statement. Supported
since version 3.0.|
+| trace_id | string | Trace ID set when executing the
statement |
+| stmt | text | Statement text
|
+
+
+## Description
+
+- `client_ip`: If a proxy service is used and the IP pass-through is not
enabled, the proxy service IP may be recorded here instead of the real client
IP.
+- `state`: `EOF` indicates that the query is executed successfully. `OK`
indicates that the DDL and DML statements are executed successfully. `ERR`
indicates that the statement execution fails.
+
+
diff --git a/docs/admin-manual/system-tables/overview.md
b/docs/admin-manual/system-tables/overview.md
index e2a19e33b31..76a5fe96687 100644
--- a/docs/admin-manual/system-tables/overview.md
+++ b/docs/admin-manual/system-tables/overview.md
@@ -1,7 +1,7 @@
---
{
"title": "Overview",
- "language": "en"
+ "language": "zh-CN"
}
---
@@ -24,4 +24,28 @@ specific language governing permissions and limitations
under the License.
-->
-The information_schema database in Doris is a special virtual database that
contains metadata about the Doris cluster and all its database objects. These
objects include databases, tables, columns, privileges, and more. Within the
information_schema database, there are multiple read-only tables, which are
actually views rather than real tables. Therefore, only SELECT operations can
be performed on these tables, and data modification operations such as INSERT,
UPDATE, DELETE, etc., are no [...]
\ No newline at end of file
+Apache Doris cluster has multiple built-in system databases to store metadata
information about the Doris system itself.
+
+### information_schema
+
+All tables under the `information_schema` database are virtual tables and do
not have physical entities. These system tables contain metadata about the
Doris cluster and all its database objects, including databases, tables,
columns, permissions, etc. They also include functional status information like
Workload Group, Task, etc.
+
+There is an `information_schema` database under each Catalog, containing
metadata only for the corresponding Catalog's databases and tables.
+
+All tables in the `information_schema` database are read-only, and users
cannot modify, drop, or create tables in this database.
+
+By default, all users have read permissions for all tables in this database,
but the query results will vary based on the user's actual permission. For
example, if User A only has permissions for `db1.table1`, querying the
`information_schema.tables` table will only return information related to
`db1.table1`.
+
+### mysql
+
+All tables under the `mysql` database are virtual tables and do not have
physical entities. These system tables contain information such as permissions
and are mainly used for MySQL ecosystem compatibility.
+
+There is a `mysql` database under each Catalog, but the content of tables is
identical.
+
+All tables in the `mysql` database are read-only, and users cannot modify,
delete, or create tables in this database.
+
+### __internal_schema
+
+All tables under the `__internal_schema` database are actual tables in Doris,
stored similarly to user-created data tables. When a Doris cluster is created,
all system tables under this database are automatically created.
+
+By default, common users have read-only permissions for tables in this
database. However, once granted, they can modify, delete, or create tables
under this database.
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current.json
b/i18n/zh-CN/docusaurus-plugin-content-docs/current.json
index 7d3b9ac3ac7..9d9fb996edd 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current.json
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current.json
@@ -207,16 +207,16 @@
"message": "系统表",
"description": "The label for category System Table in sidebar docs"
},
- "sidebar.docs.category.Database: information_schema": {
- "message": "所属数据库：information_schema",
+ "sidebar.docs.category.information_schema": {
+ "message": "information_schema",
"description": "The label for category System Table in sidebar docs"
},
- "sidebar.docs.category.Database: MySQL": {
- "message": "所属数据库：MySQL",
+ "sidebar.docs.category.mysql": {
+ "message": "mysql",
"description": "The label for category System Table in sidebar docs"
},
- "sidebar.docs.category.Database: __internal_schema": {
- "message": "所属数据库：__internal_schema",
+ "sidebar.docs.category.__internal_schema": {
+ "message": "__internal_schema",
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.OPEN API": {
@@ -455,4 +455,4 @@
"message": "跨集群复制",
"description": "The label for category Cross Cluster Replication in
sidebar docs"
}
-}
\ No newline at end of file
+}
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 85eda39dcaf..8f1e109b3dc 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
@@ -54,6 +54,14 @@ Doris 的审计日志插件是在 FE 的插件框架基础上开发的。是一
关闭后，Doris 将会停止 `audit_log` 表的写入。已写入的审计日志不会变化。
+### 审计日志表
+
+随着 Doris 的版本升级，审计日志表的字段也会增加，具体请参阅
[audit_log](./system-tables/internal_schema/audit_log.md)
+
+自 2.1.8 和 3.0.3 版本开始，`audit_log` 系统表会随着 Doris 版本升级，自动添加新增字段。
+
+之前的版本，用户需手动通过 `ALTER TABLE` 命令为 `audit_log` 系统表增加字段。
+
### 相关配置
审计日志表是一张动态分区表，按天分区，默认保留最近 30 天的数据。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/system-tables/internal_schema/audit_log.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/system-tables/internal_schema/audit_log.md
index a477332d804..1ad1a824bde 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/system-tables/internal_schema/audit_log.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/system-tables/internal_schema/audit_log.md
@@ -36,27 +36,41 @@ under the License.
## 表信息
-| 列名 | 类型 | 说明 |
-| :---------------- | :----------- | :------------------------------------- |
-| query_id | varchar(48) | Query 的 ID |
-| time | datetime(3) | 查询发生的时间 |
-| client_ip | varchar(128) | 发送查询的客户端 IP |
-| user | varchar(128) | 用户 |
-| catalog | varchar(128) | 语句执行时的当前 Catalog |
-| db | varchar(128) | 语句执行时的当前 Database |
-| state | varchar(128) | 语句执行状态 |
-| error_code | int | 错误码 |
-| error_message | text | 错误信息 |
-| query_time | bigint | 语句执行时间 |
-| scan_bytes | bigint | 扫描的数据量 |
-| scan_rows | bigint | 扫描行数 |
-| return_rows | bigint | 返回的行数 |
-| stmt_id | bigint | 语句 ID |
-| is_query | tinyint | 是否是查询 |
-| frontend_ip | varchar(128) | 连接的 Frontend 的 IP |
-| cpu_time_ms | bigint | 语句执行消耗 Backend 的累计 CPU 毫秒数 |
-| sql_hash | varchar(128) | 语句的 Hash 值 |
-| sql_digest | varchar(128) | 语句的签名 |
-| peak_memory_bytes | bigint | 语句执行所占用的 Backend 内存的峰值 |
-| workload_group | text | 语句执行所使用的 Workload Group |
-| stmt | text | 语句文本 |
\ No newline at end of file
+| 列名 | 类型 | 说明
|
+| :-------------------------- | :----------- |
:------------------------------------- |
+| query_id | varchar(48) | Query 的 ID。
|
+| time | datetime(3) | 查询发生的时间。
|
+| client_ip | varchar(128) | 发送查询的客户端 IP
|
+| user | varchar(128) | 用户
|
+| catalog | varchar(128) | 语句执行时的当前
Catalog |
+| db | varchar(128) | 语句执行时的当前
Database |
+| state | varchar(128) | 语句执行状态
|
+| error_code | int | 错误码
|
+| error_message | text | 错误信息
|
+| query_time | bigint | 语句执行时间。单位为毫秒。
|
+| scan_bytes | bigint | 扫描的数据量。
|
+| scan_rows | bigint | 扫描行数
|
+| return_rows | bigint | 返回的行数
|
+| shuffleSendRows | bigint | 语句执行过程中，节点间传输的行数。3.0 版本开始支持。|
+| shuffleSendBytes | bigint | 语句执行过程中，节点间传输的数据量。3.0 版本开始支持。 |
+| scanBytesFromLocalStorage | bigint | 从本地磁盘读取的数据量。3.0 版本开始支持。 |
+| scanBytesFromRemoteStorage | bigint | 从远端存储读取的数据量。3.0 版本开始支持。 |
+| stmt_id | bigint | 语句 ID
|
+| stmt_type | string | 语句类型。3.0 版本开始支持。 |
+| is_query | tinyint | 是否是查询
|
+| is_nereids | booean | 是否使用了新优化器 |
+| frontend_ip | varchar(128) | 连接的 Frontend 的
IP |
+| cpu_time_ms | bigint | 语句执行消耗 Backend
的累计 CPU 毫秒数 |
+| sql_hash | varchar(128) | 语句的 Hash 值
|
+| sql_digest | varchar(128) | 语句的签名
|
+| peak_memory_bytes | bigint | 语句执行所占用的
Backend 内存的峰值 |
+| workload_group | text | 语句执行所使用的
Workload Group |
+| compute_group | string |
存算分离模式下，执行语句所使用的计算组。3.0 版本开始支持。|
+| trace_id | string | 执行语句时设置的 Trace ID |
+| stmt | text | 语句文本
|
+
+## 说明
+
+- `client_ip`：如果使用了代理服务，并且没有开启 IP 透传功能，则这里可能记录的是代理服务的 IP 而不是真实客户端 IP。
+- `state`：`EOF` 表示查询执行成功。`OK` 表示 DDL、DML语句执行成功。`ERR` 表示语句执行失败。
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/system-tables/overview.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/system-tables/overview.md
index e7108b96ee9..5b8a6b5ca39 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/system-tables/overview.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/system-tables/overview.md
@@ -1,6 +1,6 @@
---
{
- "title": "Overview",
+ "title": "概述",
"language": "zh-CN"
}
---
@@ -24,6 +24,32 @@ specific language governing permissions and limitations
under the License.
-->
-Doris 中的 information_schema 库是一个特殊的虚拟数据库，它包含了关于 Doris 集群
及其所有数据库对象的元数据。这些对象包括数据库、表、列、权限等。在 information_schema
库中，存在多张只读表，它们实际上是视图而不是真实的表。因此，在这些表上只能执行 SELECT 操作，而不能执行 INSERT，UPDATE，DELETE
等数据修改操作。
+Doris 集群内置多个系统数据库，用于存储 Doris 系统本身的一些元数据信息。
+
+## information_schema
+
+`information_schema` 库下的所有表都是虚拟表，本身并不存在物理实体。这些系统表包含了关于 Doris
集群及其所有数据库对象的元数据。这些对象包括数据库、表、列、权限等。
+也包含如 Workload Group、Task 等功能状态信息。
+
+每个 Catalog 下都存在一个 `information_schema` 库。其中只包含对应 Catalog 下的库表的元数据。
+
+`information_schema` 库中得所有表都是只读状态，用户无法在这个库中修改、删除或创建表。
+
+所有用户默认对这个库下的所有表拥有读权限，但可查询的内容会根据用户实际的权限范围而不同。比如用户 A 只拥有 `db1.table1` 的权限。则用户查询
`information_schema.tables` 表时，只会返回 `db1.table1` 相关的信息。
+
+
+## mysql
+
+`mysql` 库下的所有表都是虚拟表，本身并不存在物理实体。这些系统表包含如权限等信息，主要用于兼容 MySQL 生态。
+
+每个 Catalog 下都存在一个 `mysql` 库。但其中的表的内容完全一样。
+
+`mysql` 库中得所有表都是只读状态，用户无法在这个库中修改、删除或创建表。
+
+## __internal_schema
+
+`__internal_schema` 库下的所有表都是 Doris 的实体表，其存储方式和用户创建的数据表无异。
+Doris 会在集群创建时，自动创建这个库下的所有系统表。
+
+默认情况下，普通用户对这个库下的表拥有只读权限。但被授权后，可以对这个库下的表进行修改、删除或创建。
-本章节将分别介绍所属数据库 `information_schema`、`mysql`、 `__internal_schema` 下的各类表信息。
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1.json
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1.json
index dd4d96895f5..f56b4b04f9c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1.json
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1.json
@@ -196,15 +196,15 @@
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.Database: information_schema": {
- "message": "所属数据库：information_schema",
+ "message": "information_schema",
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.Database: MySQL": {
- "message": "所属数据库：MySQL",
+ "message": "mysql",
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.Database: __internal_schema": {
- "message": "所属数据库：__internal_schema",
+ "message": "__internal_schema",
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.OPEN API": {
@@ -443,4 +443,4 @@
"message": "构建 Lakehouse",
"description": "The label for category BI and Database IDE in sidebar docs"
}
-}
\ No newline at end of file
+}
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/audit-plugin.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/audit-plugin.md
index b18c559dfd6..8f1e109b3dc 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/audit-plugin.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/audit-plugin.md
@@ -54,6 +54,14 @@ Doris 的审计日志插件是在 FE 的插件框架基础上开发的。是一
关闭后，Doris 将会停止 `audit_log` 表的写入。已写入的审计日志不会变化。
+### 审计日志表
+
+随着 Doris 的版本升级，审计日志表的字段也会增加，具体请参阅
[audit_log](./system-tables/internal_schema/audit_log.md)
+
+自 2.1.8 和 3.0.3 版本开始，`audit_log` 系统表会随着 Doris 版本升级，自动添加新增字段。
+
+之前的版本，用户需手动通过 `ALTER TABLE` 命令为 `audit_log` 系统表增加字段。
+
### 相关配置
审计日志表是一张动态分区表，按天分区，默认保留最近 30 天的数据。
@@ -67,6 +75,17 @@ Doris 的审计日志插件是在 FE 的插件框架基础上开发的。是一
可以通过 `set global xxx=yyy` 进行设置。
+FE 配置项：
+
+- `skip_audit_user_list` (自 3.0.1 支持)
+
+ 如果不希望某些用户的操作被审计日志记录，可以通过这个配置修改。
+
+ ```
+ skip_audit_user_list=root
+ -- or
+ skip_audit_user_list=user1,user2
+ ```
## 编译、配置和部署
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/system-tables/internal_schema/audit_log.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/system-tables/internal_schema/audit_log.md
index a477332d804..1ad1a824bde 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/system-tables/internal_schema/audit_log.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/system-tables/internal_schema/audit_log.md
@@ -36,27 +36,41 @@ under the License.
## 表信息
-| 列名 | 类型 | 说明 |
-| :---------------- | :----------- | :------------------------------------- |
-| query_id | varchar(48) | Query 的 ID |
-| time | datetime(3) | 查询发生的时间 |
-| client_ip | varchar(128) | 发送查询的客户端 IP |
-| user | varchar(128) | 用户 |
-| catalog | varchar(128) | 语句执行时的当前 Catalog |
-| db | varchar(128) | 语句执行时的当前 Database |
-| state | varchar(128) | 语句执行状态 |
-| error_code | int | 错误码 |
-| error_message | text | 错误信息 |
-| query_time | bigint | 语句执行时间 |
-| scan_bytes | bigint | 扫描的数据量 |
-| scan_rows | bigint | 扫描行数 |
-| return_rows | bigint | 返回的行数 |
-| stmt_id | bigint | 语句 ID |
-| is_query | tinyint | 是否是查询 |
-| frontend_ip | varchar(128) | 连接的 Frontend 的 IP |
-| cpu_time_ms | bigint | 语句执行消耗 Backend 的累计 CPU 毫秒数 |
-| sql_hash | varchar(128) | 语句的 Hash 值 |
-| sql_digest | varchar(128) | 语句的签名 |
-| peak_memory_bytes | bigint | 语句执行所占用的 Backend 内存的峰值 |
-| workload_group | text | 语句执行所使用的 Workload Group |
-| stmt | text | 语句文本 |
\ No newline at end of file
+| 列名 | 类型 | 说明
|
+| :-------------------------- | :----------- |
:------------------------------------- |
+| query_id | varchar(48) | Query 的 ID。
|
+| time | datetime(3) | 查询发生的时间。
|
+| client_ip | varchar(128) | 发送查询的客户端 IP
|
+| user | varchar(128) | 用户
|
+| catalog | varchar(128) | 语句执行时的当前
Catalog |
+| db | varchar(128) | 语句执行时的当前
Database |
+| state | varchar(128) | 语句执行状态
|
+| error_code | int | 错误码
|
+| error_message | text | 错误信息
|
+| query_time | bigint | 语句执行时间。单位为毫秒。
|
+| scan_bytes | bigint | 扫描的数据量。
|
+| scan_rows | bigint | 扫描行数
|
+| return_rows | bigint | 返回的行数
|
+| shuffleSendRows | bigint | 语句执行过程中，节点间传输的行数。3.0 版本开始支持。|
+| shuffleSendBytes | bigint | 语句执行过程中，节点间传输的数据量。3.0 版本开始支持。 |
+| scanBytesFromLocalStorage | bigint | 从本地磁盘读取的数据量。3.0 版本开始支持。 |
+| scanBytesFromRemoteStorage | bigint | 从远端存储读取的数据量。3.0 版本开始支持。 |
+| stmt_id | bigint | 语句 ID
|
+| stmt_type | string | 语句类型。3.0 版本开始支持。 |
+| is_query | tinyint | 是否是查询
|
+| is_nereids | booean | 是否使用了新优化器 |
+| frontend_ip | varchar(128) | 连接的 Frontend 的
IP |
+| cpu_time_ms | bigint | 语句执行消耗 Backend
的累计 CPU 毫秒数 |
+| sql_hash | varchar(128) | 语句的 Hash 值
|
+| sql_digest | varchar(128) | 语句的签名
|
+| peak_memory_bytes | bigint | 语句执行所占用的
Backend 内存的峰值 |
+| workload_group | text | 语句执行所使用的
Workload Group |
+| compute_group | string |
存算分离模式下，执行语句所使用的计算组。3.0 版本开始支持。|
+| trace_id | string | 执行语句时设置的 Trace ID |
+| stmt | text | 语句文本
|
+
+## 说明
+
+- `client_ip`：如果使用了代理服务，并且没有开启 IP 透传功能，则这里可能记录的是代理服务的 IP 而不是真实客户端 IP。
+- `state`：`EOF` 表示查询执行成功。`OK` 表示 DDL、DML语句执行成功。`ERR` 表示语句执行失败。
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/system-tables/overview.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/system-tables/overview.md
index 0d3719d5731..5b8a6b5ca39 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/system-tables/overview.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/system-tables/overview.md
@@ -24,6 +24,32 @@ specific language governing permissions and limitations
under the License.
-->
-Doris 中的 information_schema 库是一个特殊的虚拟数据库，它包含了关于 Doris 集群
及其所有数据库对象的元数据。这些对象包括数据库、表、列、权限等。在 information_schema
库中，存在多张只读表，它们实际上是视图而不是真实的表。因此，在这些表上只能执行 SELECT 操作，而不能执行 INSERT，UPDATE，DELETE
等数据修改操作。
+Doris 集群内置多个系统数据库，用于存储 Doris 系统本身的一些元数据信息。
+
+## information_schema
+
+`information_schema` 库下的所有表都是虚拟表，本身并不存在物理实体。这些系统表包含了关于 Doris
集群及其所有数据库对象的元数据。这些对象包括数据库、表、列、权限等。
+也包含如 Workload Group、Task 等功能状态信息。
+
+每个 Catalog 下都存在一个 `information_schema` 库。其中只包含对应 Catalog 下的库表的元数据。
+
+`information_schema` 库中得所有表都是只读状态，用户无法在这个库中修改、删除或创建表。
+
+所有用户默认对这个库下的所有表拥有读权限，但可查询的内容会根据用户实际的权限范围而不同。比如用户 A 只拥有 `db1.table1` 的权限。则用户查询
`information_schema.tables` 表时，只会返回 `db1.table1` 相关的信息。
+
+
+## mysql
+
+`mysql` 库下的所有表都是虚拟表，本身并不存在物理实体。这些系统表包含如权限等信息，主要用于兼容 MySQL 生态。
+
+每个 Catalog 下都存在一个 `mysql` 库。但其中的表的内容完全一样。
+
+`mysql` 库中得所有表都是只读状态，用户无法在这个库中修改、删除或创建表。
+
+## __internal_schema
+
+`__internal_schema` 库下的所有表都是 Doris 的实体表，其存储方式和用户创建的数据表无异。
+Doris 会在集群创建时，自动创建这个库下的所有系统表。
+
+默认情况下，普通用户对这个库下的表拥有只读权限。但被授权后，可以对这个库下的表进行修改、删除或创建。
-本章节将分别介绍所属数据库 `information_schema`、`mysql`、 `__internal_schema` 下的各类表信息。
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0.json
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0.json
index dde198ef932..3c14b74890b 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0.json
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0.json
@@ -204,15 +204,15 @@
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.Database: information_schema": {
- "message": "所属数据库：information_schema",
+ "message": "information_schema",
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.Database: MySQL": {
- "message": "所属数据库：MySQL",
+ "message": "mysql",
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.Database: __internal_schema": {
- "message": "所属数据库：__internal_schema",
+ "message": "__internal_schema",
"description": "The label for category System Table in sidebar docs"
},
"sidebar.docs.category.OPEN API": {
@@ -455,4 +455,4 @@
"message": "构建 Lakehouse",
"description": "The label for category BI and Database IDE in sidebar docs"
}
-}
\ No newline at end of file
+}
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/audit-plugin.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/audit-plugin.md
index 104c643571b..8f1e109b3dc 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/audit-plugin.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/audit-plugin.md
@@ -54,6 +54,14 @@ Doris 的审计日志插件是在 FE 的插件框架基础上开发的。是一
关闭后，Doris 将会停止 `audit_log` 表的写入。已写入的审计日志不会变化。
+### 审计日志表
+
+随着 Doris 的版本升级，审计日志表的字段也会增加，具体请参阅
[audit_log](./system-tables/internal_schema/audit_log.md)
+
+自 2.1.8 和 3.0.3 版本开始，`audit_log` 系统表会随着 Doris 版本升级，自动添加新增字段。
+
+之前的版本，用户需手动通过 `ALTER TABLE` 命令为 `audit_log` 系统表增加字段。
+
### 相关配置
审计日志表是一张动态分区表，按天分区，默认保留最近 30 天的数据。
@@ -72,7 +80,7 @@ FE 配置项：
- `skip_audit_user_list` (自 3.0.1 支持)
如果不希望某些用户的操作被审计日志记录，可以通过这个配置修改。
-<!-- unexecutable: configuration -->
+
```
skip_audit_user_list=root
-- or
@@ -122,7 +130,7 @@ Doris 2.1 版本之前的用户，请参阅如下方式使用审计日志插件
* password：集群用户密码。
4. 重新打包 Audit Loader 插件
-<!-- unexecutable: zip shell command -->
+
```shell
zip -r -q -m auditloader.zip auditloader.jar plugin.properties plugin.conf
```
@@ -134,7 +142,7 @@ Doris 2.1 版本之前的用户，请参阅如下方式使用审计日志插件
若需开启慢查询日志导入功能，还需要额外创建慢表 `doris_slow_log_tbl__`，其表结构与 `doris_audit_log_tbl__`
一致。
其中 `dynamic_partition` 属性根据自己的需要，选择审计日志保留的天数。
-<!-- executable: create audit table -->
+
```sql
create database doris_audit_db__;
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/system-tables/internal_schema/audit_log.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/system-tables/internal_schema/audit_log.md
index a477332d804..1ad1a824bde 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/system-tables/internal_schema/audit_log.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/system-tables/internal_schema/audit_log.md
@@ -36,27 +36,41 @@ under the License.
## 表信息
-| 列名 | 类型 | 说明 |
-| :---------------- | :----------- | :------------------------------------- |
-| query_id | varchar(48) | Query 的 ID |
-| time | datetime(3) | 查询发生的时间 |
-| client_ip | varchar(128) | 发送查询的客户端 IP |
-| user | varchar(128) | 用户 |
-| catalog | varchar(128) | 语句执行时的当前 Catalog |
-| db | varchar(128) | 语句执行时的当前 Database |
-| state | varchar(128) | 语句执行状态 |
-| error_code | int | 错误码 |
-| error_message | text | 错误信息 |
-| query_time | bigint | 语句执行时间 |
-| scan_bytes | bigint | 扫描的数据量 |
-| scan_rows | bigint | 扫描行数 |
-| return_rows | bigint | 返回的行数 |
-| stmt_id | bigint | 语句 ID |
-| is_query | tinyint | 是否是查询 |
-| frontend_ip | varchar(128) | 连接的 Frontend 的 IP |
-| cpu_time_ms | bigint | 语句执行消耗 Backend 的累计 CPU 毫秒数 |
-| sql_hash | varchar(128) | 语句的 Hash 值 |
-| sql_digest | varchar(128) | 语句的签名 |
-| peak_memory_bytes | bigint | 语句执行所占用的 Backend 内存的峰值 |
-| workload_group | text | 语句执行所使用的 Workload Group |
-| stmt | text | 语句文本 |
\ No newline at end of file
+| 列名 | 类型 | 说明
|
+| :-------------------------- | :----------- |
:------------------------------------- |
+| query_id | varchar(48) | Query 的 ID。
|
+| time | datetime(3) | 查询发生的时间。
|
+| client_ip | varchar(128) | 发送查询的客户端 IP
|
+| user | varchar(128) | 用户
|
+| catalog | varchar(128) | 语句执行时的当前
Catalog |
+| db | varchar(128) | 语句执行时的当前
Database |
+| state | varchar(128) | 语句执行状态
|
+| error_code | int | 错误码
|
+| error_message | text | 错误信息
|
+| query_time | bigint | 语句执行时间。单位为毫秒。
|
+| scan_bytes | bigint | 扫描的数据量。
|
+| scan_rows | bigint | 扫描行数
|
+| return_rows | bigint | 返回的行数
|
+| shuffleSendRows | bigint | 语句执行过程中，节点间传输的行数。3.0 版本开始支持。|
+| shuffleSendBytes | bigint | 语句执行过程中，节点间传输的数据量。3.0 版本开始支持。 |
+| scanBytesFromLocalStorage | bigint | 从本地磁盘读取的数据量。3.0 版本开始支持。 |
+| scanBytesFromRemoteStorage | bigint | 从远端存储读取的数据量。3.0 版本开始支持。 |
+| stmt_id | bigint | 语句 ID
|
+| stmt_type | string | 语句类型。3.0 版本开始支持。 |
+| is_query | tinyint | 是否是查询
|
+| is_nereids | booean | 是否使用了新优化器 |
+| frontend_ip | varchar(128) | 连接的 Frontend 的
IP |
+| cpu_time_ms | bigint | 语句执行消耗 Backend
的累计 CPU 毫秒数 |
+| sql_hash | varchar(128) | 语句的 Hash 值
|
+| sql_digest | varchar(128) | 语句的签名
|
+| peak_memory_bytes | bigint | 语句执行所占用的
Backend 内存的峰值 |
+| workload_group | text | 语句执行所使用的
Workload Group |
+| compute_group | string |
存算分离模式下，执行语句所使用的计算组。3.0 版本开始支持。|
+| trace_id | string | 执行语句时设置的 Trace ID |
+| stmt | text | 语句文本
|
+
+## 说明
+
+- `client_ip`：如果使用了代理服务，并且没有开启 IP 透传功能，则这里可能记录的是代理服务的 IP 而不是真实客户端 IP。
+- `state`：`EOF` 表示查询执行成功。`OK` 表示 DDL、DML语句执行成功。`ERR` 表示语句执行失败。
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/system-tables/overview.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/system-tables/overview.md
index e7108b96ee9..5b8a6b5ca39 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/system-tables/overview.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/system-tables/overview.md
@@ -1,6 +1,6 @@
---
{
- "title": "Overview",
+ "title": "概述",
"language": "zh-CN"
}
---
@@ -24,6 +24,32 @@ specific language governing permissions and limitations
under the License.
-->
-Doris 中的 information_schema 库是一个特殊的虚拟数据库，它包含了关于 Doris 集群
及其所有数据库对象的元数据。这些对象包括数据库、表、列、权限等。在 information_schema
库中，存在多张只读表，它们实际上是视图而不是真实的表。因此，在这些表上只能执行 SELECT 操作，而不能执行 INSERT，UPDATE，DELETE
等数据修改操作。
+Doris 集群内置多个系统数据库，用于存储 Doris 系统本身的一些元数据信息。
+
+## information_schema
+
+`information_schema` 库下的所有表都是虚拟表，本身并不存在物理实体。这些系统表包含了关于 Doris
集群及其所有数据库对象的元数据。这些对象包括数据库、表、列、权限等。
+也包含如 Workload Group、Task 等功能状态信息。
+
+每个 Catalog 下都存在一个 `information_schema` 库。其中只包含对应 Catalog 下的库表的元数据。
+
+`information_schema` 库中得所有表都是只读状态，用户无法在这个库中修改、删除或创建表。
+
+所有用户默认对这个库下的所有表拥有读权限，但可查询的内容会根据用户实际的权限范围而不同。比如用户 A 只拥有 `db1.table1` 的权限。则用户查询
`information_schema.tables` 表时，只会返回 `db1.table1` 相关的信息。
+
+
+## mysql
+
+`mysql` 库下的所有表都是虚拟表，本身并不存在物理实体。这些系统表包含如权限等信息，主要用于兼容 MySQL 生态。
+
+每个 Catalog 下都存在一个 `mysql` 库。但其中的表的内容完全一样。
+
+`mysql` 库中得所有表都是只读状态，用户无法在这个库中修改、删除或创建表。
+
+## __internal_schema
+
+`__internal_schema` 库下的所有表都是 Doris 的实体表，其存储方式和用户创建的数据表无异。
+Doris 会在集群创建时，自动创建这个库下的所有系统表。
+
+默认情况下，普通用户对这个库下的表拥有只读权限。但被授权后，可以对这个库下的表进行修改、删除或创建。
-本章节将分别介绍所属数据库 `information_schema`、`mysql`、 `__internal_schema` 下的各类表信息。
\ No newline at end of file
diff --git a/sidebars.json b/sidebars.json
index a47dc7360be..7c10f98f91b 100644
--- a/sidebars.json
+++ b/sidebars.json
@@ -491,7 +491,7 @@
"admin-manual/system-tables/overview",
{
"type": "category",
- "label": "Database: information_schema",
+ "label": "information_schema",
"items": [
"admin-manual/system-tables/information_schema/active_queries",
"admin-manual/system-tables/information_schema/backend_active_tasks",
@@ -534,7 +534,7 @@
},
{
"type": "category",
- "label": "Database: MySQL",
+ "label": "mysql",
"items": [
"admin-manual/system-tables/mysql/props_priv",
"admin-manual/system-tables/mysql/user"
@@ -542,7 +542,7 @@
},
{
"type": "category",
- "label": "Database: __internal_schema",
+ "label": "__internal_schema",
"items": [
"admin-manual/system-tables/internal_schema/audit_log",
"admin-manual/system-tables/internal_schema/column_statistics",
@@ -1812,4 +1812,4 @@
]
}
]
-}
\ No newline at end of file
+}
diff --git a/versioned_docs/version-2.1/admin-manual/audit-plugin.md
b/versioned_docs/version-2.1/admin-manual/audit-plugin.md
index a1fbcc10928..e766379e2f2 100644
--- a/versioned_docs/version-2.1/admin-manual/audit-plugin.md
+++ b/versioned_docs/version-2.1/admin-manual/audit-plugin.md
@@ -24,7 +24,6 @@ specific language governing permissions and limitations
under the License.
-->
-# Audit Log Plugin
Doris's audit log plugin was developed based on FE's plugin framework. Is an
optional plugin. Users can install or uninstall this plugin at runtime.
@@ -54,6 +53,14 @@ The audit log plugin can be turned off at any time:
After disable, Doris will stop writing to the `audit_log` table. Audit logs
that have been written will not change.
+### Audit log table
+
+With the upgrade of Doris version, the fields of the audit log table will also
increase. For details, please refer to
[audit_log](./system-tables/internal_schema/audit_log.md)
+
+Starting from version 2.1.8 and 3.0.3, the `audit_log` system table will
automatically add new fields of `audit_log` table as the Doris version is
upgraded.
+
+In previous versions, users need to manually add fields to the `audit_log`
system table through the `ALTER TABLE` command.
+
### Related configuration
The audit log table is a dynamic partitioned table, partitioned by day, and
retains the data of the last 30 days by default.
@@ -67,6 +74,18 @@ The following 3 global variables can control some writing
behaviors of the audit
Can be set via `set global xxx=yyy`.
+FE configurations:
+
+- `skip_audit_user_list` (Since 3.0.1)
+
+ If you do not want certain users' operations to be recorded in the audit
log, you can modify this configuration.
+
+ ```
+ skip_audit_user_list=root
+ -- or
+ skip_audit_user_list=user1,user2
+ ```
+
## Compilation, Configuration and Deployment
### FE Configuration
diff --git
a/versioned_docs/version-2.1/admin-manual/system-tables/internal_schema/audit_log.md
b/versioned_docs/version-2.1/admin-manual/system-tables/internal_schema/audit_log.md
index 4d77bb2796e..47428a19e76 100644
---
a/versioned_docs/version-2.1/admin-manual/system-tables/internal_schema/audit_log.md
+++
b/versioned_docs/version-2.1/admin-manual/system-tables/internal_schema/audit_log.md
@@ -39,7 +39,7 @@ Store audit logs
| Column Name | Type | Description
|
| ----------------- | ------------ |
------------------------------------------------------------ |
| query_id | varchar(48) | ID of the Query
|
-| time | datetime(3) | Time when the query was executed
|
+| time | datetime(3) | Time when the query was executed(in
milliseconds) |
| client_ip | varchar(128) | IP address of the client sending the
query |
| user | varchar(128) | User
|
| catalog | varchar(128) | Current Catalog during statement
execution |
@@ -51,12 +51,28 @@ Store audit logs
| scan_bytes | bigint | Amount of data scanned
|
| scan_rows | bigint | Number of rows scanned
|
| return_rows | bigint | Number of rows returned
|
+| shuffleSendRows | bigint | The number of rows transferred
between nodes during statement execution. Supported since version 3.0. |
+| shuffleSendBytes | bigint | The amount of data transferred
between nodes during statement execution. Supported since version 3.0. |
+| scanBytesFromLocalStorage | bigint | The amount of data read from the
local disk. Supported since version 3.0. |
+| scanBytesFromRemoteStorage | bigint | The amount of data read from the
remote storage. Supported since version 3.0. |
| stmt_id | bigint | Statement ID
|
+| stmt_type | string | Statement type. Supported since
version 3.0. |
| is_query | tinyint | Whether it is a query
|
+| is_nereids | booean | Is using Nereids Optimizer. |
| frontend_ip | varchar(128) | IP address of the connected Frontend
|
| cpu_time_ms | bigint | Cumulative CPU time (in milliseconds)
consumed by the Backend for statement execution |
| sql_hash | varchar(128) | Hash value of the statement
|
| sql_digest | varchar(128) | Digest (signature) of the statement
|
| peak_memory_bytes | bigint | Peak memory usage of the Backend during
statement execution |
| workload_group | text | Workload Group used for statement
execution |
-| stmt | text | Statement text
|
\ No newline at end of file
+| compute_group | string | In storage and computation
decouped mode, the compute group used by the execution statement. Supported
since version 3.0.|
+| trace_id | string | Trace ID set when executing the
statement |
+| stmt | text | Statement text
|
+
+
+## Description
+
+- `client_ip`: If a proxy service is used and the IP pass-through is not
enabled, the proxy service IP may be recorded here instead of the real client
IP.
+- `state`: `EOF` indicates that the query is executed successfully. `OK`
indicates that the DDL and DML statements are executed successfully. `ERR`
indicates that the statement execution fails.
+
+
diff --git a/versioned_docs/version-2.1/admin-manual/system-tables/overview.md
b/versioned_docs/version-2.1/admin-manual/system-tables/overview.md
index e2a19e33b31..76a5fe96687 100644
--- a/versioned_docs/version-2.1/admin-manual/system-tables/overview.md
+++ b/versioned_docs/version-2.1/admin-manual/system-tables/overview.md
@@ -1,7 +1,7 @@
---
{
"title": "Overview",
- "language": "en"
+ "language": "zh-CN"
}
---
@@ -24,4 +24,28 @@ specific language governing permissions and limitations
under the License.
-->
-The information_schema database in Doris is a special virtual database that
contains metadata about the Doris cluster and all its database objects. These
objects include databases, tables, columns, privileges, and more. Within the
information_schema database, there are multiple read-only tables, which are
actually views rather than real tables. Therefore, only SELECT operations can
be performed on these tables, and data modification operations such as INSERT,
UPDATE, DELETE, etc., are no [...]
\ No newline at end of file
+Apache Doris cluster has multiple built-in system databases to store metadata
information about the Doris system itself.
+
+### information_schema
+
+All tables under the `information_schema` database are virtual tables and do
not have physical entities. These system tables contain metadata about the
Doris cluster and all its database objects, including databases, tables,
columns, permissions, etc. They also include functional status information like
Workload Group, Task, etc.
+
+There is an `information_schema` database under each Catalog, containing
metadata only for the corresponding Catalog's databases and tables.
+
+All tables in the `information_schema` database are read-only, and users
cannot modify, drop, or create tables in this database.
+
+By default, all users have read permissions for all tables in this database,
but the query results will vary based on the user's actual permission. For
example, if User A only has permissions for `db1.table1`, querying the
`information_schema.tables` table will only return information related to
`db1.table1`.
+
+### mysql
+
+All tables under the `mysql` database are virtual tables and do not have
physical entities. These system tables contain information such as permissions
and are mainly used for MySQL ecosystem compatibility.
+
+There is a `mysql` database under each Catalog, but the content of tables is
identical.
+
+All tables in the `mysql` database are read-only, and users cannot modify,
delete, or create tables in this database.
+
+### __internal_schema
+
+All tables under the `__internal_schema` database are actual tables in Doris,
stored similarly to user-created data tables. When a Doris cluster is created,
all system tables under this database are automatically created.
+
+By default, common users have read-only permissions for tables in this
database. However, once granted, they can modify, delete, or create tables
under this database.
diff --git a/versioned_docs/version-3.0/admin-manual/audit-plugin.md
b/versioned_docs/version-3.0/admin-manual/audit-plugin.md
index 42e4fe67da6..e766379e2f2 100644
--- a/versioned_docs/version-3.0/admin-manual/audit-plugin.md
+++ b/versioned_docs/version-3.0/admin-manual/audit-plugin.md
@@ -53,6 +53,14 @@ The audit log plugin can be turned off at any time:
After disable, Doris will stop writing to the `audit_log` table. Audit logs
that have been written will not change.
+### Audit log table
+
+With the upgrade of Doris version, the fields of the audit log table will also
increase. For details, please refer to
[audit_log](./system-tables/internal_schema/audit_log.md)
+
+Starting from version 2.1.8 and 3.0.3, the `audit_log` system table will
automatically add new fields of `audit_log` table as the Doris version is
upgraded.
+
+In previous versions, users need to manually add fields to the `audit_log`
system table through the `ALTER TABLE` command.
+
### Related configuration
The audit log table is a dynamic partitioned table, partitioned by day, and
retains the data of the last 30 days by default.
diff --git
a/versioned_docs/version-3.0/admin-manual/system-tables/internal_schema/audit_log.md
b/versioned_docs/version-3.0/admin-manual/system-tables/internal_schema/audit_log.md
index 4d77bb2796e..47428a19e76 100644
---
a/versioned_docs/version-3.0/admin-manual/system-tables/internal_schema/audit_log.md
+++
b/versioned_docs/version-3.0/admin-manual/system-tables/internal_schema/audit_log.md
@@ -39,7 +39,7 @@ Store audit logs
| Column Name | Type | Description
|
| ----------------- | ------------ |
------------------------------------------------------------ |
| query_id | varchar(48) | ID of the Query
|
-| time | datetime(3) | Time when the query was executed
|
+| time | datetime(3) | Time when the query was executed(in
milliseconds) |
| client_ip | varchar(128) | IP address of the client sending the
query |
| user | varchar(128) | User
|
| catalog | varchar(128) | Current Catalog during statement
execution |
@@ -51,12 +51,28 @@ Store audit logs
| scan_bytes | bigint | Amount of data scanned
|
| scan_rows | bigint | Number of rows scanned
|
| return_rows | bigint | Number of rows returned
|
+| shuffleSendRows | bigint | The number of rows transferred
between nodes during statement execution. Supported since version 3.0. |
+| shuffleSendBytes | bigint | The amount of data transferred
between nodes during statement execution. Supported since version 3.0. |
+| scanBytesFromLocalStorage | bigint | The amount of data read from the
local disk. Supported since version 3.0. |
+| scanBytesFromRemoteStorage | bigint | The amount of data read from the
remote storage. Supported since version 3.0. |
| stmt_id | bigint | Statement ID
|
+| stmt_type | string | Statement type. Supported since
version 3.0. |
| is_query | tinyint | Whether it is a query
|
+| is_nereids | booean | Is using Nereids Optimizer. |
| frontend_ip | varchar(128) | IP address of the connected Frontend
|
| cpu_time_ms | bigint | Cumulative CPU time (in milliseconds)
consumed by the Backend for statement execution |
| sql_hash | varchar(128) | Hash value of the statement
|
| sql_digest | varchar(128) | Digest (signature) of the statement
|
| peak_memory_bytes | bigint | Peak memory usage of the Backend during
statement execution |
| workload_group | text | Workload Group used for statement
execution |
-| stmt | text | Statement text
|
\ No newline at end of file
+| compute_group | string | In storage and computation
decouped mode, the compute group used by the execution statement. Supported
since version 3.0.|
+| trace_id | string | Trace ID set when executing the
statement |
+| stmt | text | Statement text
|
+
+
+## Description
+
+- `client_ip`: If a proxy service is used and the IP pass-through is not
enabled, the proxy service IP may be recorded here instead of the real client
IP.
+- `state`: `EOF` indicates that the query is executed successfully. `OK`
indicates that the DDL and DML statements are executed successfully. `ERR`
indicates that the statement execution fails.
+
+
diff --git a/versioned_docs/version-3.0/admin-manual/system-tables/overview.md
b/versioned_docs/version-3.0/admin-manual/system-tables/overview.md
index e2a19e33b31..76a5fe96687 100644
--- a/versioned_docs/version-3.0/admin-manual/system-tables/overview.md
+++ b/versioned_docs/version-3.0/admin-manual/system-tables/overview.md
@@ -1,7 +1,7 @@
---
{
"title": "Overview",
- "language": "en"
+ "language": "zh-CN"
}
---
@@ -24,4 +24,28 @@ specific language governing permissions and limitations
under the License.
-->
-The information_schema database in Doris is a special virtual database that
contains metadata about the Doris cluster and all its database objects. These
objects include databases, tables, columns, privileges, and more. Within the
information_schema database, there are multiple read-only tables, which are
actually views rather than real tables. Therefore, only SELECT operations can
be performed on these tables, and data modification operations such as INSERT,
UPDATE, DELETE, etc., are no [...]
\ No newline at end of file
+Apache Doris cluster has multiple built-in system databases to store metadata
information about the Doris system itself.
+
+### information_schema
+
+All tables under the `information_schema` database are virtual tables and do
not have physical entities. These system tables contain metadata about the
Doris cluster and all its database objects, including databases, tables,
columns, permissions, etc. They also include functional status information like
Workload Group, Task, etc.
+
+There is an `information_schema` database under each Catalog, containing
metadata only for the corresponding Catalog's databases and tables.
+
+All tables in the `information_schema` database are read-only, and users
cannot modify, drop, or create tables in this database.
+
+By default, all users have read permissions for all tables in this database,
but the query results will vary based on the user's actual permission. For
example, if User A only has permissions for `db1.table1`, querying the
`information_schema.tables` table will only return information related to
`db1.table1`.
+
+### mysql
+
+All tables under the `mysql` database are virtual tables and do not have
physical entities. These system tables contain information such as permissions
and are mainly used for MySQL ecosystem compatibility.
+
+There is a `mysql` database under each Catalog, but the content of tables is
identical.
+
+All tables in the `mysql` database are read-only, and users cannot modify,
delete, or create tables in this database.
+
+### __internal_schema
+
+All tables under the `__internal_schema` database are actual tables in Doris,
stored similarly to user-created data tables. When a Doris cluster is created,
all system tables under this database are automatically created.
+
+By default, common users have read-only permissions for tables in this
database. However, once granted, they can modify, delete, or create tables
under this database.
diff --git a/versioned_sidebars/version-2.1-sidebars.json
b/versioned_sidebars/version-2.1-sidebars.json
index 353132ddb68..100188d8755 100644
--- a/versioned_sidebars/version-2.1-sidebars.json
+++ b/versioned_sidebars/version-2.1-sidebars.json
@@ -447,7 +447,7 @@
"admin-manual/system-tables/overview",
{
"type": "category",
- "label": "Database: information_schema",
+ "label": "information_schema",
"items": [
"admin-manual/system-tables/information_schema/active_queries",
"admin-manual/system-tables/information_schema/backend_active_tasks",
@@ -490,7 +490,7 @@
},
{
"type": "category",
- "label": "Database: MySQL",
+ "label": "mysql",
"items": [
"admin-manual/system-tables/mysql/props_priv",
"admin-manual/system-tables/mysql/user"
@@ -498,7 +498,7 @@
},
{
"type": "category",
- "label": "Database: __internal_schema",
+ "label": "__internal_schema",
"items": [
"admin-manual/system-tables/internal_schema/audit_log",
"admin-manual/system-tables/internal_schema/column_statistics",
@@ -1742,4 +1742,4 @@
]
}
]
-}
\ No newline at end of file
+}
diff --git a/versioned_sidebars/version-3.0-sidebars.json
b/versioned_sidebars/version-3.0-sidebars.json
index 0149c956c78..fc9fff17a73 100644
--- a/versioned_sidebars/version-3.0-sidebars.json
+++ b/versioned_sidebars/version-3.0-sidebars.json
@@ -483,7 +483,7 @@
"admin-manual/system-tables/overview",
{
"type": "category",
- "label": "Database: information_schema",
+ "label": "information_schema",
"items": [
"admin-manual/system-tables/information_schema/active_queries",
"admin-manual/system-tables/information_schema/backend_active_tasks",
@@ -526,7 +526,7 @@
},
{
"type": "category",
- "label": "Database: MySQL",
+ "label": "mysql",
"items": [
"admin-manual/system-tables/mysql/props_priv",
"admin-manual/system-tables/mysql/user"
@@ -534,7 +534,7 @@
},
{
"type": "category",
- "label": "Database: __internal_schema",
+ "label": "__internal_schema",
"items": [
"admin-manual/system-tables/internal_schema/audit_log",
"admin-manual/system-tables/internal_schema/column_statistics",
@@ -1790,4 +1790,4 @@
]
}
]
-}
\ No newline at end of file
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
