Update TiProxy to v1.3.3 by djshow832 · Pull Request #21940 · pingcap/docs-cn

djshow832 · 2026-09-17T07:54:51Z

What is changed, added, or deleted? (Required)

v1.3.3 was released.

Add some configs.
Add some grafana panels.
Update the default balance factor order.
Update the recommanded version to v1.3.3.

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

Related code change PR links (if applicable):
This PR is translated from:
Other reference link(s):

AI agent involvement

The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

文档
- 新增 TiProxy v1.3.3 配置说明，涵盖故障后端处理、连接迁移超时、高内存保护、新连接路由、负载均衡及高可用 GARP 参数，并补充默认值、取值范围和热加载说明。
- 更新负载均衡策略文档，调整默认优先级、完善策略说明并补充配置链接。
- 部署拓扑及集群配置示例更新至 TiProxy v1.3.3。
- Grafana Server 面板新增 Connection Lifetime 平均值和 P99 指标说明。

These non-doc files were included in a local commit by mistake and are not part of the TiProxy documentation updates. Co-authored-by: Cursor <cursoragent@cursor.com>

ti-chi-bot · 2026-09-17T07:54:55Z

[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 assign breezewish for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

Details

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

coderabbitai · 2026-09-17T07:55:15Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

本次变更更新 TiProxy v1.3.3 文档，新增配置项，调整负载均衡说明，更新版本示例，并新增 Connection Lifetime 指标说明。

Changes

TiProxy 文档更新

Layer / File(s)	Summary
新增 TiProxy 配置项 `tiproxy/tiproxy-configuration.md`	新增 `proxy`、`balance` 和 `ha` 配置项，包括默认值、取值范围及生效条件。
调整负载均衡说明 `tiproxy/tiproxy-load-balance.md`	调整策略优先级，移动状态策略章节，更新连接数策略描述，并添加 `balance` 配置链接。
同步版本与监控文档 `tiproxy/tiproxy-deployment-topology.md`、`tiproxy/tiproxy-overview.md`、`tiproxy/tiproxy-grafana.md`	将文档示例中的 TiProxy 版本更新为 `v1.3.3`，并新增 Connection Lifetime 指标说明。

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: qiancai, yangkeao

Merge Risk: 🔵 Low · up to e0e3c

The documentation can mislead users about a valid buffer value and about which TiProxy versions support CPU balancing. The impact is limited to configuration and upgrade guidance, but these corrections should be made before release.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	标题“Update TiProxy to v1.3.3”准确概括了本次将 TiProxy 文档更新到 v1.3.3 的主要变更，简洁且明确。
Description check	✅ Passed	描述包含变更内容、适用版本、AI 参与情况及其他模板章节。已勾选 master、v9.0 和 v8.5，符合 PR 目标。相关链接为空，但该部分为可选信息，不影响整体完整性。
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d805ec76-86ef-45b2-bfbb-ce295b145bdf

📥 Commits

Reviewing files that changed from the base of the PR and between 924e58f and d17e623.

📒 Files selected for processing (5)

tiproxy/tiproxy-configuration.md
tiproxy/tiproxy-deployment-topology.md
tiproxy/tiproxy-grafana.md
tiproxy/tiproxy-load-balance.md
tiproxy/tiproxy-overview.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to GitHub limitations.

⚠️ Outside diff range comments (1)

🟡 Minor · 将 0 加入 conn-buffer-size 的取值范围。 · tiproxy-configuration.md:108-109

tiproxy/tiproxy-configuration.md:108-109
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

将 0 加入 conn-buffer-size 的取值范围。

TiProxy 的默认配置将 0 定义为使用默认值，同时支持 1K 到 16M。当前范围遗漏了合法值 0，会与后文的行为说明冲突。
+ 取值范围：`0` 或 `[1024, 16777216]`
Source: Path instructions

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: e497a26d-fc80-4b0c-98bc-7e862b01ccd1

📥 Commits

Reviewing files that changed from the base of the PR and between d17e623 and 16c2524.

📒 Files selected for processing (2)

tiproxy/tiproxy-configuration.md
tiproxy/tiproxy-load-balance.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

ti-chi-bot · 2026-09-17T08:46:08Z

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

Details

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.

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to GitHub limitations.

⚠️ Outside diff range comments (1)

🟡 Minor · 明确区分 CPU 负载均衡和新增配置项的版本。 · tiproxy-configuration.md:211-220

tiproxy/tiproxy-configuration.md:211-220
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

明确区分 CPU 负载均衡和新增配置项的版本。

cpu 小节标题将 v1.3.3 标记作用于整个配置节。用户可能因此认为 v1.1.0 至 v1.3.2 不支持 CPU 负载均衡，但其他文档明确说明该功能从 v1.1.0 开始支持。请移除小节标题上的版本标记，并保留各配置项的 v1.3.3 标记。
#### `cpu`

基于 CPU 的负载均衡配置。TiProxy 从 v1.1.0 开始支持基于 CPU 的负载均衡。本节中的配置项从 v1.3.3 开始引入。仅当 [`policy`](`#policy`) 为 `resource` 或 `location` 时生效。

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: cf71b36a-a062-44ed-9d5c-c18fdd41cf76

📥 Commits

Reviewing files that changed from the base of the PR and between 16c2524 and e0e3c91.

📒 Files selected for processing (1)

tiproxy/tiproxy-configuration.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Co-authored-by: Grace Cai <qqzczy@126.com>

djshow832 and others added 6 commits September 17, 2026 10:42

balance

7ef83a0

proxy

cb955f7

ha

1fdafe4

grafana

8d6f029

Revert accidental package.json and package-lock.json changes.

ce5161f

These non-doc files were included in a local commit by mistake and are not part of the TiProxy documentation updates. Co-authored-by: Cursor <cursoragent@cursor.com>

balance order

d17e623

ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 17, 2026

coderabbitai Bot reviewed Sep 17, 2026

View reviewed changes

Comment thread tiproxy/tiproxy-load-balance.md Outdated

address comment

16c2524

coderabbitai Bot reviewed Sep 17, 2026

View reviewed changes

YangKeao approved these changes Sep 17, 2026

View reviewed changes

qiancai reviewed Sep 18, 2026

View reviewed changes

Apply suggestions from code review

e0e3c91

coderabbitai Bot reviewed Sep 18, 2026

View reviewed changes

Apply batched suggestions from code review

8d863fb

Co-authored-by: Grace Cai <qqzczy@126.com>

Navigation Menu

Update TiProxy to v1.3.3 - #21940

Update TiProxy to v1.3.3#21940
djshow832 wants to merge 9 commits into
pingcap:masterfrom
djshow832:tiproxy_133

djshow832 commented Sep 17, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

ti-chi-bot Bot commented Sep 17, 2026

Uh oh!

coderabbitai Bot commented Sep 17, 2026 •

edited

Loading

Reviews paused

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

ti-chi-bot Bot commented Sep 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

djshow832 commented Sep 17, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

AI agent involvement

Do your changes match any of the following descriptions?

Summary by CodeRabbit

Uh oh!

ti-chi-bot Bot commented Sep 17, 2026

Uh oh!

coderabbitai Bot commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot Bot commented Sep 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

djshow832 commented Sep 17, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Sep 17, 2026 •

edited

Loading