doc: configs of max-ts checker #19380
Conversation
Signed-off-by: ekexium <eke@fastmail.com>
ti-chi-bot
bot
added
missing-translation-status
tikv-configuration-file.md
Outdated
| ### `max-ts-drift-allowance` | ||
|
|
||
| + 读写请求更新 max-ts 时允许超过 TiKV 缓存的 PD TSO 的最大值。 | ||
| + 如果尝试更新的 max-ts 超过 TiKV 缓存的 PD TSO + allowance，认为该请求的来源不合法，会执行 [`action-on-invalid-max-ts`](#action-on-invalid-max-ts) 规定的行为。 |
There was a problem hiding this comment.
更新 max-ts 的时候这个路径应该永远不会 panic？
hfxsd
added
translation/doing
Co-authored-by: cfzjywxk <cfzjywxk@gmail.com>
hfxsd
added
the
type/compatibility-or-feature-change
Signed-off-by: ekexium <eke@fastmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
| @@ -561,6 +561,29 @@ I/O rate limiter 相关的配置项。 | |||
| + 可选值：`"read-only"`，`"write-only"`，`"all-io"` | |||
| + 默认值：`"write-only"` | |||
|
|
|||
| ## `storage.max-ts` | |||
|
|
|||
| ### `max-drift` | |||
There was a problem hiding this comment.
| ### `max-drift` | |
| ### `max-drift` <span class="version-mark">从 v9.0.0 版本开始引入</span> |
| + 默认值：60s | ||
| + 建议设置为[`cache-sync-interval`](#cache-sync-interval)的 3 倍以上。 | ||
|
|
||
| ### `cache-sync-interval` |
There was a problem hiding this comment.
| ### `cache-sync-interval` | |
| ### `cache-sync-interval` <span class="version-mark">从 v9.0.0 版本开始引入</span> |
| + TiKV 更新 PD TSO 缓存的时间间隔。该缓存用于检查 max-ts 更新的合法性。 | ||
| + 默认值：15s | ||
|
|
||
| ### `action-on-invalid-update` |
There was a problem hiding this comment.
| ### `action-on-invalid-update` | |
| ### `action-on-invalid-update` <span class="version-mark">从 v9.0.0 版本开始引入</span> |
| + `"error"`：TiKV 会将错误返回。 | ||
| + `"log"`：TiKV 会打印 error 日志并继续执行。 | ||
| + 默认值：`"panic"` | ||
|
|
There was a problem hiding this comment.
一般情况下，这 3 个配置项请按字母顺序排列
action-on-invalid-update
cache-sync-interval
max-drift
| @@ -561,6 +561,29 @@ I/O rate limiter 相关的配置项。 | |||
| + 可选值：`"read-only"`，`"write-only"`，`"all-io"` | |||
| + 默认值：`"write-only"` | |||
|
|
|||
| ## `storage.max-ts` | |||
|
|
|||
|
|
||
| ### `max-drift` | ||
|
|
||
| + 读写请求更新 max-ts 时允许超过 TiKV 缓存的 PD TSO 的最大值。 |
There was a problem hiding this comment.
搜了下，文档里其他地方都没有介绍过 max-ts 是什么，因此这里需要介绍下，或者用中文含义代替
What is changed, added or deleted? (Required)
Doc of 3 TiKV config items, introduced in tikv/tikv#17917
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions (in Chinese).
What is the related PR or file link(s)?
tikv/tikv#17916
tikv/tikv#17917
Do your changes match any of the following descriptions?