From 77b31698ae3af37115cf561bc36e6b6a13044faa Mon Sep 17 00:00:00 2001 From: lucasliang Date: Fri, 20 Sep 2024 15:27:43 +0800 Subject: [PATCH 1/6] raft-engine: release `spill-dir` feature. Signed-off-by: lucasliang --- tikv-configuration-file.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 27c818da8792..0e322b42f490 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -1936,6 +1936,21 @@ Raft Engine 相关的配置项。 + 如果你的机器上有多个磁盘，建议将 Raft Engine 的数据存储在单独的磁盘上，以提高 TiKV 性能。 + 默认值：`""` +### `spill-dir` 从 v8.4.0 版本开始引入 + ++ 存储 Raft 日志文件的辅助目录，当 `dir` 目录所在盘数据写满后，新的 Raft 日志将存储在该目录下。 ++ 如果该目录不存在，则在启动 TiKV 时创建该目录。 ++ 如果未设置此配置，则表示该目录不存在。 + +> **注意：** +> +> - 该配置仅在 Raft Engine 的 `dir` 和 `spill-dir` 各自指定为**不同盘符**的情况下有效。 +> - 在配置该功能后，若想要关闭该功能，你需要在重启 TiKV **之前**执行如下操作： +> 1. 关闭 TiKV； +> 2. 将该目录下的所有 Raft Log 拷贝至 [`dir`](/tikv-configuration-file.md#dir) 目录下； +> 3. 从 TiKV 配置文件中删除该配置； +> 4. 重启 TiKV； + ### `batch-compression-threshold` + 指定日志批处理的阈值大小。大于此配置的日志批次将被压缩。如果将此配置项设置为 `0`，则禁用压缩。 From 0d87e25e4b54e62dca8c29d06a424723264de849 Mon Sep 17 00:00:00 2001 From: lucasliang Date: Fri, 20 Sep 2024 15:32:40 +0800 Subject: [PATCH 2/6] Polish annotations. Signed-off-by: lucasliang --- tikv-configuration-file.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 0e322b42f490..21bb1d2350cd 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -1938,8 +1938,7 @@ Raft Engine 相关的配置项。 ### `spill-dir` 从 v8.4.0 版本开始引入 -+ 存储 Raft 日志文件的辅助目录，当 `dir` 目录所在盘数据写满后，新的 Raft 日志将存储在该目录下。 -+ 如果该目录不存在，则在启动 TiKV 时创建该目录。 ++ 存储 Raft 日志文件的辅助目录，当 `dir` 目录所在盘数据写满后，新的 Raft 日志将存储在该目录下。如果该目录配置后不存在，则在启动 TiKV 时创建该目录。 + 如果未设置此配置，则表示该目录不存在。 > **注意：** From f144984c4f366b17892ae4f2988c802657ceb846 Mon Sep 17 00:00:00 2001 From: lucasliang Date: Fri, 20 Sep 2024 15:56:57 +0800 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: xixirangrang --- tikv-configuration-file.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 21bb1d2350cd..9c91b3b31317 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -1943,12 +1943,12 @@ Raft Engine 相关的配置项。 > **注意：** > -> - 该配置仅在 Raft Engine 的 `dir` 和 `spill-dir` 各自指定为**不同盘符**的情况下有效。 +> - 该配置仅在 Raft Engine 的 `dir` 和 `spill-dir` 分别指定为**不同盘符**时才有效。 > - 在配置该功能后，若想要关闭该功能，你需要在重启 TiKV **之前**执行如下操作： -> 1. 关闭 TiKV； -> 2. 将该目录下的所有 Raft Log 拷贝至 [`dir`](/tikv-configuration-file.md#dir) 目录下； -> 3. 从 TiKV 配置文件中删除该配置； -> 4. 重启 TiKV； +> 1. 关闭 TiKV。 +> 2. 将该目录下的所有 Raft Log 复制到 [`dir`](/tikv-configuration-file.md#dir) 目录下。 +> 3. 从 TiKV 配置文件中删除该配置。 +> 4. 重启 TiKV。 ### `batch-compression-threshold` From 6eef193524b33250f5a0cda2330740b9561bd79c Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Fri, 20 Sep 2024 16:13:10 +0800 Subject: [PATCH 4/6] Update tikv-configuration-file.md --- tikv-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 9c91b3b31317..b2b5a1662c95 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -1946,7 +1946,7 @@ Raft Engine 相关的配置项。 > - 该配置仅在 Raft Engine 的 `dir` 和 `spill-dir` 分别指定为**不同盘符**时才有效。 > - 在配置该功能后，若想要关闭该功能，你需要在重启 TiKV **之前**执行如下操作： > 1. 关闭 TiKV。 -> 2. 将该目录下的所有 Raft Log 复制到 [`dir`](/tikv-configuration-file.md#dir) 目录下。 +> 2. 将 `spill-dir` 目录下的所有 Raft Log 复制到 [`dir`](/tikv-configuration-file.md#dir) 目录下。 > 3. 从 TiKV 配置文件中删除该配置。 > 4. 重启 TiKV。 From cb4a81e37c09eafa3be4fc03c6e613c9596642c2 Mon Sep 17 00:00:00 2001 From: lucasliang Date: Fri, 20 Sep 2024 16:16:52 +0800 Subject: [PATCH 5/6] Address comments. Signed-off-by: lucasliang --- tikv-configuration-file.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index b2b5a1662c95..fb5e13abd0e8 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -1939,12 +1939,12 @@ Raft Engine 相关的配置项。 ### `spill-dir` 从 v8.4.0 版本开始引入 + 存储 Raft 日志文件的辅助目录，当 `dir` 目录所在盘数据写满后，新的 Raft 日志将存储在该目录下。如果该目录配置后不存在，则在启动 TiKV 时创建该目录。 -+ 如果未设置此配置，则表示该目录不存在。 ++ 如果未设置此配置，则表示不启用辅助目录。 > **注意：** > > - 该配置仅在 Raft Engine 的 `dir` 和 `spill-dir` 分别指定为**不同盘符**时才有效。 -> - 在配置该功能后，若想要关闭该功能，你需要在重启 TiKV **之前**执行如下操作： +> - 在配置该功能后，若想要关闭该功能，你需要在重启 TiKV **之前**执行如下操作，否则将**无法启动** TiKV： > 1. 关闭 TiKV。 > 2. 将 `spill-dir` 目录下的所有 Raft Log 复制到 [`dir`](/tikv-configuration-file.md#dir) 目录下。 > 3. 从 TiKV 配置文件中删除该配置。 From 25c832d46c6a772069541fd38b2481e67e88f4b7 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Tue, 8 Oct 2024 18:03:37 +0800 Subject: [PATCH 6/6] Update wording --- tikv-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index fb5e13abd0e8..c449f0741f42 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -1938,7 +1938,7 @@ Raft Engine 相关的配置项。 ### `spill-dir` 从 v8.4.0 版本开始引入 -+ 存储 Raft 日志文件的辅助目录，当 `dir` 目录所在盘数据写满后，新的 Raft 日志将存储在该目录下。如果该目录配置后不存在，则在启动 TiKV 时创建该目录。 ++ 存储 Raft 日志文件的辅助目录，当 `dir` 目录所在盘数据写满后，新的 Raft 日志将存储在该目录下。如果该目录配置后不存在，则在 TiKV 启动时自动创建该目录。 + 如果未设置此配置，则表示不启用辅助目录。 > **注意：**