Skip to content

Commit f617492

Browse files
authored
tiproxy: update the recommended graceful-wait-before-shutdown (#20525)
1 parent fcbe73e commit f617492

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

tiproxy/tiproxy-deployment-topology.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ component_versions:
4646
tiproxy: "v1.2.0"
4747
server_configs:
4848
tidb:
49-
graceful-wait-before-shutdown: 15
49+
graceful-wait-before-shutdown: 30
5050
tiproxy:
5151
ha.virtual-ip: "10.0.1.10/24"
5252
ha.interface: "eth0"

tiproxy/tiproxy-load-balance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ server_configs:
5555
tiproxy:
5656
balance.label-name: "app"
5757
tidb:
58-
graceful-wait-before-shutdown: 15
58+
graceful-wait-before-shutdown: 30
5959
tiproxy_servers:
6060
- host: tiproxy-host-1
6161
config:
@@ -156,7 +156,7 @@ component_versions:
156156
tiproxy: "v1.1.0"
157157
server_configs:
158158
tidb:
159-
graceful-wait-before-shutdown: 15
159+
graceful-wait-before-shutdown: 30
160160
tiproxy_servers:
161161
- host: tiproxy-host-1
162162
config:

tiproxy/tiproxy-overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,14 @@ TiProxy 不适用于以下场景:
7878

7979
1. 配置 TiDB 实例。
8080

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

8383
配置示例:
8484

8585
```yaml
8686
server_configs:
8787
tidb:
88-
graceful-wait-before-shutdown: 15
88+
graceful-wait-before-shutdown: 30
8989
```
9090
9191
2. 配置 TiProxy 实例。
@@ -166,14 +166,14 @@ TiProxy 不适用于以下场景:
166166

167167
3. 修改 TiDB 配置。
168168

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

171171
配置示例:
172172

173173
```yaml
174174
server_configs:
175175
tidb:
176-
graceful-wait-before-shutdown: 15
176+
graceful-wait-before-shutdown: 30
177177
```
178178

179179
4. 重新加载 TiDB 配置。
@@ -248,10 +248,10 @@ TiProxy 的以下行为与 TiDB 不兼容:
248248
- TiProxy 进行缩容、升级、重启等下线操作。一旦 TiProxy 下线,客户端连接也会断开。
249249
- TiDB 主动断开连接。例如会话超过 `wait_timeout` 的时间没有发送请求时,TiDB 会主动断开连接,此时 TiProxy 也会断开客户端连接。
250250

251-
以下情况下,TiProxy 无法进行连接迁移,因此无法正常地保持客户端连接或负载均衡
251+
在以下情况下,TiProxy 将无法完成连接迁移,会导致客户端连接中断或负载均衡失效
252252

253-
- 单条语句或单个事务持续时间超过 TiDB server 配置的 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入) 时间
254-
- 会话使用了游标读取数据,且超过 TiDB server 配置的 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入) 时间没有读完数据或关闭游标
253+
- 长时间运行的单条语句或单个事务:其执行时间超过了 TiDB Server 配置的 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入) 的值减去 10 秒的时间窗口
254+
- 使用游标且未及时完成:会话使用游标读取数据,但超过 TiDB Server 配置的 [`graceful-wait-before-shutdown`](/tidb-configuration-file.md#graceful-wait-before-shutdown-从-v50-版本开始引入) 的值减去 10 秒后,仍未完成数据读取或关闭游标
255255
- 会话创建了[本地临时表](/temporary-tables.md#本地临时表)。
256256
- 会话持有了[用户级锁](/functions-and-operators/locking-functions.md)。
257257
- 会话持有了[表锁](/sql-statements/sql-statement-lock-tables-and-unlock-tables.md)。

0 commit comments

Comments
 (0)