Skip to content

tiproxy: update the recommended graceful-wait-before-shutdown #20525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tiproxy/tiproxy-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ component_versions:
tiproxy: "v1.2.0"
server_configs:
tidb:
graceful-wait-before-shutdown: 15
graceful-wait-before-shutdown: 30
tiproxy:
ha.virtual-ip: "10.0.1.10/24"
ha.interface: "eth0"
Expand Down
4 changes: 2 additions & 2 deletions tiproxy/tiproxy-load-balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ server_configs:
tiproxy:
balance.label-name: "app"
tidb:
graceful-wait-before-shutdown: 15
graceful-wait-before-shutdown: 30
tiproxy_servers:
- host: tiproxy-host-1
config:
Expand Down Expand Up @@ -156,7 +156,7 @@ component_versions:
tiproxy: "v1.1.0"
server_configs:
tidb:
graceful-wait-before-shutdown: 15
graceful-wait-before-shutdown: 30
tiproxy_servers:
- host: tiproxy-host-1
config:
Expand Down
12 changes: 6 additions & 6 deletions tiproxy/tiproxy-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,14 @@ TiProxy 不适用于以下场景:

1. 配置 TiDB 实例。

使用 TiProxy 时,需要为 TiDB 配置 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入)。该值应大于应用程序最长事务的持续时间,以避免 TiDB server 下线时客户端连接中断。你可以通过 [TiDB 监控面板的 Transaction 指标](/grafana-tidb-dashboard.md#transaction) 查看事务持续时间。更多信息,请参阅[使用限制](#使用限制)。
使用 TiProxy 时,需要为 TiDB 配置 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入)。该值应比应用程序最长事务的持续时间大 10 秒以上,以避免 TiDB server 下线时客户端连接中断。你可以通过 [TiDB 监控面板的 Transaction 指标](/grafana-tidb-dashboard.md#transaction) 查看事务持续时间。更多信息,请参阅[使用限制](#使用限制)。

配置示例:

```yaml
server_configs:
tidb:
graceful-wait-before-shutdown: 15
graceful-wait-before-shutdown: 30
```

2. 配置 TiProxy 实例。
Expand Down Expand Up @@ -166,14 +166,14 @@ TiProxy 不适用于以下场景:

3. 修改 TiDB 配置。

使用 TiProxy 时,需要为 TiDB 配置 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入)。该值应大于应用程序最长事务的持续时间,以避免 TiDB server 下线时客户端连接中断。你可以通过 [TiDB 监控面板的 Transaction 指标](/grafana-tidb-dashboard.md#transaction) 查看事务持续时间。更多信息,请参阅[使用限制](#使用限制)。
使用 TiProxy 时,需要为 TiDB 配置 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入)。该值应比应用程序最长事务的持续时间大 10 秒以上,以避免 TiDB server 下线时客户端连接中断。你可以通过 [TiDB 监控面板的 Transaction 指标](/grafana-tidb-dashboard.md#transaction) 查看事务持续时间。更多信息,请参阅[使用限制](#使用限制)。

配置示例:

```yaml
server_configs:
tidb:
graceful-wait-before-shutdown: 15
graceful-wait-before-shutdown: 30
```

4. 重新加载 TiDB 配置。
Expand Down Expand Up @@ -246,8 +246,8 @@ TiProxy 的以下行为与 TiDB 不兼容:

以下情况下,TiProxy 无法进行连接迁移,因此无法正常地保持客户端连接或负载均衡:

- 单条语句或单个事务持续时间超过 TiDB server 配置的 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入) 时间
- 会话使用了游标读取数据,且超过 TiDB server 配置的 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入) 时间没有读完数据或关闭游标
- 单条语句或单个事务持续时间超过 TiDB server 配置的 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入) 时间减去 10 秒
- 会话使用了游标读取数据,且超过 TiDB server 配置的 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入) 时间减去 10 秒没有读完数据或关闭游标
- 会话创建了[本地临时表](/temporary-tables.md#本地临时表)。
- 会话持有了[用户级锁](/functions-and-operators/locking-functions.md)。
- 会话持有了[表锁](/sql-statements/sql-statement-lock-tables-and-unlock-tables.md)。
Expand Down