reference/configuration: add a guide about how to use dynamic config #3058

rleungx · 2020-05-13T05:23:05Z

What is changed, added or deleted? (Required)

This PR adds a guide about how to use the dynamic config.

Which TiDB version(s) do your changes apply to? (Required)

master (the latest development version, including v4.0 changes for now)
v3.1 (TiDB 3.1 versions)
v3.0 (TiDB 3.0 versions)
v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

N/A

rleungx · 2020-05-13T05:23:22Z

PTAL @qw4990 @NingLin-P

NingLin-P

Rest LGTM

NingLin-P · 2020-05-13T06:37:40Z

reference/configuration/dynamic-config.md

+可以通过 SQL `show config` 来直接查看集群所有实例的配置信息，结果如下：
+
+```
+mysql> mysql> show config;


Suggested change

mysql> mysql> show config;

mysql> show config;

NingLin-P · 2020-05-13T06:39:18Z

reference/configuration/dynamic-config.md

+---------+------+---------------------------------------------------------------------------------------------------------------+
+| Level   | Code | Message                                                                                                       |
+---------+------+---------------------------------------------------------------------------------------------------------------+
+| Warning | 1105 | bad request to http://127.0.0.1:20180/config: fail to update, error: "config \"log_level\" can not be change" |


ran-huang · 2020-05-13T10:32:38Z

@rleungx Do these changes apply to v4.0?

reference/configuration/dynamic-config.md

ran-huang · 2020-05-13T10:37:28Z

reference/configuration/dynamic-config.md

+使用 `set config` 时，需要注意：
+为了避免和 SQL 变量混淆，TiDB 的配置可以通过 `show config` 查看但是不能进行修改，修改 TiDB 动态配置是会返回错误，如果想动态修改 TiDB 行为，请用对应的 SQL 变量去控制；
+某些配置项名称可能和 TiDB 预留关键字冲突，如 `limit`，`key` 等，对于此类配置项，需要用反引号 \` 包裹起来，如 `tikv-client`.`store-limit`；


Suggested change

使用 `set config` 时，需要注意：

为了避免和 SQL 变量混淆，TiDB 的配置可以通过 `show config` 查看但是不能进行修改，修改 TiDB 动态配置是会返回错误，如果想动态修改 TiDB 行为，请用对应的 SQL 变量去控制；

某些配置项名称可能和 TiDB 预留关键字冲突，如 `limit`，`key` 等，对于此类配置项，需要用反引号 \` 包裹起来，如 `tikv-client`.`store-limit`；

> **注意：**

> 为了避免和 SQL 变量混淆，TiDB 的配置可以通过 `show config` 查看但是不能进行修改，修改 TiDB 动态配置时会返回错误；如果想动态修改 TiDB 行为，请用对应的 SQL 变量去控制。

> 某些配置项名称可能和 TiDB 预留关键字冲突，如 `limit`，`key` 等，对于此类配置项，需要用反引号 ``` ` ``` 包裹起来，如 `tikv-client`.`store-limit`；

ran-huang · 2020-05-13T10:37:44Z

reference/configuration/dynamic-config.md

+| --- | --- |
+| log.level| 日志级别 |
+| cluster-version | 集群的版本 |
+| schedule.max-merge-region-size |  控制 Region Merge 的 size 上限（单位是 M） |


ran-huang · 2020-05-13T11:06:18Z

reference/configuration/dynamic-config.md

+上述前缀为 `{db-name}` 或 `{db-name}.{cf-name}` 的参数是 RocksDB 相关的配置
+`db-name` 的取值可以为是 `rocksdb`, `raftdb`
+当 `db-name` 为 `rocksdb` 时，cf-name 的取值有: `defaultcf`，`writecf`，`lockcf`，`raftcf`
+当 `db-name` 为 `raftdb` 时，cf-name 的取值有: `defaultcf`


Suggested change

上述前缀为 `{db-name}` 或 `{db-name}.{cf-name}` 的参数是 RocksDB 相关的配置

`db-name` 的取值可以为是 `rocksdb`, `raftdb`

当 `db-name` 为 `rocksdb` 时，cf-name 的取值有: `defaultcf`，`writecf`，`lockcf`，`raftcf`

当 `db-name` 为 `raftdb` 时，cf-name 的取值有: `defaultcf`

上述前缀为 `{db-name}` 或 `{db-name}.{cf-name}` 的参数是 RocksDB 相关的配置。`db-name` 的取值可以为是 `rocksdb`, `raftdb`。

- 当 `db-name` 为 `rocksdb` 时，cf-name 的取值有: `defaultcf`，`writecf`，`lockcf`，`raftcf`；

- 当 `db-name` 为 `raftdb` 时，cf-name 的取值有: `defaultcf`。

TomShawn · 2020-05-20T08:18:26Z

@qw4990 PTAL
@rleungx Please address the comments above.

Signed-off-by: Ryan Leung <rleungx@gmail.com>

rleungx · 2020-05-20T08:34:22Z

@NingLin-P @qw4990 PTAL

dynamic-config.md

NingLin-P

LGTM

Co-authored-by: NingLin-P <linning@pingcap.com>

dynamic-config.md

ran-huang

LGTM

dynamic-config.md

zz-jason

LGTM

…nto pr/3058

TomShawn

LGTM

ti-srebot · 2020-07-30T08:30:01Z

/run-all-tests

TomShawn · 2020-07-30T08:33:15Z

@ran-huang Please be aware of the major changes made in this PR since you finished the translation. Please carefully compare and align these changes, thanks!

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot · 2020-07-30T08:38:37Z

cherry pick to release-4.0 in PR #4128

…3058) (#4128) Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Ryan Leung <rleungx@gmail.com>

rleungx added the v4.0 This PR/issue applies to TiDB v4.0. label May 13, 2020

rleungx requested review from qw4990 and NingLin-P May 13, 2020 05:23

NingLin-P reviewed May 13, 2020

View reviewed changes

ran-huang self-requested a review May 13, 2020 10:32

ran-huang reviewed May 13, 2020

View reviewed changes

ran-huang added needs-cherry-pick-4.0 translation/doing This PR’s assignee is translating this PR. labels May 13, 2020

ran-huang self-assigned this May 13, 2020

ran-huang added the status/WIP This PR is still working in progress. label May 13, 2020

TomShawn added the size/large Changes of a large size. label May 13, 2020

rleungx force-pushed the dynamic-config branch from c7fabc9 to 1edd7d9 Compare May 20, 2020 08:29

rleungx added 4 commits May 20, 2020 16:31

add a guide about how to use dynamic config

2c2f15a

Signed-off-by: Ryan Leung <rleungx@gmail.com>

add the document to TOC

6350048

Signed-off-by: Ryan Leung <rleungx@gmail.com>

rewrite the dynamic config guide

fe280e4

Signed-off-by: Ryan Leung <rleungx@gmail.com>

address comments

458a104

Signed-off-by: Ryan Leung <rleungx@gmail.com>

rleungx force-pushed the dynamic-config branch from 1edd7d9 to 458a104 Compare May 20, 2020 08:33

NingLin-P reviewed May 20, 2020

View reviewed changes

dynamic-config.md Outdated Show resolved Hide resolved

NingLin-P approved these changes May 20, 2020

View reviewed changes

Update dynamic-config.md

4cbcf07

Co-authored-by: NingLin-P <linning@pingcap.com>

ran-huang removed the status/WIP This PR is still working in progress. label May 20, 2020

ran-huang reviewed May 20, 2020

View reviewed changes

dynamic-config.md Outdated Show resolved Hide resolved

Apply suggestions from code review

79f1d07

ran-huang approved these changes May 20, 2020

View reviewed changes

qw4990 added 3 commits July 28, 2020 11:26

address comments

cf034b2

fixup

64a5c5c

address comments

5b1fdde

TomShawn reviewed Jul 28, 2020

View reviewed changes

dynamic-config.md Outdated Show resolved Hide resolved

Update dynamic-config.md

cdfe6f3

zz-jason approved these changes Jul 30, 2020

View reviewed changes

ti-srebot removed the status/LGT1 Indicates that a PR has LGTM 1. label Jul 30, 2020

ti-srebot approved these changes Jul 30, 2020

View reviewed changes

ti-srebot added the status/LGT2 Indicates that a PR has LGTM 2. label Jul 30, 2020

TomShawn added 3 commits July 30, 2020 15:38

Merge branch 'dynamic-config' of https://github.com/rleungx/docs-cn i…

c1234dd

…nto pr/3058

refine language

df10371

Merge branch 'master' into dynamic-config

3b0662b

TomShawn approved these changes Jul 30, 2020

View reviewed changes

ti-srebot added status/LGT3 The PR has already had 3 LGTM. and removed status/LGT2 Indicates that a PR has LGTM 2. labels Jul 30, 2020

TomShawn added status/can-merge Indicates a PR has been approved by a committer. translation/doing This PR’s assignee is translating this PR. and removed translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. labels Jul 30, 2020

TomShawn merged commit a0b92ca into pingcap:master Jul 30, 2020

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jul 30, 2020

cherry pick pingcap#3058 to release-4.0

2ecd720

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot mentioned this pull request Jul 30, 2020

reference/configuration: add a guide about how to use dynamic config (#3058) #4128

Merged

4 tasks

ti-srebot added a commit that referenced this pull request Jul 30, 2020

reference/configuration: add a guide about how to use dynamic config (#…

9a404c1

…3058) (#4128) Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Ryan Leung <rleungx@gmail.com>

ran-huang mentioned this pull request Aug 3, 2020

maintenance: update dynamic configuration pingcap/docs#3529

Merged

9 tasks

ran-huang added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Aug 5, 2020

ti-srebot mentioned this pull request Aug 12, 2020

maintenance: update dynamic configuration (#3529) pingcap/docs#3633

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

reference/configuration: add a guide about how to use dynamic config #3058

reference/configuration: add a guide about how to use dynamic config #3058

rleungx commented May 13, 2020

rleungx commented May 13, 2020

NingLin-P left a comment

NingLin-P May 13, 2020

NingLin-P May 13, 2020

ran-huang commented May 13, 2020

ran-huang May 13, 2020

ran-huang May 13, 2020

ran-huang May 13, 2020

TomShawn commented May 20, 2020

rleungx commented May 20, 2020

NingLin-P left a comment

ran-huang left a comment

zz-jason left a comment

TomShawn left a comment

ti-srebot commented Jul 30, 2020

TomShawn commented Jul 30, 2020

ti-srebot commented Jul 30, 2020

	\| Warning \| 1105 \| bad request to http://127.0.0.1:20180/config: fail to update, error: "config \"log_level\" can not be change" \|
	\| Warning \| 1105 \| bad request to http://127.0.0.1:20180/config: fail to update, error: "config log-level can not be change" \|

	\| schedule.max-merge-region-size \| 控制 Region Merge 的 size 上限（单位是 M） \|
	\| schedule.max-merge-region-size \| 控制 Region Merge 的 size 上限（单位是 MB） \|

reference/configuration: add a guide about how to use dynamic config #3058

reference/configuration: add a guide about how to use dynamic config #3058

Conversation

rleungx commented May 13, 2020

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

rleungx commented May 13, 2020

NingLin-P left a comment

Choose a reason for hiding this comment

NingLin-P May 13, 2020

Choose a reason for hiding this comment

NingLin-P May 13, 2020

Choose a reason for hiding this comment

ran-huang commented May 13, 2020

ran-huang May 13, 2020

Choose a reason for hiding this comment

ran-huang May 13, 2020

Choose a reason for hiding this comment

ran-huang May 13, 2020

Choose a reason for hiding this comment

TomShawn commented May 20, 2020

rleungx commented May 20, 2020

NingLin-P left a comment

Choose a reason for hiding this comment

ran-huang left a comment

Choose a reason for hiding this comment

zz-jason left a comment

Choose a reason for hiding this comment

TomShawn left a comment

Choose a reason for hiding this comment

ti-srebot commented Jul 30, 2020

TomShawn commented Jul 30, 2020

ti-srebot commented Jul 30, 2020