Add service-middleware config for pd-ctl #19023

rleungx · 2024-11-07T06:44:07Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

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)?

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

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

rleungx · 2024-11-08T02:09:55Z

@niubell @okJiang PTAL

pd-control.md

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

ti-chi-bot · 2024-11-12T07:53:21Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

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

qiancai · 2024-11-14T06:44:56Z

pd-control.md

+{{< copyable "" >}}
+


Suggested change

{{< copyable "" >}}

文档站目前默认会给所有代码加上复制按钮，所以不需要单独加 copyable 标识了

qiancai · 2024-11-14T06:45:32Z

pd-control.md

+{{< copyable "" >}}
+


文档站目前默认会给所有代码加上复制按钮，所以不需要单独加 copyable 标识了

pd-control.md

qiancai · 2024-11-14T06:47:40Z

pd-control.md

+}
+```
+
+控制某个调用的 rate limit，以 GetRegion 调用为例：


Suggested change

控制某个调用的 rate limit，以 GetRegion 调用为例：

控制某个调用的 rate limit，以 `GetRegion` 调用为例：

qiancai · 2024-11-14T06:47:50Z

pd-control.md

+config set service-middleware grpc-rate-limit GetRegion qps 100
+```
+
+控制某个调用的并发，以 GetRegion 调用为例：


Suggested change

控制某个调用的并发，以 GetRegion 调用为例：

控制某个调用的并发度，以 `GetRegion` 调用为例：

qiancai · 2024-11-14T06:48:18Z

pd-control.md

+查看修改后的配置
+
+{{< copyable "" >}}


Suggested change

查看修改后的配置

{{< copyable "" >}}

查看修改后的配置：

qiancai · 2024-11-14T06:48:28Z

pd-control.md

+}
+```
+
+重置上述设置


Suggested change

重置上述设置

重置上述设置：

pd-control.md

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

pd-control.md

niubell · 2024-11-20T10:09:18Z

pd-control.md

+  "audit": {
+    "enable-audit": "true"
+  },
+  "rate-limit": {


@rleungx 上面@okJiang 说的有道理，我们在执行 command show 的时候能不能把 audit、rate-limiter 都隐藏掉呢？否则容易误用，既：文档里不暴露，命令行里(或者server 侧直接禁用掉、不返回)也隐藏掉

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

okJiang · 2024-11-21T04:53:39Z

pd-control.md

-`service-middleware` 是 PD 中的一个配置模块，主要用于管理和控制 PD 服务的中间件功能，如审计和请求速率限制等。从 v8.5.0 起，你可以通过 `service-middleware` 控制以下 gRPC API 请求的速率和并发度：
+> **注意：**
+>
+> 通常不建议用户对请求速率限制和并发限制进行修改，此类配置可能会引起业务报错。


业务报错

这是不是太严重了😂

这一段可以放在后面一点的位置，放在前面，用户还不知道 请求速率限制和并发限制 是什么

还有，请求速率限制和并发限制 是 HTTP 的还是 gRPC 的，还是都不建议使用？

都不建议

放在后面感觉不够警示？

如果都不建议设置的话，可以放在

audit: 审计功能

rate-limit: 用于限制 HTTP API 请求的最大速率和最大并发

grpc-rate-limit: 用于限制 gRPC API 请求的最大速率和最大并发

后面，就直接说不建议设置 rate-limit/grpc-rate-limit 可以吧。这样就很明确了

pd-control.md

okJiang · 2024-11-21T05:10:15Z

pd-control.md

+config set service-middleware audit enable-audit true
+```
+
+你可以通过 `service-middleware grpc-rate-limit` 控制以下 gRPC API 请求的速率和并发度：


如果只能控制这三个的话，可以加下

Suggested change

你可以通过 `service-middleware grpc-rate-limit` 控制以下 gRPC API 请求的速率和并发度：

你可以通过 `service-middleware grpc-rate-limit` 控制以下三个 gRPC API 请求的速率和并发度：

不是，只暴露三个

这里不写“三个”也可以，不影响理解。而且，以后要是新增或减少了支持的 API 请求个数，也避免了忘记修改这里

pd-control.md

okJiang · 2024-11-21T05:12:04Z

pd-control.md

+    "grpc-limiter-config": {
+      "GetRegion": {
+        "QPS": 100,
+        "QPSBurst": 100,


这个是作什么用的呢？不能设置？

可以加个注释

不能设置

这个好像也不太好解释

那感觉就在注释里加上，仅作展示就行了

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

okJiang · 2024-11-21T06:35:36Z

pd-control.md

+    "grpc-limiter-config": {
+      "GetRegion": {
+        "QPS": 100,
+        "QPSBurst": 100, // 根据 QPS 设置自动调整


Suggested change

"QPSBurst": 100, // 根据 QPS 设置自动调整

"QPSBurst": 100, // 根据 QPS 设置自动调整，仅作展示

/cc @qiancai 这个 ok 不

okJiang

rest lgtm

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

qiancai · 2024-11-22T07:30:06Z

pd-control.md

+
+> **注意：**
+>
+> 通常不建议用户对 service-middleware 中的配置进行修改。


Suggested change

> 通常不建议用户对 service-middleware 中的配置进行修改。

> 为了避免请求速率限制和并发限制对 PD 性能的影响，通常不建议用户对 `service-middleware` 中的配置进行修改。

qiancai · 2024-11-22T07:32:07Z

pd-control.md

+
+
+
+`service-middleware` 是 PD 中的一个配置模块，主要用于管理和控制 PD 服务的中间件功能，如审计，请求速率和并发限制等。从 v8.5.0 起，支持通过 pd-ctl 修改 `service-middleware` 配置, `option` 支持如下几种类型：


Suggested change

`service-middleware` 是 PD 中的一个配置模块，主要用于管理和控制 PD 服务的中间件功能，如审计，请求速率和并发限制等。从 v8.5.0 起，支持通过 pd-ctl 修改 `service-middleware` 配置, `option` 支持如下几种类型：

`service-middleware` 是 PD 中的一个配置模块，主要用于管理和控制 PD 服务的中间件功能，如审计、请求速率限制和并发限制等。从 v8.5.0 起，PD 支持通过 `pd-ctl` 修改 `service-middleware` 的以下配置：

qiancai · 2024-11-22T07:41:13Z

pd-control.md

+- audit: 控制是否开启 HTTP 请求的审计日志。开启后，会在 PD 日志中记录 HTTP 请求的相关信息，默认开启
+- rate-limit: 用于限制 HTTP API 请求的最大速率和最大并发
+- grpc-rate-limit: 用于限制 gRPC API 请求的最大速率和最大并发


Suggested change

- audit: 控制是否开启 HTTP 请求的审计日志。开启后，会在 PD 日志中记录 HTTP 请求的相关信息，默认开启

- rate-limit: 用于限制 HTTP API 请求的最大速率和最大并发

- grpc-rate-limit: 用于限制 gRPC API 请求的最大速率和最大并发

- `audit`：控制是否开启 PD 处理 HTTP 请求的审计日志（默认开启）。开启时，`service-middleware` 会在 PD 日志中记录 HTTP 请求的相关信息。

- `rate-limit`：用于限制 PD 处理 HTTP API 请求的最大速率和最大并发。

- `grpc-rate-limit`：用于限制 PD 处理 gRPC API 请求的最大速率和最大并发。

qiancai · 2024-11-22T07:47:48Z

pd-control.md

+你可以通过 `service-middleware audit` 控制审计功能：
+
+关闭审计功能


Suggested change

你可以通过 `service-middleware audit` 控制审计功能：

关闭审计功能

`service-middleware audit` 用于开启或关闭 HTTP 请求的日志审计功能。以关闭该功能为例：

qiancai · 2024-11-22T07:54:26Z

pd-control.md

+config set service-middleware audit enable-audit false
+```
+
+你可以通过 `service-middleware grpc-rate-limit` 控制以下 gRPC API 请求的速率和并发度：


Suggested change

你可以通过 `service-middleware grpc-rate-limit` 控制以下 gRPC API 请求的速率和并发度：

`service-middleware grpc-rate-limit` 用于控制以下 gRPC API 请求的最大速率和并发度：

qiancai · 2024-11-22T07:54:45Z

pd-control.md

+config set service-middleware grpc-rate-limit GetRegion concurrency 0
+```
+
+同理，你可以通过 `service-middleware rate-limit` 控制以下 HTTP API 请求的速率和并发度：


Suggested change

同理，你可以通过 `service-middleware rate-limit` 控制以下 HTTP API 请求的速率和并发度：

`service-middleware rate-limit` 用于控制以下 HTTP API 请求的最大速率和并发度：

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

ti-chi-bot · 2024-11-22T08:15:54Z

@okJiang: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Oreoxmt · 2024-11-22T08:54:57Z

pd-control.md

+
+> **注意：**
+>
+> 为了避免请求速率限制和并发限制对 PD 性能的影响，通常不建议用户对 `service-middleware` 中的配置进行修改。


Suggested change

> 为了避免请求速率限制和并发限制对 PD 性能的影响，通常不建议用户对 `service-middleware` 中的配置进行修改。

> 为了避免请求速率限制和并发限制对 PD 性能的影响，不建议修改 `service-middleware` 中的配置。

Oreoxmt

Rest LGTM

ti-chi-bot · 2024-11-22T08:55:14Z

[LGTM Timeline notifier]

Timeline:

2024-11-20 08:33:39.644309829 +0000 UTC m=+20607.263964344: ☑️ agreed by qiancai.
2024-11-22 08:55:13.243505734 +0000 UTC m=+194700.863160250: ☑️ agreed by Oreoxmt.

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

add service-middleware config

21dba3c

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

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 7, 2024

qiancai self-requested a review November 8, 2024 01:51

qiancai self-assigned this Nov 8, 2024

qiancai added v8.5 area/scheduling Indicates that the Issue or PR belongs to the area of scheduling. labels Nov 8, 2024

rleungx requested review from niubell and okJiang November 8, 2024 02:09

qiancai added translation/doing This PR’s assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Nov 8, 2024

okJiang reviewed Nov 8, 2024

View reviewed changes

pd-control.md Show resolved Hide resolved

okJiang reviewed Nov 8, 2024

View reviewed changes

pd-control.md Outdated Show resolved Hide resolved

address the comment

8e1b69b

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

rleungx requested a review from okJiang November 12, 2024 07:53

address the comment

dcd4082

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

qiancai reviewed Nov 14, 2024

View reviewed changes

rleungx and others added 2 commits November 18, 2024 14:04

address comments

bc3cdf8

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

update descriptions

02f0452

qiancai reviewed Nov 20, 2024

View reviewed changes

pd-control.md Outdated Show resolved Hide resolved

remove an extra space

fe1fed8

qiancai approved these changes Nov 20, 2024

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Nov 20, 2024

okJiang reviewed Nov 20, 2024

View reviewed changes

pd-control.md Outdated Show resolved Hide resolved

qiancai mentioned this pull request Nov 20, 2024

Add service-middleware config for pd-ctl pingcap/docs#19472

Open

17 tasks

niubell reviewed Nov 20, 2024

View reviewed changes

address comments

c183275

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

ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 21, 2024

okJiang reviewed Nov 21, 2024

View reviewed changes

pd-control.md Outdated Show resolved Hide resolved

okJiang reviewed Nov 21, 2024

View reviewed changes

pd-control.md Outdated Show resolved Hide resolved

okJiang reviewed Nov 21, 2024

View reviewed changes

rleungx added 2 commits November 21, 2024 13:46

address comments

d0ed94a

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

address comments

6f419e5

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

okJiang reviewed Nov 21, 2024

View reviewed changes

address comments

d1f37ce

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

qiancai reviewed Nov 22, 2024

View reviewed changes

address comments

aaddac7

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

okJiang approved these changes Nov 22, 2024

View reviewed changes

Oreoxmt self-requested a review November 22, 2024 08:19

Oreoxmt reviewed Nov 22, 2024

View reviewed changes

Oreoxmt approved these changes Nov 22, 2024

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Nov 22, 2024

address the comment

13ff823

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

	控制某个调用的 rate limit，以 GetRegion 调用为例：
	控制某个调用的 rate limit，以 `GetRegion` 调用为例：

	控制某个调用的并发，以 GetRegion 调用为例：
	控制某个调用的并发度，以 `GetRegion` 调用为例：

	你可以通过 `service-middleware grpc-rate-limit` 控制以下 gRPC API 请求的速率和并发度：
	你可以通过 `service-middleware grpc-rate-limit` 控制以下三个 gRPC API 请求的速率和并发度：

	"QPSBurst": 100, // 根据 QPS 设置自动调整
	"QPSBurst": 100, // 根据 QPS 设置自动调整，仅作展示

	> 通常不建议用户对 service-middleware 中的配置进行修改。
	> 为了避免请求速率限制和并发限制对 PD 性能的影响，通常不建议用户对 `service-middleware` 中的配置进行修改。




		`service-middleware` 是 PD 中的一个配置模块，主要用于管理和控制 PD 服务的中间件功能，如审计，请求速率和并发限制等。从 v8.5.0 起，支持通过 pd-ctl 修改 `service-middleware` 配置, `option` 支持如下几种类型：

		你可以通过 `service-middleware audit` 控制审计功能：

		关闭审计功能

	你可以通过 `service-middleware grpc-rate-limit` 控制以下 gRPC API 请求的速率和并发度：
	`service-middleware grpc-rate-limit` 用于控制以下 gRPC API 请求的最大速率和并发度：

	同理，你可以通过 `service-middleware rate-limit` 控制以下 HTTP API 请求的速率和并发度：
	`service-middleware rate-limit` 用于控制以下 HTTP API 请求的最大速率和并发度：

	> 为了避免请求速率限制和并发限制对 PD 性能的影响，通常不建议用户对 `service-middleware` 中的配置进行修改。
	> 为了避免请求速率限制和并发限制对 PD 性能的影响，不建议修改 `service-middleware` 中的配置。

Add service-middleware config for pd-ctl #19023

Are you sure you want to change the base?

Add service-middleware config for pd-ctl #19023

Conversation

rleungx commented Nov 7, 2024 • edited by qiancai Loading

First-time contributors' checklist

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)?

Do your changes match any of the following descriptions?

rleungx commented Nov 8, 2024

ti-chi-bot bot commented Nov 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

niubell Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okJiang Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okJiang Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okJiang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Nov 22, 2024

Choose a reason for hiding this comment

Oreoxmt left a comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Nov 22, 2024

[LGTM Timeline notifier]

rleungx commented Nov 7, 2024 •

edited by qiancai

Loading

niubell Nov 20, 2024 •

edited

Loading

okJiang Nov 21, 2024 •

edited

Loading

okJiang Nov 21, 2024 •

edited

Loading