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 a80a2877760 modify log managment and iceberg doc (#1062)
a80a2877760 is described below
commit a80a2877760821997d370a0a191515bc62f810eb
Author: Mingyu Chen <[email protected]>
AuthorDate: Wed Aug 28 21:49:20 2024 +0800
modify log managment and iceberg doc (#1062)
---
docs/admin-manual/log-management/fe-log.md | 20 ++++++++++++--------
docs/lakehouse/datalake-building/iceberg-build.md | 5 ++---
.../current/admin-manual/log-management/fe-log.md | 12 ++++++++----
.../lakehouse/datalake-building/iceberg-build.md | 4 +---
.../admin-manual/log-management/fe-log.md | 12 ++++++++++--
.../lakehouse/datalake-building/iceberg-build.md | 8 +++++---
.../admin-manual/log-management/fe-log.md | 12 ++++++++----
.../lakehouse/datalake-building/iceberg-build.md | 8 +++++---
.../admin-manual/log-management/fe-log.md | 19 ++++++++++++++-----
.../lakehouse/datalake-building/iceberg-build.md | 5 ++---
.../admin-manual/log-management/fe-log.md | 20 ++++++++++++--------
.../lakehouse/datalake-building/iceberg-build.md | 5 ++---
12 files changed, 81 insertions(+), 49 deletions(-)
diff --git a/docs/admin-manual/log-management/fe-log.md
b/docs/admin-manual/log-management/fe-log.md
index 943de526503..ed5c341974b 100644
--- a/docs/admin-manual/log-management/fe-log.md
+++ b/docs/admin-manual/log-management/fe-log.md
@@ -62,7 +62,7 @@ The following configuration items are configured in the
`fe.conf` file.
| --- | --- | --- | --- |
| `LOG_DIR` | `ENV(DORIS_HOME)/log` | | Storage path for all logs. By
default, it is the `log/` directory under the FE deployment path. Note that
this is an environment variable, and the configuration name should be in
uppercase. |
| `sys_log_level` | `INFO` | `INFO`, `WARN`, `ERROR`, `FATAL` | Log level of
`fe.log`. Default is INFO. Not recommended to change, as INFO level contains
many critical log information. |
-| `sys_log_roll_num` | 10 | | Controls the maximum number of files for
`fe.log` and `fe.warn.log`. Default is 10. When the number of log files exceeds
this threshold due to log rolling or splitting, older log files will be
deleted. |
+| `sys_log_roll_num` | 10 | | Controls the maximum number of files for
`fe.log` and `fe.warn.log` in one day. Default is 10. When the number of log
files exceeds this threshold due to log rolling or splitting, older log files
will be deleted. |
| `sys_log_verbose_modules` | | | Can set specific Java package files to
enable DEBUG level logging. See the "Enable DEBUG Log" section for details. |
| `sys_log_enable_compress` | false | true, false | Whether to enable
compression for historical `fe.log` and `fe.warn.log` logs. Default is off.
When enabled, historical audit logs will be archived using gzip compression. |
| `log_rollover_strategy` | `age` | `age`, `size` | Log retention strategy,
default is `age`, which retains historical logs based on time. `size` retains
historical logs based on log size. |
@@ -81,10 +81,14 @@ The following configuration items are configured in the
`fe.conf` file.
| `audit_log_enable_compress` | false | true, false | Whether to enable
compression for historical `fe.audit.log` logs. Default is off. When enabled,
historical audit logs will be archived using gzip compression. |
| `sys_log_mode` | `NORMAL` | `NORMAL`, `BRIEF`, `ASYNC` | FE log output mode,
where `NORMAL` is the default output mode, log output is synchronous and
includes location information. `ASYNC` is the default log output is
asynchronous and includes location information. `BRIEF` mode is log output
asynchronously but does not include location information. The performance of
the three log output modes increases in sequence. |
-> Note
->
-> Starting from version 3.0.2, the default value of `sys_log_mode`
configuration is changed to `AYSNC`.
+::: note
+Starting from version 3.0.2, the default value of `sys_log_mode` configuration
is changed to `AYSNC`.
+:::
+:::tip
+`sys_log_roll_num` 控制的是一天的保留日志数量，而不是总数量，需要配合 `sys_log_delete_age` 共同确定总保留日志数量。
+`sys_log_roll_num` controls the number of retained logs per day, not the total
number. It needs to be combined with `sys_log_delete_age` to determine the
total number of retained logs.
+:::
## Enable DEBUG Log
@@ -95,13 +99,13 @@ The Debug level log of FE can be enabled by modifying the
configuration file or
Add the configuration item `sys_log_verbose_modules` in fe.conf. For
example:
```text
- # 仅开启类 org.apache.doris.catalog.Catalog 的 Debug 日志
+ # Only open DEBUG log for "org.apache.doris.catalog.Catalog"
sys_log_verbose_modules=org.apache.doris.catalog.Catalog
- # 开启包 org.apache.doris.catalog 下所有类的 Debug 日志
+ # Open DEBUG log for all classes in "org.apache.doris.catalog"
sys_log_verbose_modules=org.apache.doris.catalog
- # 开启包 org 下所有类的 Debug 日志
+ # Open DEBUG log for all classes in "org"
sys_log_verbose_modules=org
```
@@ -156,7 +160,7 @@ The Debug level log of FE can be enabled by modifying the
configuration file or
The `del_verbose` parameter specifies the package name or class name for
closing Debug log.
-## Container Environment Log Configuration
+## Log Configuration for k8s
In some cases, the FE process is deployed through a container environment
(such as k8s). All logs need to be output through standard output stream
instead of files.
diff --git a/docs/lakehouse/datalake-building/iceberg-build.md
b/docs/lakehouse/datalake-building/iceberg-build.md
index bdba7ff0ee2..5f850c9eb07 100644
--- a/docs/lakehouse/datalake-building/iceberg-build.md
+++ b/docs/lakehouse/datalake-building/iceberg-build.md
@@ -36,9 +36,8 @@ This is an experimental feature.
Before using, please set:
<br />
set global enable_nereids_planner = true;
-set global enable_fallback_to_original_planner = false;
<br />
-For clusters upgraded from older versions, these parameters may have changed.
+set global enable_fallback_to_original_planner = false;
:::
## Metadata Creation and Deletion
@@ -60,7 +59,7 @@ For clusters upgraded from older versions, these parameters
may have changed.
The above mainly demonstrates how to create an HMS Iceberg Catalog in
Apache Doris. Apache Doris currently supports multiple types of Iceberg
Catalogs. For more configurations, please refer to [Iceberg
Catalog](../datalake-analytics/iceberg.md).
- Note that if you need to create Iceberg tables or write data through HMS
Catalog in Apache Doris, you need to explicitly add the `fs.defaultFS` property
and `warehouse` property in the Catalog attributes. If the Catalog is created
only for querying, these two parameters can be omitted.
+ Note that if you need to create Iceberg tables or write data through Hive
Catalog in Apache Doris, you need to explicitly add the `fs.defaultFS` property
and `warehouse` property in the Catalog attributes. If the Catalog is created
only for querying, these two parameters can be omitted.
- Deletion
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/log-management/fe-log.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/log-management/fe-log.md
index d98408aba7d..b750fe65828 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/log-management/fe-log.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/log-management/fe-log.md
@@ -62,7 +62,7 @@ under the License.
| --- | --- | --- | --- |
| `LOG_DIR` | `ENV(DORIS_HOME)/log` | | 所有日志的存放路径。默认为 FE 部署路径的 `log/`
目录下。注意这是一个环境变量，配置名需大写。 |
| `sys_log_level` | `INFO` | `INFO`, `WARN`, `ERROR`, `FATAL` | `fe.log`
的日志等级。默认为 INFO。不建议修改，INFO 等级包含许多关键日志信息。|
-| `sys_log_roll_num` | 10 | | 控制 `fe.log` 和 `fe.warn.log` 最大文件数量。默认
10。当因为日志滚动或切分后，日志文件数量大于这个阈值后，老的日志文件将被删除 |
+| `sys_log_roll_num` | 10 | | 控制 `fe.log` 和 `fe.warn.log` 一天内的最大文件数量。默认
10。当因为日志滚动或切分后，日志文件数量大于这个阈值后，老的日志文件将被删除 |
|`sys_log_verbose_modules`| | | 可以设置指定的 Java package 下的文件开启 DEBUG 级别日志。请参阅 "开启
DEBUG 日志" 章节 |
| `sys_log_enable_compress` | false | true, false | 是否开启历史 `fe.log` 和
`fe.warn.log` 日志压缩。默认关闭。开启后，历史审计日志会使用 gzip 压缩归档 |
| `log_rollover_strategy` | `age` | `age`, `size` | 日志保留策略，默认为
`age`，即根据时间策略保留历史日志。`size` 为按日志大小保留历史日志 |
@@ -81,9 +81,13 @@ under the License.
| `audit_log_enable_compress` | false | true, false | 是否开启历史 `fe.audit.log`
日志压缩。默认关闭。开启后，历史审计日志会使用 gzip 压缩归档 |
| `sys_log_mode` | `NORMAL` | `NORMAL`, `BRIEF`, `ASYNC` | FE 日志的输出模式，其中
`NORMAL` 为默认的输出模式，日志同步输出且包含位置信息。`ASYNC` 默认是日志异步输出且包含位置信息。 `BRIEF`
模式是日志异步输出但不包含位置信息。三种日志输出模式的性能依次递增 |
-> 注：
->
-> 1. 从 3.0.2 版本开始，`sys_log_mode` 配置默认改为 `AYSNC`。
+::: note
+从 3.0.2 版本开始，`sys_log_mode` 配置默认改为 `AYSNC`。
+:::
+
+:::tip
+`sys_log_roll_num` 控制的是一天的保留日志数量，而不是总数量，需要配合 `sys_log_delete_age` 共同确定总保留日志数量。
+:::
## 开启 DEBUG 日志
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/datalake-building/iceberg-build.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/datalake-building/iceberg-build.md
index 79a352575f1..5cc038a97a8 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/datalake-building/iceberg-build.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/datalake-building/iceberg-build.md
@@ -38,8 +38,6 @@ under the License.
set global enable_nereids_planner = true;
<br />
set global enable_fallback_to_original_planner = false;
-<br />
-从老版本升级上来的集群，这些参数可能有变化。
:::
## 元数据创建与删除
@@ -63,7 +61,7 @@ set global enable_fallback_to_original_planner = false;
注意：
- - 如果需要通过 Apache Doris 通过 HMS Catalog 创建 Iceberg 表或写入数据，需要在 Catalog 属性中显式增加
`fs.defaultFS` 属性以及 `warehouse` 属性。如果创建 Catalog 仅用于查询，则这两个参数可以省略。
+ - 如果需要通过 Apache Doris 的 Hive Catalog 创建 Iceberg 表或写入数据，需要在 Catalog 属性中显式增加
`fs.defaultFS` 属性以及 `warehouse` 属性。如果创建 Catalog 仅用于查询，则这两个参数可以省略。
- Hive Catalog 可以查询 Iceberg 表，但是不能在 Hive Catalog 中创建 Iceberg 表。
- 删除
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/log-management/fe-log.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/log-management/fe-log.md
index f3302e9e7c2..b750fe65828 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/log-management/fe-log.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/admin-manual/log-management/fe-log.md
@@ -62,7 +62,7 @@ under the License.
| --- | --- | --- | --- |
| `LOG_DIR` | `ENV(DORIS_HOME)/log` | | 所有日志的存放路径。默认为 FE 部署路径的 `log/`
目录下。注意这是一个环境变量，配置名需大写。 |
| `sys_log_level` | `INFO` | `INFO`, `WARN`, `ERROR`, `FATAL` | `fe.log`
的日志等级。默认为 INFO。不建议修改，INFO 等级包含许多关键日志信息。|
-| `sys_log_roll_num` | 10 | | 控制 `fe.log` 和 `fe.warn.log` 最大文件数量。默认
10。当因为日志滚动或切分后，日志文件数量大于这个阈值后，老的日志文件将被删除 |
+| `sys_log_roll_num` | 10 | | 控制 `fe.log` 和 `fe.warn.log` 一天内的最大文件数量。默认
10。当因为日志滚动或切分后，日志文件数量大于这个阈值后，老的日志文件将被删除 |
|`sys_log_verbose_modules`| | | 可以设置指定的 Java package 下的文件开启 DEBUG 级别日志。请参阅 "开启
DEBUG 日志" 章节 |
| `sys_log_enable_compress` | false | true, false | 是否开启历史 `fe.log` 和
`fe.warn.log` 日志压缩。默认关闭。开启后，历史审计日志会使用 gzip 压缩归档 |
| `log_rollover_strategy` | `age` | `age`, `size` | 日志保留策略，默认为
`age`，即根据时间策略保留历史日志。`size` 为按日志大小保留历史日志 |
@@ -79,7 +79,15 @@ under the License.
| `audit_log_modules` | `{"slow_query", "query", "load", "stream_load"}` | |
`fe.audit.log` 中的模块类型。默认包括慢查询、查询、导入、stream load。其中“查询”只所有 DDL、DML、SQL
操作。“慢查询”指这些操作执行时间超过 `qe_slow_log_ms` 阈值的操作。“导入”指 Broker Load。“stream load”指
stream load 操作。 |
| `qe_slow_log_ms` | 5000 | | 当 DDL、DML、SQL 语句的执行时间超过这个阈值后，会在 `fe.audit.log`
的 `slow_query` 模块中单独记录。默认 5000 ms |
| `audit_log_enable_compress` | false | true, false | 是否开启历史 `fe.audit.log`
日志压缩。默认关闭。开启后，历史审计日志会使用 gzip 压缩归档 |
-| `sys_log_mode` | `NORMAL` | `NORMAL`, `BRIEF`, `ASYNC` | FE 日志的输出模式，其中
`NORMAL` 为默认的输出模式，日志同步输出且包含位置信息。`ASYNC` 默认是日志异步输出且包含位置信息。 `BRIEF`
模式是日志异步输出但不包含位置信息。三种日志输出模式的性能依次递增。|
+| `sys_log_mode` | `NORMAL` | `NORMAL`, `BRIEF`, `ASYNC` | FE 日志的输出模式，其中
`NORMAL` 为默认的输出模式，日志同步输出且包含位置信息。`ASYNC` 默认是日志异步输出且包含位置信息。 `BRIEF`
模式是日志异步输出但不包含位置信息。三种日志输出模式的性能依次递增 |
+
+::: note
+从 3.0.2 版本开始，`sys_log_mode` 配置默认改为 `AYSNC`。
+:::
+
+:::tip
+`sys_log_roll_num` 控制的是一天的保留日志数量，而不是总数量，需要配合 `sys_log_delete_age` 共同确定总保留日志数量。
+:::
## 开启 DEBUG 日志
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/datalake-building/iceberg-build.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/datalake-building/iceberg-build.md
index a35acff5e5f..5cc038a97a8 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/datalake-building/iceberg-build.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/datalake-building/iceberg-build.md
@@ -36,9 +36,8 @@ under the License.
使用前，请先设置：
<br />
set global enable_nereids_planner = true;
-set global enable_fallback_to_original_planner = false;
<br />
-从老版本升级上来的集群，这些参数可能有变化。
+set global enable_fallback_to_original_planner = false;
:::
## 元数据创建与删除
@@ -60,7 +59,10 @@ set global enable_fallback_to_original_planner = false;
上面主要演示了如何在 Apache Doris 中创建 HMS Iceberg Catalog。Apache Doris 目前支持多种类型的
Iceberg Catalog。更多配置，请参阅 [Iceberg Catalog](../datalake-analytics/iceberg.md)
- 注意，如果需要通过 Apache Doris 通过 HMS Catalog 创建 Iceberg 表或写入数据，需要在 Catalog
属性中显式增加 `fs.defaultFS` 属性以及 `warehouse` 属性。如果创建 Catalog 仅用于查询，则这两个参数可以省略。
+ 注意：
+
+ - 如果需要通过 Apache Doris 的 Hive Catalog 创建 Iceberg 表或写入数据，需要在 Catalog 属性中显式增加
`fs.defaultFS` 属性以及 `warehouse` 属性。如果创建 Catalog 仅用于查询，则这两个参数可以省略。
+ - Hive Catalog 可以查询 Iceberg 表，但是不能在 Hive Catalog 中创建 Iceberg 表。
- 删除
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/log-management/fe-log.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/log-management/fe-log.md
index d98408aba7d..b750fe65828 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/log-management/fe-log.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/admin-manual/log-management/fe-log.md
@@ -62,7 +62,7 @@ under the License.
| --- | --- | --- | --- |
| `LOG_DIR` | `ENV(DORIS_HOME)/log` | | 所有日志的存放路径。默认为 FE 部署路径的 `log/`
目录下。注意这是一个环境变量，配置名需大写。 |
| `sys_log_level` | `INFO` | `INFO`, `WARN`, `ERROR`, `FATAL` | `fe.log`
的日志等级。默认为 INFO。不建议修改，INFO 等级包含许多关键日志信息。|
-| `sys_log_roll_num` | 10 | | 控制 `fe.log` 和 `fe.warn.log` 最大文件数量。默认
10。当因为日志滚动或切分后，日志文件数量大于这个阈值后，老的日志文件将被删除 |
+| `sys_log_roll_num` | 10 | | 控制 `fe.log` 和 `fe.warn.log` 一天内的最大文件数量。默认
10。当因为日志滚动或切分后，日志文件数量大于这个阈值后，老的日志文件将被删除 |
|`sys_log_verbose_modules`| | | 可以设置指定的 Java package 下的文件开启 DEBUG 级别日志。请参阅 "开启
DEBUG 日志" 章节 |
| `sys_log_enable_compress` | false | true, false | 是否开启历史 `fe.log` 和
`fe.warn.log` 日志压缩。默认关闭。开启后，历史审计日志会使用 gzip 压缩归档 |
| `log_rollover_strategy` | `age` | `age`, `size` | 日志保留策略，默认为
`age`，即根据时间策略保留历史日志。`size` 为按日志大小保留历史日志 |
@@ -81,9 +81,13 @@ under the License.
| `audit_log_enable_compress` | false | true, false | 是否开启历史 `fe.audit.log`
日志压缩。默认关闭。开启后，历史审计日志会使用 gzip 压缩归档 |
| `sys_log_mode` | `NORMAL` | `NORMAL`, `BRIEF`, `ASYNC` | FE 日志的输出模式，其中
`NORMAL` 为默认的输出模式，日志同步输出且包含位置信息。`ASYNC` 默认是日志异步输出且包含位置信息。 `BRIEF`
模式是日志异步输出但不包含位置信息。三种日志输出模式的性能依次递增 |
-> 注：
->
-> 1. 从 3.0.2 版本开始，`sys_log_mode` 配置默认改为 `AYSNC`。
+::: note
+从 3.0.2 版本开始，`sys_log_mode` 配置默认改为 `AYSNC`。
+:::
+
+:::tip
+`sys_log_roll_num` 控制的是一天的保留日志数量，而不是总数量，需要配合 `sys_log_delete_age` 共同确定总保留日志数量。
+:::
## 开启 DEBUG 日志
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/datalake-building/iceberg-build.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/datalake-building/iceberg-build.md
index a35acff5e5f..5cc038a97a8 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/datalake-building/iceberg-build.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/datalake-building/iceberg-build.md
@@ -36,9 +36,8 @@ under the License.
使用前，请先设置：
<br />
set global enable_nereids_planner = true;
-set global enable_fallback_to_original_planner = false;
<br />
-从老版本升级上来的集群，这些参数可能有变化。
+set global enable_fallback_to_original_planner = false;
:::
## 元数据创建与删除
@@ -60,7 +59,10 @@ set global enable_fallback_to_original_planner = false;
上面主要演示了如何在 Apache Doris 中创建 HMS Iceberg Catalog。Apache Doris 目前支持多种类型的
Iceberg Catalog。更多配置，请参阅 [Iceberg Catalog](../datalake-analytics/iceberg.md)
- 注意，如果需要通过 Apache Doris 通过 HMS Catalog 创建 Iceberg 表或写入数据，需要在 Catalog
属性中显式增加 `fs.defaultFS` 属性以及 `warehouse` 属性。如果创建 Catalog 仅用于查询，则这两个参数可以省略。
+ 注意：
+
+ - 如果需要通过 Apache Doris 的 Hive Catalog 创建 Iceberg 表或写入数据，需要在 Catalog 属性中显式增加
`fs.defaultFS` 属性以及 `warehouse` 属性。如果创建 Catalog 仅用于查询，则这两个参数可以省略。
+ - Hive Catalog 可以查询 Iceberg 表，但是不能在 Hive Catalog 中创建 Iceberg 表。
- 删除
diff --git a/versioned_docs/version-2.1/admin-manual/log-management/fe-log.md
b/versioned_docs/version-2.1/admin-manual/log-management/fe-log.md
index 8671e7cfbc9..ed5c341974b 100644
--- a/versioned_docs/version-2.1/admin-manual/log-management/fe-log.md
+++ b/versioned_docs/version-2.1/admin-manual/log-management/fe-log.md
@@ -62,7 +62,7 @@ The following configuration items are configured in the
`fe.conf` file.
| --- | --- | --- | --- |
| `LOG_DIR` | `ENV(DORIS_HOME)/log` | | Storage path for all logs. By
default, it is the `log/` directory under the FE deployment path. Note that
this is an environment variable, and the configuration name should be in
uppercase. |
| `sys_log_level` | `INFO` | `INFO`, `WARN`, `ERROR`, `FATAL` | Log level of
`fe.log`. Default is INFO. Not recommended to change, as INFO level contains
many critical log information. |
-| `sys_log_roll_num` | 10 | | Controls the maximum number of files for
`fe.log` and `fe.warn.log`. Default is 10. When the number of log files exceeds
this threshold due to log rolling or splitting, older log files will be
deleted. |
+| `sys_log_roll_num` | 10 | | Controls the maximum number of files for
`fe.log` and `fe.warn.log` in one day. Default is 10. When the number of log
files exceeds this threshold due to log rolling or splitting, older log files
will be deleted. |
| `sys_log_verbose_modules` | | | Can set specific Java package files to
enable DEBUG level logging. See the "Enable DEBUG Log" section for details. |
| `sys_log_enable_compress` | false | true, false | Whether to enable
compression for historical `fe.log` and `fe.warn.log` logs. Default is off.
When enabled, historical audit logs will be archived using gzip compression. |
| `log_rollover_strategy` | `age` | `age`, `size` | Log retention strategy,
default is `age`, which retains historical logs based on time. `size` retains
historical logs based on log size. |
@@ -81,6 +81,15 @@ The following configuration items are configured in the
`fe.conf` file.
| `audit_log_enable_compress` | false | true, false | Whether to enable
compression for historical `fe.audit.log` logs. Default is off. When enabled,
historical audit logs will be archived using gzip compression. |
| `sys_log_mode` | `NORMAL` | `NORMAL`, `BRIEF`, `ASYNC` | FE log output mode,
where `NORMAL` is the default output mode, log output is synchronous and
includes location information. `ASYNC` is the default log output is
asynchronous and includes location information. `BRIEF` mode is log output
asynchronously but does not include location information. The performance of
the three log output modes increases in sequence. |
+::: note
+Starting from version 3.0.2, the default value of `sys_log_mode` configuration
is changed to `AYSNC`.
+:::
+
+:::tip
+`sys_log_roll_num` 控制的是一天的保留日志数量，而不是总数量，需要配合 `sys_log_delete_age` 共同确定总保留日志数量。
+`sys_log_roll_num` controls the number of retained logs per day, not the total
number. It needs to be combined with `sys_log_delete_age` to determine the
total number of retained logs.
+:::
+
## Enable DEBUG Log
The Debug level log of FE can be enabled by modifying the configuration file
or through the interface or API during runtime.
@@ -90,13 +99,13 @@ The Debug level log of FE can be enabled by modifying the
configuration file or
Add the configuration item `sys_log_verbose_modules` in fe.conf. For
example:
```text
- # 仅开启类 org.apache.doris.catalog.Catalog 的 Debug 日志
+ # Only open DEBUG log for "org.apache.doris.catalog.Catalog"
sys_log_verbose_modules=org.apache.doris.catalog.Catalog
- # 开启包 org.apache.doris.catalog 下所有类的 Debug 日志
+ # Open DEBUG log for all classes in "org.apache.doris.catalog"
sys_log_verbose_modules=org.apache.doris.catalog
- # 开启包 org 下所有类的 Debug 日志
+ # Open DEBUG log for all classes in "org"
sys_log_verbose_modules=org
```
@@ -151,7 +160,7 @@ The Debug level log of FE can be enabled by modifying the
configuration file or
The `del_verbose` parameter specifies the package name or class name for
closing Debug log.
-## Container Environment Log Configuration
+## Log Configuration for k8s
In some cases, the FE process is deployed through a container environment
(such as k8s). All logs need to be output through standard output stream
instead of files.
diff --git
a/versioned_docs/version-2.1/lakehouse/datalake-building/iceberg-build.md
b/versioned_docs/version-2.1/lakehouse/datalake-building/iceberg-build.md
index bdba7ff0ee2..5f850c9eb07 100644
--- a/versioned_docs/version-2.1/lakehouse/datalake-building/iceberg-build.md
+++ b/versioned_docs/version-2.1/lakehouse/datalake-building/iceberg-build.md
@@ -36,9 +36,8 @@ This is an experimental feature.
Before using, please set:
<br />
set global enable_nereids_planner = true;
-set global enable_fallback_to_original_planner = false;
<br />
-For clusters upgraded from older versions, these parameters may have changed.
+set global enable_fallback_to_original_planner = false;
:::
## Metadata Creation and Deletion
@@ -60,7 +59,7 @@ For clusters upgraded from older versions, these parameters
may have changed.
The above mainly demonstrates how to create an HMS Iceberg Catalog in
Apache Doris. Apache Doris currently supports multiple types of Iceberg
Catalogs. For more configurations, please refer to [Iceberg
Catalog](../datalake-analytics/iceberg.md).
- Note that if you need to create Iceberg tables or write data through HMS
Catalog in Apache Doris, you need to explicitly add the `fs.defaultFS` property
and `warehouse` property in the Catalog attributes. If the Catalog is created
only for querying, these two parameters can be omitted.
+ Note that if you need to create Iceberg tables or write data through Hive
Catalog in Apache Doris, you need to explicitly add the `fs.defaultFS` property
and `warehouse` property in the Catalog attributes. If the Catalog is created
only for querying, these two parameters can be omitted.
- Deletion
diff --git a/versioned_docs/version-3.0/admin-manual/log-management/fe-log.md
b/versioned_docs/version-3.0/admin-manual/log-management/fe-log.md
index 943de526503..ed5c341974b 100644
--- a/versioned_docs/version-3.0/admin-manual/log-management/fe-log.md
+++ b/versioned_docs/version-3.0/admin-manual/log-management/fe-log.md
@@ -62,7 +62,7 @@ The following configuration items are configured in the
`fe.conf` file.
| --- | --- | --- | --- |
| `LOG_DIR` | `ENV(DORIS_HOME)/log` | | Storage path for all logs. By
default, it is the `log/` directory under the FE deployment path. Note that
this is an environment variable, and the configuration name should be in
uppercase. |
| `sys_log_level` | `INFO` | `INFO`, `WARN`, `ERROR`, `FATAL` | Log level of
`fe.log`. Default is INFO. Not recommended to change, as INFO level contains
many critical log information. |
-| `sys_log_roll_num` | 10 | | Controls the maximum number of files for
`fe.log` and `fe.warn.log`. Default is 10. When the number of log files exceeds
this threshold due to log rolling or splitting, older log files will be
deleted. |
+| `sys_log_roll_num` | 10 | | Controls the maximum number of files for
`fe.log` and `fe.warn.log` in one day. Default is 10. When the number of log
files exceeds this threshold due to log rolling or splitting, older log files
will be deleted. |
| `sys_log_verbose_modules` | | | Can set specific Java package files to
enable DEBUG level logging. See the "Enable DEBUG Log" section for details. |
| `sys_log_enable_compress` | false | true, false | Whether to enable
compression for historical `fe.log` and `fe.warn.log` logs. Default is off.
When enabled, historical audit logs will be archived using gzip compression. |
| `log_rollover_strategy` | `age` | `age`, `size` | Log retention strategy,
default is `age`, which retains historical logs based on time. `size` retains
historical logs based on log size. |
@@ -81,10 +81,14 @@ The following configuration items are configured in the
`fe.conf` file.
| `audit_log_enable_compress` | false | true, false | Whether to enable
compression for historical `fe.audit.log` logs. Default is off. When enabled,
historical audit logs will be archived using gzip compression. |
| `sys_log_mode` | `NORMAL` | `NORMAL`, `BRIEF`, `ASYNC` | FE log output mode,
where `NORMAL` is the default output mode, log output is synchronous and
includes location information. `ASYNC` is the default log output is
asynchronous and includes location information. `BRIEF` mode is log output
asynchronously but does not include location information. The performance of
the three log output modes increases in sequence. |
-> Note
->
-> Starting from version 3.0.2, the default value of `sys_log_mode`
configuration is changed to `AYSNC`.
+::: note
+Starting from version 3.0.2, the default value of `sys_log_mode` configuration
is changed to `AYSNC`.
+:::
+:::tip
+`sys_log_roll_num` 控制的是一天的保留日志数量，而不是总数量，需要配合 `sys_log_delete_age` 共同确定总保留日志数量。
+`sys_log_roll_num` controls the number of retained logs per day, not the total
number. It needs to be combined with `sys_log_delete_age` to determine the
total number of retained logs.
+:::
## Enable DEBUG Log
@@ -95,13 +99,13 @@ The Debug level log of FE can be enabled by modifying the
configuration file or
Add the configuration item `sys_log_verbose_modules` in fe.conf. For
example:
```text
- # 仅开启类 org.apache.doris.catalog.Catalog 的 Debug 日志
+ # Only open DEBUG log for "org.apache.doris.catalog.Catalog"
sys_log_verbose_modules=org.apache.doris.catalog.Catalog
- # 开启包 org.apache.doris.catalog 下所有类的 Debug 日志
+ # Open DEBUG log for all classes in "org.apache.doris.catalog"
sys_log_verbose_modules=org.apache.doris.catalog
- # 开启包 org 下所有类的 Debug 日志
+ # Open DEBUG log for all classes in "org"
sys_log_verbose_modules=org
```
@@ -156,7 +160,7 @@ The Debug level log of FE can be enabled by modifying the
configuration file or
The `del_verbose` parameter specifies the package name or class name for
closing Debug log.
-## Container Environment Log Configuration
+## Log Configuration for k8s
In some cases, the FE process is deployed through a container environment
(such as k8s). All logs need to be output through standard output stream
instead of files.
diff --git
a/versioned_docs/version-3.0/lakehouse/datalake-building/iceberg-build.md
b/versioned_docs/version-3.0/lakehouse/datalake-building/iceberg-build.md
index bdba7ff0ee2..5f850c9eb07 100644
--- a/versioned_docs/version-3.0/lakehouse/datalake-building/iceberg-build.md
+++ b/versioned_docs/version-3.0/lakehouse/datalake-building/iceberg-build.md
@@ -36,9 +36,8 @@ This is an experimental feature.
Before using, please set:
<br />
set global enable_nereids_planner = true;
-set global enable_fallback_to_original_planner = false;
<br />
-For clusters upgraded from older versions, these parameters may have changed.
+set global enable_fallback_to_original_planner = false;
:::
## Metadata Creation and Deletion
@@ -60,7 +59,7 @@ For clusters upgraded from older versions, these parameters
may have changed.
The above mainly demonstrates how to create an HMS Iceberg Catalog in
Apache Doris. Apache Doris currently supports multiple types of Iceberg
Catalogs. For more configurations, please refer to [Iceberg
Catalog](../datalake-analytics/iceberg.md).
- Note that if you need to create Iceberg tables or write data through HMS
Catalog in Apache Doris, you need to explicitly add the `fs.defaultFS` property
and `warehouse` property in the Catalog attributes. If the Catalog is created
only for querying, these two parameters can be omitted.
+ Note that if you need to create Iceberg tables or write data through Hive
Catalog in Apache Doris, you need to explicitly add the `fs.defaultFS` property
and `warehouse` property in the Catalog attributes. If the Catalog is created
only for querying, these two parameters can be omitted.
- Deletion
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
