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 579ad06b128 update file cache doc (#1054)
579ad06b128 is described below
commit 579ad06b128392c00e9b981cee7757a3312eed0b
Author: Mingyu Chen <morning...@163.com>
AuthorDate: Tue Aug 27 16:29:47 2024 +0800
update file cache doc (#1054)
---
docs/lakehouse/filecache.md | 10 +++++++++-
docs/lakehouse/metacache.md | 4 ++++
.../current/lakehouse/filecache.md | 6 ++++++
.../current/lakehouse/metacache.md | 4 ++++
.../version-2.1/lakehouse/filecache.md | 6 ++++++
.../version-2.1/lakehouse/metacache.md | 4 ++++
.../version-3.0/lakehouse/filecache.md | 6 ++++++
.../version-3.0/lakehouse/metacache.md | 4 ++++
versioned_docs/version-2.1/lakehouse/filecache.md | 10 +++++++++-
versioned_docs/version-2.1/lakehouse/metacache.md | 4 ++++
versioned_docs/version-3.0/lakehouse/filecache.md | 10 +++++++++-
versioned_docs/version-3.0/lakehouse/metacache.md | 4 ++++
12 files changed, 69 insertions(+), 3 deletions(-)
diff --git a/docs/lakehouse/filecache.md b/docs/lakehouse/filecache.md
index 1e838597997..b52c5d8b43a 100644
--- a/docs/lakehouse/filecache.md
+++ b/docs/lakehouse/filecache.md
@@ -63,7 +63,9 @@ Add settings to the BE node's configuration file
`conf/be.conf`, and restart the
| `enable_file_cache_query_limit` | No | Whether to limit the cache size used
by a single query, default false |
| `clear_file_cache` | No | Whether to delete the previous cache data when the
BE restarts, default false |
-## Check whether a query hits cache
+## Cache Observability
+
+### Check whether a query hits cache
Execute `set enable_profile = true` to enable the session variable, and you
can view the query profile in the Queris tab of FE's web page. The metrics
related to Data cache are as follows:
@@ -91,3 +93,9 @@ Execute `set enable_profile = true` to enable the session
variable, and you can
If `BytesScannedFromRemote` is 0, it means all caches are hit.
+### Metrics
+
+User can query system table
[file_cache_statistics](../admin-manual/system-tables/file_cache_statistics.md)
to view the cache stats of each Backends.
+
+
+
diff --git a/docs/lakehouse/metacache.md b/docs/lakehouse/metacache.md
index 190e2d0ce27..67ddc9e1509 100644
--- a/docs/lakehouse/metacache.md
+++ b/docs/lakehouse/metacache.md
@@ -336,5 +336,9 @@ However, this may increase the access pressure on external
data sources (such as
In version 2.1.5, the `use_meta_cache` attribute was added to the Catalog
properties, defaulting to false.
+:::warning
+Do not set `use_meta_cache` to true before 2.1.6.
+:::
+
In version 2.1.6, for newly created Catalogs, this attribute is default
changed to true to correspond to the caching behavior described in this
document. It is recommended that users upgrade to version 2.1.6 and rebuild
existing Catalogs to align the default behavior with the description in this
document.
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/filecache.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/filecache.md
index a1ebe17b719..09fda30a434 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/filecache.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/filecache.md
@@ -64,6 +64,8 @@ SET GLOBAL enable_file_cache = true;
| `enable_file_cache_query_limit` | 否 | 是否限制单个 query 使用的缓存大小，默认 false |
| `clear_file_cache` | 否 | BE 重启时是否删除之前的缓存数据，默认 false |
+## 缓存可观测性
+
### 查看 Data Cache 命中情况
执行 `set enable_profile=true` 打开会话变量，可以在 FE 的 web 页面的 Queris 标签中查看到作业的
Profile。Data Cache 相关的指标如下:
@@ -92,3 +94,7 @@ SET GLOBAL enable_file_cache = true;
如果 `BytesScannedFromRemote` 为 0，表示全部命中缓存。
+### 监控指标
+
+用户可以通过系统表
[file_cache_statistics](../admin-manual/system-tables/file_cache_statistics.md)
查看各个 Backend 节点的缓存统计指标。
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metacache.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metacache.md
index c2b36f8d559..20ca9d57766 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metacache.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metacache.md
@@ -336,6 +336,10 @@ max_external_file_cache_num=0 // 关闭文件列表缓存
在 2.1.5 版本中，Catalog 属性中增加了 `use_meta_cache` 属性，默认为 false。
+:::warning
+不要在 2.1.6 之前的版本中将 `use_meta_cache` 设置为 true。
+:::
+
2.1.6 版本中，新建的 Catalog，该属性默认修改为 true，以对应本文档描述的缓存行为。建议用户升级到 2.1.6 版本后，重建已有的
Catalog，以便让默认行为和本文档描述一致。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/filecache.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/filecache.md
index a1ebe17b719..09fda30a434 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/filecache.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/filecache.md
@@ -64,6 +64,8 @@ SET GLOBAL enable_file_cache = true;
| `enable_file_cache_query_limit` | 否 | 是否限制单个 query 使用的缓存大小，默认 false |
| `clear_file_cache` | 否 | BE 重启时是否删除之前的缓存数据，默认 false |
+## 缓存可观测性
+
### 查看 Data Cache 命中情况
执行 `set enable_profile=true` 打开会话变量，可以在 FE 的 web 页面的 Queris 标签中查看到作业的
Profile。Data Cache 相关的指标如下:
@@ -92,3 +94,7 @@ SET GLOBAL enable_file_cache = true;
如果 `BytesScannedFromRemote` 为 0，表示全部命中缓存。
+### 监控指标
+
+用户可以通过系统表
[file_cache_statistics](../admin-manual/system-tables/file_cache_statistics.md)
查看各个 Backend 节点的缓存统计指标。
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/metacache.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/metacache.md
index c2b36f8d559..20ca9d57766 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/metacache.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/metacache.md
@@ -336,6 +336,10 @@ max_external_file_cache_num=0 // 关闭文件列表缓存
在 2.1.5 版本中，Catalog 属性中增加了 `use_meta_cache` 属性，默认为 false。
+:::warning
+不要在 2.1.6 之前的版本中将 `use_meta_cache` 设置为 true。
+:::
+
2.1.6 版本中，新建的 Catalog，该属性默认修改为 true，以对应本文档描述的缓存行为。建议用户升级到 2.1.6 版本后，重建已有的
Catalog，以便让默认行为和本文档描述一致。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/filecache.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/filecache.md
index a1ebe17b719..09fda30a434 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/filecache.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/filecache.md
@@ -64,6 +64,8 @@ SET GLOBAL enable_file_cache = true;
| `enable_file_cache_query_limit` | 否 | 是否限制单个 query 使用的缓存大小，默认 false |
| `clear_file_cache` | 否 | BE 重启时是否删除之前的缓存数据，默认 false |
+## 缓存可观测性
+
### 查看 Data Cache 命中情况
执行 `set enable_profile=true` 打开会话变量，可以在 FE 的 web 页面的 Queris 标签中查看到作业的
Profile。Data Cache 相关的指标如下:
@@ -92,3 +94,7 @@ SET GLOBAL enable_file_cache = true;
如果 `BytesScannedFromRemote` 为 0，表示全部命中缓存。
+### 监控指标
+
+用户可以通过系统表
[file_cache_statistics](../admin-manual/system-tables/file_cache_statistics.md)
查看各个 Backend 节点的缓存统计指标。
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/metacache.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/metacache.md
index c2b36f8d559..20ca9d57766 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/metacache.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/metacache.md
@@ -336,6 +336,10 @@ max_external_file_cache_num=0 // 关闭文件列表缓存
在 2.1.5 版本中，Catalog 属性中增加了 `use_meta_cache` 属性，默认为 false。
+:::warning
+不要在 2.1.6 之前的版本中将 `use_meta_cache` 设置为 true。
+:::
+
2.1.6 版本中，新建的 Catalog，该属性默认修改为 true，以对应本文档描述的缓存行为。建议用户升级到 2.1.6 版本后，重建已有的
Catalog，以便让默认行为和本文档描述一致。
diff --git a/versioned_docs/version-2.1/lakehouse/filecache.md
b/versioned_docs/version-2.1/lakehouse/filecache.md
index 1e838597997..b52c5d8b43a 100644
--- a/versioned_docs/version-2.1/lakehouse/filecache.md
+++ b/versioned_docs/version-2.1/lakehouse/filecache.md
@@ -63,7 +63,9 @@ Add settings to the BE node's configuration file
`conf/be.conf`, and restart the
| `enable_file_cache_query_limit` | No | Whether to limit the cache size used
by a single query, default false |
| `clear_file_cache` | No | Whether to delete the previous cache data when the
BE restarts, default false |
-## Check whether a query hits cache
+## Cache Observability
+
+### Check whether a query hits cache
Execute `set enable_profile = true` to enable the session variable, and you
can view the query profile in the Queris tab of FE's web page. The metrics
related to Data cache are as follows:
@@ -91,3 +93,9 @@ Execute `set enable_profile = true` to enable the session
variable, and you can
If `BytesScannedFromRemote` is 0, it means all caches are hit.
+### Metrics
+
+User can query system table
[file_cache_statistics](../admin-manual/system-tables/file_cache_statistics.md)
to view the cache stats of each Backends.
+
+
+
diff --git a/versioned_docs/version-2.1/lakehouse/metacache.md
b/versioned_docs/version-2.1/lakehouse/metacache.md
index 190e2d0ce27..67ddc9e1509 100644
--- a/versioned_docs/version-2.1/lakehouse/metacache.md
+++ b/versioned_docs/version-2.1/lakehouse/metacache.md
@@ -336,5 +336,9 @@ However, this may increase the access pressure on external
data sources (such as
In version 2.1.5, the `use_meta_cache` attribute was added to the Catalog
properties, defaulting to false.
+:::warning
+Do not set `use_meta_cache` to true before 2.1.6.
+:::
+
In version 2.1.6, for newly created Catalogs, this attribute is default
changed to true to correspond to the caching behavior described in this
document. It is recommended that users upgrade to version 2.1.6 and rebuild
existing Catalogs to align the default behavior with the description in this
document.
diff --git a/versioned_docs/version-3.0/lakehouse/filecache.md
b/versioned_docs/version-3.0/lakehouse/filecache.md
index 1e838597997..b52c5d8b43a 100644
--- a/versioned_docs/version-3.0/lakehouse/filecache.md
+++ b/versioned_docs/version-3.0/lakehouse/filecache.md
@@ -63,7 +63,9 @@ Add settings to the BE node's configuration file
`conf/be.conf`, and restart the
| `enable_file_cache_query_limit` | No | Whether to limit the cache size used
by a single query, default false |
| `clear_file_cache` | No | Whether to delete the previous cache data when the
BE restarts, default false |
-## Check whether a query hits cache
+## Cache Observability
+
+### Check whether a query hits cache
Execute `set enable_profile = true` to enable the session variable, and you
can view the query profile in the Queris tab of FE's web page. The metrics
related to Data cache are as follows:
@@ -91,3 +93,9 @@ Execute `set enable_profile = true` to enable the session
variable, and you can
If `BytesScannedFromRemote` is 0, it means all caches are hit.
+### Metrics
+
+User can query system table
[file_cache_statistics](../admin-manual/system-tables/file_cache_statistics.md)
to view the cache stats of each Backends.
+
+
+
diff --git a/versioned_docs/version-3.0/lakehouse/metacache.md
b/versioned_docs/version-3.0/lakehouse/metacache.md
index 190e2d0ce27..67ddc9e1509 100644
--- a/versioned_docs/version-3.0/lakehouse/metacache.md
+++ b/versioned_docs/version-3.0/lakehouse/metacache.md
@@ -336,5 +336,9 @@ However, this may increase the access pressure on external
data sources (such as
In version 2.1.5, the `use_meta_cache` attribute was added to the Catalog
properties, defaulting to false.
+:::warning
+Do not set `use_meta_cache` to true before 2.1.6.
+:::
+
In version 2.1.6, for newly created Catalogs, this attribute is default
changed to true to correspond to the caching behavior described in this
document. It is recommended that users upgrade to version 2.1.6 and rebuild
existing Catalogs to align the default behavior with the description in this
document.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
