From 9d5d049c7311591350c21db8be4ecbabbe5088db Mon Sep 17 00:00:00 2001 From: Lynn Date: Fri, 17 Oct 2025 15:39:54 +0800 Subject: [PATCH 01/42] *: add two variables tidb_slow_log_rules and tidb_slow_log_max_per_sec --- identify-slow-queries.md | 21 ++++++++++++++++++++- system-variables.md | 22 ++++++++++++++++++++++ 2 files changed, 42 insertions(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 66928ec623fd..1272c0291808 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -174,8 +174,27 @@ Slow Query 基础信息： - `Storage_from_mpp`：从 v9.0.0 开始引入，表示该语句是否从 TiFlash 读取数据。 ## 相关系统变量 - * [tidb_slow_log_threshold](/system-variables.md#tidb_slow_log_threshold)：设置慢日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 +* [tidb_slow_log_rules](/system-variables.md#tidb_slow_log_rules)：用于定义慢日志的触发规则，支持多维度指标组合条件，实现更加灵活和精细化的日志记录控制。此变量在新版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 + * 未设置 tidb_slow_log_rules + * 慢日志触发仍依赖 tidb_slow_log_threshold，Query_time 阈值取自该变量，以保持向后兼容。 + * 已设置 tidb_slow_log_rules + * 配置的规则优先生效，tidb_slow_log_threshold 将被忽略。 + * 若希望规则中仍包含 Query_time 的触发条件，可在设置规则时指定。 + * 规则匹配逻辑（多条规则之间采用 OR 关系）： + * Session 作用域规则：优先匹配，如果匹配成功，则打印慢日志。 + * Global 作用域规则：仅在 Session 规则未匹配时考虑： + * 若规则指定 ConnID 并与当前 Session 的 ConnID 匹配，则使用该规则。 + * 若规则未指定 ConnID（全局通用规则），则使用该规则。 + * 显示变量的行为与普通系统变量一致。 + > + > 说明：`tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢日志控制，支持多维度指标组合条件。 + > + > 建议：在启用 `tidb_slow_log_rules` 后，同时配置 `tidb_slow_log_max_per_sec`，以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 +* [tidb_slow_log_max_per_sec](/system-variables.md#tidb_slow_log_max_per_sec)：设置控制每秒打印慢日志的上限，默认值为 0。 + * 当值为 0，其表示不限制每秒打印的慢日志数量。 + * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢日志，超过部分将被丢弃，不会写入慢日志文件。 + * 建议在启用了 tidb_slow_log_rules 后配置该变量，以防规则触发频繁打印慢日志。 * [tidb_query_log_max_len](/system-variables.md#tidb_query_log_max_len)：设置慢日志记录 SQL 语句的最大长度。默认值是 4096 byte。 * [tidb_redact_log](/system-variables.md#tidb_redact_log)：设置慢日志记录 SQL 时是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 * [tidb_enable_collect_execution_info](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： diff --git a/system-variables.md b/system-variables.md index 93952c7a0e45..5e28ff0afc56 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5072,6 +5072,28 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 单位：毫秒 - 输出慢日志的耗时阈值，默认为 300 ms。如果查询耗时大于这个值，会视作一个慢查询，并记录到慢查询日志。注意，当日志的输出级别 [`log.level`](/tidb-configuration-file.md#level) 是 `"debug"` 时，所有查询都会记录到慢日志，不受该变量的限制。 +### `tidb_slow_log_rules` + +- 作用域：SESSION | GLOBAL +- 是否持久化到集群：是 +- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制：否 +- 默认值："" +- 类型：字符串 +- 用于定义慢日志的触发规则，支持基于多维度指标的组合条件，实现更加灵活和精细化的日志记录控制。 +> **注意:** +> +> 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec) 以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 + +### `tidb_slow_log_max_per_sec` + +- 作用域：GLOBAL +- 是否持久化到集群：是 +- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制：否 +- 默认值：`0` +- 类型：整数型 +- 范围：`[0, 1000000]` +- 控制每秒打印慢日志每秒的次数上限，默认值 0。当该变量值为 0 时，则表示不限制每秒打印的慢日志数量。当该变量值大于 0 时，TiDB 会限制每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 结合使用，以防止在高负载情况下产生过多的慢日志。 + ### `tidb_slow_query_file` - 作用域：SESSION From a16078e6cd3a8eb8dbf40db45e7224f353f380b5 Mon Sep 17 00:00:00 2001 From: Lynn Date: Wed, 22 Oct 2025 17:28:29 +0800 Subject: [PATCH 02/42] *: add WRITE_SLOW_LOG hint --- identify-slow-queries.md | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 1272c0291808..c76cecc784b5 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -173,7 +173,21 @@ Slow Query 基础信息： - `Storage_from_kv`：从 v9.0.0 开始引入，表示该语句是否从 TiKV 读取数据。 - `Storage_from_mpp`：从 v9.0.0 开始引入，表示该语句是否从 TiFlash 读取数据。 -## 相关系统变量 +## 相关变量 + +### 相关 Hint + +通过 Hit `WRITE_SLOW_LOG` 强制控制输出慢日志。 +- 不受任何阈值或触发规则限制，即无论该 SQL 是否达到慢日志打印阈值，都会打印慢日志。 +- 暂不支持强制关闭打印慢日志的方式（如 `WRITE_SLOW_LOG(FALSE)`）。 + +使用示例： +```sql +SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; +``` + +### 相关系统变量 + * [tidb_slow_log_threshold](/system-variables.md#tidb_slow_log_threshold)：设置慢日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 * [tidb_slow_log_rules](/system-variables.md#tidb_slow_log_rules)：用于定义慢日志的触发规则，支持多维度指标组合条件，实现更加灵活和精细化的日志记录控制。此变量在新版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 * 未设置 tidb_slow_log_rules @@ -199,18 +213,18 @@ Slow Query 基础信息： * [tidb_redact_log](/system-variables.md#tidb_redact_log)：设置慢日志记录 SQL 时是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 * [tidb_enable_collect_execution_info](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： -```sql -> select tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMgk1BWM2zwAAMRnIADcVyAAxHcEQNQlOL0EBBPBbCjMJMTNfMTYJMQkzMTI4MS44NTc4MTk5MDUyMTcJdGFibGU6dCwgaW5kZXg6aWR4KGEpLCByYW5nZTpbLWluZiw1MDAwMCksIGtlZXAgb3JkZXI6ZmFsc2UJMjUBrgnQVnsA'); -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMg | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| id task estRows operator info actRows execution info memory disk | -| StreamAgg_17 root 1 funcs:count(Column#7)->Column#5 1 time:10.931505ms, loops:2 372 Bytes N/A | -| └─IndexReader_18 root 1 index:StreamAgg_9 1 time:10.927685ms, loops:2, rpc num: 1, rpc time:10.884355ms, proc keys:25007 206 Bytes N/A | -| └─StreamAgg_9 cop 1 funcs:count(1)->Column#7 1 time:11ms, loops:25 N/A N/A | -| └─IndexScan_16 cop 31281.857819905217 table:t, index:idx(a), range:[-inf,50000), keep order:false 25007 time:11ms, loops:25 N/A N/A | -+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -``` + ```sql + > select tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMgk1BWM2zwAAMRnIADcVyAAxHcEQNQlOL0EBBPBbCjMJMTNfMTYJMQkzMTI4MS44NTc4MTk5MDUyMTcJdGFibGU6dCwgaW5kZXg6aWR4KGEpLCByYW5nZTpbLWluZiw1MDAwMCksIGtlZXAgb3JkZXI6ZmFsc2UJMjUBrgnQVnsA'); + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMg | + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id task estRows operator info actRows execution info memory disk | + | StreamAgg_17 root 1 funcs:count(Column#7)->Column#5 1 time:10.931505ms, loops:2 372 Bytes N/A | + | └─IndexReader_18 root 1 index:StreamAgg_9 1 time:10.927685ms, loops:2, rpc num: 1, rpc time:10.884355ms, proc keys:25007 206 Bytes N/A | + | └─StreamAgg_9 cop 1 funcs:count(1)->Column#7 1 time:11ms, loops:25 N/A N/A | + | └─IndexScan_16 cop 31281.857819905217 table:t, index:idx(a), range:[-inf,50000), keep order:false 25007 time:11ms, loops:25 N/A N/A | + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + ``` 在性能测试中可以关闭自动收集算子的执行信息： From 437be1b32cb5369b8da54ab40831ebe8a73f6b0f Mon Sep 17 00:00:00 2001 From: Lynn Date: Wed, 19 Nov 2025 10:30:31 +0800 Subject: [PATCH 03/42] *: add test info and tiny update --- identify-slow-queries.md | 32 +++++++++++++++++--------------- system-variables.md | 1 + 2 files changed, 18 insertions(+), 15 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index c76cecc784b5..dcf7bf67f6a4 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -178,10 +178,12 @@ Slow Query 基础信息： ### 相关 Hint 通过 Hit `WRITE_SLOW_LOG` 强制控制输出慢日志。 + - 不受任何阈值或触发规则限制，即无论该 SQL 是否达到慢日志打印阈值，都会打印慢日志。 - 暂不支持强制关闭打印慢日志的方式（如 `WRITE_SLOW_LOG(FALSE)`）。 使用示例： + ```sql SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ``` @@ -190,25 +192,25 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * [tidb_slow_log_threshold](/system-variables.md#tidb_slow_log_threshold)：设置慢日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 * [tidb_slow_log_rules](/system-variables.md#tidb_slow_log_rules)：用于定义慢日志的触发规则，支持多维度指标组合条件，实现更加灵活和精细化的日志记录控制。此变量在新版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 - * 未设置 tidb_slow_log_rules - * 慢日志触发仍依赖 tidb_slow_log_threshold，Query_time 阈值取自该变量，以保持向后兼容。 - * 已设置 tidb_slow_log_rules - * 配置的规则优先生效，tidb_slow_log_threshold 将被忽略。 - * 若希望规则中仍包含 Query_time 的触发条件，可在设置规则时指定。 - * 规则匹配逻辑（多条规则之间采用 OR 关系）： - * Session 作用域规则：优先匹配，如果匹配成功，则打印慢日志。 - * Global 作用域规则：仅在 Session 规则未匹配时考虑： - * 若规则指定 ConnID 并与当前 Session 的 ConnID 匹配，则使用该规则。 - * 若规则未指定 ConnID（全局通用规则），则使用该规则。 - * 显示变量的行为与普通系统变量一致。 + * 未设置 tidb_slow_log_rules + * 慢日志触发仍依赖 tidb_slow_log_threshold，Query_time 阈值取自该变量，以保持向后兼容。 + * 已设置 tidb_slow_log_rules + * 配置的规则优先生效，tidb_slow_log_threshold 将被忽略。 + * 若希望规则中仍包含 Query_time 的触发条件，可在设置规则时指定。 + * 规则匹配逻辑（多条规则之间采用 OR 关系）： + * Session 作用域规则：优先匹配，如果匹配成功，则打印慢日志。 + * Global 作用域规则：仅在 Session 规则未匹配时考虑： + * 若规则指定 ConnID 并与当前 Session 的 ConnID 匹配，则使用该规则。 + * 若规则未指定 ConnID（全局通用规则），则使用该规则。 + * 显示变量的行为与普通系统变量一致。 > > 说明：`tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢日志控制，支持多维度指标组合条件。 > - > 建议：在启用 `tidb_slow_log_rules` 后，同时配置 `tidb_slow_log_max_per_sec`，以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 + > 建议：在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢日志规则生成的慢日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 * [tidb_slow_log_max_per_sec](/system-variables.md#tidb_slow_log_max_per_sec)：设置控制每秒打印慢日志的上限，默认值为 0。 - * 当值为 0，其表示不限制每秒打印的慢日志数量。 - * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢日志，超过部分将被丢弃，不会写入慢日志文件。 - * 建议在启用了 tidb_slow_log_rules 后配置该变量，以防规则触发频繁打印慢日志。 + * 当值为 0，其表示不限制每秒打印的慢日志数量。 + * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢日志，超过部分将被丢弃，不会写入慢日志文件。 + * 建议在启用了 tidb_slow_log_rules 后配置该变量，以防规则触发频繁打印慢日志。 * [tidb_query_log_max_len](/system-variables.md#tidb_query_log_max_len)：设置慢日志记录 SQL 语句的最大长度。默认值是 4096 byte。 * [tidb_redact_log](/system-variables.md#tidb_redact_log)：设置慢日志记录 SQL 时是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 * [tidb_enable_collect_execution_info](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： diff --git a/system-variables.md b/system-variables.md index 5e28ff0afc56..acfe58b1a5ab 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5080,6 +5080,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值："" - 类型：字符串 - 用于定义慢日志的触发规则，支持基于多维度指标的组合条件，实现更加灵活和精细化的日志记录控制。 + > **注意:** > > 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec) 以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 From dd348f43c0deefaba09d3460e26c1478fb65363e Mon Sep 17 00:00:00 2001 From: Lynn Date: Thu, 20 Nov 2025 16:43:06 +0800 Subject: [PATCH 04/42] *: address a comment --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index acfe58b1a5ab..1e82f83bd3f2 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5093,7 +5093,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值：`0` - 类型：整数型 - 范围：`[0, 1000000]` -- 控制每秒打印慢日志每秒的次数上限，默认值 0。当该变量值为 0 时，则表示不限制每秒打印的慢日志数量。当该变量值大于 0 时，TiDB 会限制每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 结合使用，以防止在高负载情况下产生过多的慢日志。 +- 控制每个 TiDB 每秒打印慢日志的次数上限，默认值 0。当该变量值为 0 时，则表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 0 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 结合使用，以防止在高负载情况下产生过多的慢日志。 ### `tidb_slow_query_file` From f528b62251989632c4201133618eb4d2c4752fe9 Mon Sep 17 00:00:00 2001 From: Lynn Date: Fri, 21 Nov 2025 09:56:15 +0800 Subject: [PATCH 05/42] *: add version --- identify-slow-queries.md | 2 +- system-variables.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index dcf7bf67f6a4..0c885952a552 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -191,7 +191,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ### 相关系统变量 * [tidb_slow_log_threshold](/system-variables.md#tidb_slow_log_threshold)：设置慢日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 -* [tidb_slow_log_rules](/system-variables.md#tidb_slow_log_rules)：用于定义慢日志的触发规则，支持多维度指标组合条件，实现更加灵活和精细化的日志记录控制。此变量在新版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 +* [tidb_slow_log_rules](/system-variables.md#tidb_slow_log_rules)：用于定义慢日志的触发规则，支持多维度指标组合条件，实现更加灵活和精细化的日志记录控制。此变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 * 未设置 tidb_slow_log_rules * 慢日志触发仍依赖 tidb_slow_log_threshold，Query_time 阈值取自该变量，以保持向后兼容。 * 已设置 tidb_slow_log_rules diff --git a/system-variables.md b/system-variables.md index 1e82f83bd3f2..0c37eae6ada0 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5072,7 +5072,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 单位：毫秒 - 输出慢日志的耗时阈值，默认为 300 ms。如果查询耗时大于这个值，会视作一个慢查询，并记录到慢查询日志。注意，当日志的输出级别 [`log.level`](/tidb-configuration-file.md#level) 是 `"debug"` 时，所有查询都会记录到慢日志，不受该变量的限制。 -### `tidb_slow_log_rules` +### `tidb_slow_log_rules` 从 v9.0.0 版本开始引入 - 作用域：SESSION | GLOBAL - 是否持久化到集群：是 @@ -5085,7 +5085,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) > > 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec) 以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 -### `tidb_slow_log_max_per_sec` +### `tidb_slow_log_max_per_sec` 从 v9.0.0 版本开始引入 - 作用域：GLOBAL - 是否持久化到集群：是 From 25f85db90ae5f6c90f25c5676ee3d7502b63c8d7 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Thu, 4 Dec 2025 18:25:55 +0800 Subject: [PATCH 06/42] Update format --- identify-slow-queries.md | 49 ++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 0c885952a552..fb659e9acfab 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -190,11 +190,11 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ### 相关系统变量 -* [tidb_slow_log_threshold](/system-variables.md#tidb_slow_log_threshold)：设置慢日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 -* [tidb_slow_log_rules](/system-variables.md#tidb_slow_log_rules)：用于定义慢日志的触发规则，支持多维度指标组合条件，实现更加灵活和精细化的日志记录控制。此变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 - * 未设置 tidb_slow_log_rules +* [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 +* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，实现更加灵活和精细化的日志记录控制。此变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 + * 未设置 `tidb_slow_log_rules`： * 慢日志触发仍依赖 tidb_slow_log_threshold，Query_time 阈值取自该变量，以保持向后兼容。 - * 已设置 tidb_slow_log_rules + * 已设置 `tidb_slow_log_rules`： * 配置的规则优先生效，tidb_slow_log_threshold 将被忽略。 * 若希望规则中仍包含 Query_time 的触发条件，可在设置规则时指定。 * 规则匹配逻辑（多条规则之间采用 OR 关系）： @@ -203,30 +203,31 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * 若规则指定 ConnID 并与当前 Session 的 ConnID 匹配，则使用该规则。 * 若规则未指定 ConnID（全局通用规则），则使用该规则。 * 显示变量的行为与普通系统变量一致。 + + > 说明：`tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 > - > 说明：`tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢日志控制，支持多维度指标组合条件。 - > - > 建议：在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢日志规则生成的慢日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 + > 建议：在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 + * [tidb_slow_log_max_per_sec](/system-variables.md#tidb_slow_log_max_per_sec)：设置控制每秒打印慢日志的上限，默认值为 0。 * 当值为 0，其表示不限制每秒打印的慢日志数量。 - * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢日志，超过部分将被丢弃，不会写入慢日志文件。 + * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢日志文件。 * 建议在启用了 tidb_slow_log_rules 后配置该变量，以防规则触发频繁打印慢日志。 -* [tidb_query_log_max_len](/system-variables.md#tidb_query_log_max_len)：设置慢日志记录 SQL 语句的最大长度。默认值是 4096 byte。 -* [tidb_redact_log](/system-variables.md#tidb_redact_log)：设置慢日志记录 SQL 时是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 -* [tidb_enable_collect_execution_info](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： - - ```sql - > select tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMgk1BWM2zwAAMRnIADcVyAAxHcEQNQlOL0EBBPBbCjMJMTNfMTYJMQkzMTI4MS44NTc4MTk5MDUyMTcJdGFibGU6dCwgaW5kZXg6aWR4KGEpLCByYW5nZTpbLWluZiw1MDAwMCksIGtlZXAgb3JkZXI6ZmFsc2UJMjUBrgnQVnsA'); - +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMg | - +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id task estRows operator info actRows execution info memory disk | - | StreamAgg_17 root 1 funcs:count(Column#7)->Column#5 1 time:10.931505ms, loops:2 372 Bytes N/A | - | └─IndexReader_18 root 1 index:StreamAgg_9 1 time:10.927685ms, loops:2, rpc num: 1, rpc time:10.884355ms, proc keys:25007 206 Bytes N/A | - | └─StreamAgg_9 cop 1 funcs:count(1)->Column#7 1 time:11ms, loops:25 N/A N/A | - | └─IndexScan_16 cop 31281.857819905217 table:t, index:idx(a), range:[-inf,50000), keep order:false 25007 time:11ms, loops:25 N/A N/A | - +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - ``` +* [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 +* [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 +* [`tidb_enable_collect_execution_info`](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： + + ```sql + > select tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMgk1BWM2zwAAMRnIADcVyAAxHcEQNQlOL0EBBPBbCjMJMTNfMTYJMQkzMTI4MS44NTc4MTk5MDUyMTcJdGFibGU6dCwgaW5kZXg6aWR4KGEpLCByYW5nZTpbLWluZiw1MDAwMCksIGtlZXAgb3JkZXI6ZmFsc2UJMjUBrgnQVnsA'); + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMg | + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id task estRows operator info actRows execution info memory disk | + | StreamAgg_17 root 1 funcs:count(Column#7)->Column#5 1 time:10.931505ms, loops:2 372 Bytes N/A | + | └─IndexReader_18 root 1 index:StreamAgg_9 1 time:10.927685ms, loops:2, rpc num: 1, rpc time:10.884355ms, proc keys:25007 206 Bytes N/A | + | └─StreamAgg_9 cop 1 funcs:count(1)->Column#7 1 time:11ms, loops:25 N/A N/A | + | └─IndexScan_16 cop 31281.857819905217 table:t, index:idx(a), range:[-inf,50000), keep order:false 25007 time:11ms, loops:25 N/A N/A | + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + ``` 在性能测试中可以关闭自动收集算子的执行信息： From 4c7c4baea9fdbeab6b7366517cd82e31408c505d Mon Sep 17 00:00:00 2001 From: lilin90 Date: Thu, 4 Dec 2025 18:38:02 +0800 Subject: [PATCH 07/42] Refine wording and format --- identify-slow-queries.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index fb659e9acfab..5a4736ed45e8 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -190,26 +190,27 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ### 相关系统变量 -* [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 -* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，实现更加灵活和精细化的日志记录控制。此变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 - * 未设置 `tidb_slow_log_rules`： - * 慢日志触发仍依赖 tidb_slow_log_threshold，Query_time 阈值取自该变量，以保持向后兼容。 - * 已设置 `tidb_slow_log_rules`： - * 配置的规则优先生效，tidb_slow_log_threshold 将被忽略。 - * 若希望规则中仍包含 Query_time 的触发条件，可在设置规则时指定。 +* [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：用于设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 +* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 + * 如果未设置 `tidb_slow_log_rules`： + * 慢日志触发仍依赖 `tidb_slow_log_threshold`，`query_time` 阈值取自该变量，以保持向后兼容。 + * 如果已设置 `tidb_slow_log_rules`： + * 配置的规则优先生效，`tidb_slow_log_threshold` 将被忽略。 + * 若希望规则中仍包含 `query_time` 的触发条件，可在设置规则时指定。 * 规则匹配逻辑（多条规则之间采用 OR 关系）： * Session 作用域规则：优先匹配，如果匹配成功，则打印慢日志。 * Global 作用域规则：仅在 Session 规则未匹配时考虑： - * 若规则指定 ConnID 并与当前 Session 的 ConnID 匹配，则使用该规则。 - * 若规则未指定 ConnID（全局通用规则），则使用该规则。 + * 若规则指定 `ConnID` 并与当前 Session 的 `ConnID` 匹配，则使用该规则。 + * 若规则未指定 `ConnID`（全局通用规则），则使用该规则。 * 显示变量的行为与普通系统变量一致。 - > 说明：`tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 + > **Tip** > - > 建议：在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 + > - `tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 + > - 在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 -* [tidb_slow_log_max_per_sec](/system-variables.md#tidb_slow_log_max_per_sec)：设置控制每秒打印慢日志的上限，默认值为 0。 - * 当值为 0，其表示不限制每秒打印的慢日志数量。 +* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec)：用于设置控制每秒打印慢日志的上限，默认值为 0。 + * 当值为 0 时，表示不限制每秒打印的慢日志数量。 * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢日志文件。 * 建议在启用了 tidb_slow_log_rules 后配置该变量，以防规则触发频繁打印慢日志。 * [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 From 50b79fcbbe08e2d9fea44accaebf75d1511c8514 Mon Sep 17 00:00:00 2001 From: Lynn Date: Fri, 5 Dec 2025 12:12:55 +0800 Subject: [PATCH 08/42] *: address comments --- identify-slow-queries.md | 12 +++++++----- system-variables.md | 2 +- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 5a4736ed45e8..fafa68f6fc09 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -175,12 +175,14 @@ Slow Query 基础信息： ## 相关变量 +本节介绍慢查询日志相关的 Hint 与系统变量。 + ### 相关 Hint -通过 Hit `WRITE_SLOW_LOG` 强制控制输出慢日志。 +你可以通过 Hint `WRITE_SLOW_LOG` 强制控制输出慢查询日志。 -- 不受任何阈值或触发规则限制，即无论该 SQL 是否达到慢日志打印阈值，都会打印慢日志。 -- 暂不支持强制关闭打印慢日志的方式（如 `WRITE_SLOW_LOG(FALSE)`）。 +- 该 Hint 不受任何阈值或触发规则限制，即无论该 SQL 查询是否达到慢查询日志打印阈值，都会打印慢查询日志。 +- 目前只支持强制开启打印慢查询日志，暂不支持通过 `WRITE_SLOW_LOG(FALSE)`）强制关闭打印慢查询日志。 使用示例： @@ -209,10 +211,10 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; > - `tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 > - 在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 -* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec)：用于设置控制每秒打印慢日志的上限，默认值为 0。 +* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec)：用于设置每秒打印慢日志的上限，默认值为 0。 * 当值为 0 时，表示不限制每秒打印的慢日志数量。 * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢日志文件。 - * 建议在启用了 tidb_slow_log_rules 后配置该变量，以防规则触发频繁打印慢日志。 + * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以防规则触发频繁打印慢日志。 * [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 * [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 * [`tidb_enable_collect_execution_info`](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： diff --git a/system-variables.md b/system-variables.md index 0c37eae6ada0..9e37e162336c 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5093,7 +5093,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值：`0` - 类型：整数型 - 范围：`[0, 1000000]` -- 控制每个 TiDB 每秒打印慢日志的次数上限，默认值 0。当该变量值为 0 时，则表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 0 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 结合使用，以防止在高负载情况下产生过多的慢日志。 +- 控制每个 TiDB 每秒打印慢日志的次数上限，默认值 0。当该变量值为 0 时，表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 0 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 结合使用，以防止在高负载情况下产生过多的慢日志。 ### `tidb_slow_query_file` From 8af6f4bf2e139d8388e6effb1e0932b3c69f80e8 Mon Sep 17 00:00:00 2001 From: Lynn Date: Fri, 5 Dec 2025 13:12:24 +0800 Subject: [PATCH 09/42] *: tiny update --- identify-slow-queries.md | 4 ++-- system-variables.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index fafa68f6fc09..9bbb236f1e1c 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -193,7 +193,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ### 相关系统变量 * [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：用于设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 -* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 +* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 * 如果未设置 `tidb_slow_log_rules`： * 慢日志触发仍依赖 `tidb_slow_log_threshold`，`query_time` 阈值取自该变量，以保持向后兼容。 * 如果已设置 `tidb_slow_log_rules`： @@ -211,7 +211,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; > - `tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 > - 在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 -* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec)：用于设置每秒打印慢日志的上限，默认值为 0。 +* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢日志的上限，默认值为 0。 * 当值为 0 时，表示不限制每秒打印的慢日志数量。 * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢日志文件。 * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以防规则触发频繁打印慢日志。 diff --git a/system-variables.md b/system-variables.md index 9e37e162336c..c030702790d0 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5083,7 +5083,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) > **注意:** > -> 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec) 以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 +> 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入) 以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 ### `tidb_slow_log_max_per_sec` 从 v9.0.0 版本开始引入 @@ -5093,7 +5093,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值：`0` - 类型：整数型 - 范围：`[0, 1000000]` -- 控制每个 TiDB 每秒打印慢日志的次数上限，默认值 0。当该变量值为 0 时，表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 0 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules) 结合使用，以防止在高负载情况下产生过多的慢日志。 +- 控制每个 TiDB 每秒打印慢日志的次数上限，默认值 0。当该变量值为 0 时，表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 0 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢日志。 ### `tidb_slow_query_file` From 96b65b7c9dfe5998940d93575be3ab794e68aeea Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 9 Dec 2025 19:41:18 +0800 Subject: [PATCH 10/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 9bbb236f1e1c..a2528f22dc4f 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -182,7 +182,7 @@ Slow Query 基础信息： 你可以通过 Hint `WRITE_SLOW_LOG` 强制控制输出慢查询日志。 - 该 Hint 不受任何阈值或触发规则限制，即无论该 SQL 查询是否达到慢查询日志打印阈值，都会打印慢查询日志。 -- 目前只支持强制开启打印慢查询日志，暂不支持通过 `WRITE_SLOW_LOG(FALSE)`）强制关闭打印慢查询日志。 +- 目前只支持强制开启打印慢查询日志，暂不支持通过 `WRITE_SLOW_LOG(FALSE)` 强制关闭打印慢查询日志。 使用示例： From 77c14f9f0c8e796e8925d2f4550a518218f68b59 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 9 Dec 2025 19:41:35 +0800 Subject: [PATCH 11/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index a2528f22dc4f..b27b0be777f0 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -202,7 +202,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * 规则匹配逻辑（多条规则之间采用 OR 关系）： * Session 作用域规则：优先匹配，如果匹配成功，则打印慢日志。 * Global 作用域规则：仅在 Session 规则未匹配时考虑： - * 若规则指定 `ConnID` 并与当前 Session 的 `ConnID` 匹配，则使用该规则。 + * 若规则指定了 `ConnID` 并与当前 Session 的 `ConnID` 匹配，则使用该规则。 * 若规则未指定 `ConnID`（全局通用规则），则使用该规则。 * 显示变量的行为与普通系统变量一致。 From b869a2daf058fa274cbe89854fbc92f8a50078e4 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 9 Dec 2025 19:41:53 +0800 Subject: [PATCH 12/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index b27b0be777f0..1cab83cf2d83 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -214,7 +214,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢日志的上限，默认值为 0。 * 当值为 0 时，表示不限制每秒打印的慢日志数量。 * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢日志文件。 - * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以防规则触发频繁打印慢日志。 + * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以避免规则触发频繁打印慢日志。 * [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 * [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 * [`tidb_enable_collect_execution_info`](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： From 71b66b4835d9f0351c07b602a06c82e4c3e10dcc Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 9 Dec 2025 19:42:08 +0800 Subject: [PATCH 13/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 1cab83cf2d83..205664367f2a 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -216,7 +216,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢日志文件。 * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以避免规则触发频繁打印慢日志。 * [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 -* [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 +* [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时，是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 * [`tidb_enable_collect_execution_info`](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： ```sql From 9182b357a9f21b5bb5b565f64876a94e01fdc2c2 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 9 Dec 2025 19:43:37 +0800 Subject: [PATCH 14/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 205664367f2a..1440e1aa691e 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -217,7 +217,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以避免规则触发频繁打印慢日志。 * [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 * [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时，是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 -* [`tidb_enable_collect_execution_info`](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。该功能对性能的影响约为 3%。开启该项后查看 `Plan` 的示例如下： +* [`tidb_enable_collect_execution_info`](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。开启该功能会导致性能降低约 3%。开启后查看 `Plan` 的示例如下： ```sql > select tidb_decode_plan('jAOIMAk1XzE3CTAJMQlmdW5jczpjb3VudChDb2x1bW4jNyktPkMJC/BMNQkxCXRpbWU6MTAuOTMxNTA1bXMsIGxvb3BzOjIJMzcyIEJ5dGVzCU4vQQoxCTMyXzE4CTAJMQlpbmRleDpTdHJlYW1BZ2dfOQkxCXQRSAwyNzY4LkgALCwgcnBjIG51bTogMQkMEXMQODg0MzUFK0hwcm9jIGtleXM6MjUwMDcJMjA2HXsIMgk1BWM2zwAAMRnIADcVyAAxHcEQNQlOL0EBBPBbCjMJMTNfMTYJMQkzMTI4MS44NTc4MTk5MDUyMTcJdGFibGU6dCwgaW5kZXg6aWR4KGEpLCByYW5nZTpbLWluZiw1MDAwMCksIGtlZXAgb3JkZXI6ZmFsc2UJMjUBrgnQVnsA'); From ea7dc9de9ba0132b29af8a8d74a68cb64664b04a Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 9 Dec 2025 19:43:47 +0800 Subject: [PATCH 15/42] Update system-variables.md Co-authored-by: Lilian Lee --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index c030702790d0..8e055a71e4f1 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5081,7 +5081,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 类型：字符串 - 用于定义慢日志的触发规则，支持基于多维度指标的组合条件，实现更加灵活和精细化的日志记录控制。 -> **注意:** +> **注意** > > 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入) 以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 From 928175940f9f4d8dcdce31b34db5cb4f1566994f Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 9 Dec 2025 19:44:01 +0800 Subject: [PATCH 16/42] Update system-variables.md Co-authored-by: Lilian Lee --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index 8e055a71e4f1..deadfa7f089f 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5083,7 +5083,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) > **注意** > -> 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入) 以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 +> 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 ### `tidb_slow_log_max_per_sec` 从 v9.0.0 版本开始引入 From 58601e5e7f91dd85f1f4438cf853c5483cc350e7 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 9 Dec 2025 19:44:19 +0800 Subject: [PATCH 17/42] Update system-variables.md Co-authored-by: Lilian Lee --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index deadfa7f089f..cc0b651daa21 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5093,7 +5093,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值：`0` - 类型：整数型 - 范围：`[0, 1000000]` -- 控制每个 TiDB 每秒打印慢日志的次数上限，默认值 0。当该变量值为 0 时，表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 0 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢日志。 +- 控制每个 TiDB 节点每秒打印慢日志的次数上限，默认值为 `0`。当该变量值为 `0` 时，表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 `0` 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢日志。 ### `tidb_slow_query_file` From bbc0b1880a1a6bfea29bcf343dbca1fb9f026627 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 10 Dec 2025 11:05:23 +0800 Subject: [PATCH 18/42] Update wording for consistency --- identify-slow-queries.md | 54 +++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 29 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 1440e1aa691e..3e9c17d11efa 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -59,7 +59,7 @@ Slow Query 基础信息： * `Compile_time`：表示这个语句在查询优化阶段花费的时间。 * `Optimize_time`：表示这个语句在优化查询计划阶段花费的时间。 * `Wait_TS`：表示这个语句在等待获取事务 TS 阶段花费的时间。 -* `Query`：表示 SQL 语句。慢日志里面不会打印 `Query`，但映射到内存表后，对应的字段叫 `Query`。 +* `Query`：表示 SQL 语句。慢查询日志里面不会打印 `Query`，但映射到内存表后，对应的字段叫 `Query`。 * `Digest`：表示 SQL 语句的指纹。 * `Txn_start_ts`：表示事务的开始时间戳，也是事务的唯一 ID，可以用这个值在 TiDB 日志中查找事务相关的其他日志。 * `Is_internal`：表示是否为 TiDB 内部的 SQL 语句。`true` 表示 TiDB 系统内部执行的 SQL 语句，`false` 表示用户执行的 SQL 语句。 @@ -173,11 +173,7 @@ Slow Query 基础信息： - `Storage_from_kv`：从 v9.0.0 开始引入，表示该语句是否从 TiKV 读取数据。 - `Storage_from_mpp`：从 v9.0.0 开始引入，表示该语句是否从 TiFlash 读取数据。 -## 相关变量 - -本节介绍慢查询日志相关的 Hint 与系统变量。 - -### 相关 Hint +## 相关 Hint 你可以通过 Hint `WRITE_SLOW_LOG` 强制控制输出慢查询日志。 @@ -190,31 +186,31 @@ Slow Query 基础信息： SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ``` -### 相关系统变量 +## 相关系统变量 -* [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：用于设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢日志中。默认值是 300 ms。 +* [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：用于设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢查询日志中。默认值是 300 ms。 * [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 * 如果未设置 `tidb_slow_log_rules`： - * 慢日志触发仍依赖 `tidb_slow_log_threshold`，`query_time` 阈值取自该变量，以保持向后兼容。 + * 慢查询日志触发仍依赖 `tidb_slow_log_threshold`，`query_time` 阈值取自该变量，以保持向后兼容。 * 如果已设置 `tidb_slow_log_rules`： * 配置的规则优先生效，`tidb_slow_log_threshold` 将被忽略。 * 若希望规则中仍包含 `query_time` 的触发条件，可在设置规则时指定。 * 规则匹配逻辑（多条规则之间采用 OR 关系）： - * Session 作用域规则：优先匹配，如果匹配成功，则打印慢日志。 + * Session 作用域规则：优先匹配，如果匹配成功，则打印慢查询日志。 * Global 作用域规则：仅在 Session 规则未匹配时考虑： * 若规则指定了 `ConnID` 并与当前 Session 的 `ConnID` 匹配，则使用该规则。 * 若规则未指定 `ConnID`（全局通用规则），则使用该规则。 * 显示变量的行为与普通系统变量一致。 - > **Tip** - > - > - `tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 - > - 在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 + > **Tip** + > + > - `tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 + > - 在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 -* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢日志的上限，默认值为 0。 - * 当值为 0 时，表示不限制每秒打印的慢日志数量。 - * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢日志文件。 - * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以避免规则触发频繁打印慢日志。 +* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢查询日志的上限，默认值为 0。 + * 当值为 0 时，表示不限制每秒打印的慢查询日志数量。 + * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢查询日志文件。 + * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以避免规则触发频繁打印慢查询日志。 * [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 * [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时，是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 * [`tidb_enable_collect_execution_info`](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。开启该功能会导致性能降低约 3%。开启后查看 `Plan` 的示例如下： @@ -244,17 +240,17 @@ set @@tidb_enable_collect_execution_info=0; 更多详细信息，可以参见 [TiDB 专用系统变量和语法](/system-variables.md)。 -## 慢日志内存映射表 +## 慢查询日志内存映射表 -用户可通过查询 `INFORMATION_SCHEMA.SLOW_QUERY` 表来查询慢查询日志中的内容，表中列名和慢日志中字段名一一对应，表结构可查看 [`SLOW_QUERY` 表](/information-schema/information-schema-slow-query.md)中的介绍。 +用户可通过查询 `INFORMATION_SCHEMA.SLOW_QUERY` 表来查询慢查询日志中的内容，表中列名和慢查询日志中字段名一一对应，表结构可查看 [`SLOW_QUERY` 表](/information-schema/information-schema-slow-query.md)中的介绍。 > **注意：** > > 每次查询 `SLOW_QUERY` 表时，TiDB 都会去读取和解析一次当前的慢查询日志。 -TiDB 4.0 中，`SLOW_QUERY` 已经支持查询任意时间段的慢日志，即支持查询已经被 rotate 的慢日志文件的数据。用户查询时只需要指定 `TIME` 时间范围即可定位需要解析的慢日志文件。如果查询不指定时间范围，则仍然只解析当前的慢日志文件，示例如下： +TiDB 4.0 中，`SLOW_QUERY` 已经支持查询任意时间段的慢查询日志，即支持查询已经被 rotate 的慢查询日志文件的数据。用户查询时只需要指定 `TIME` 时间范围即可定位需要解析的慢查询日志文件。如果查询不指定时间范围，则仍然只解析当前的慢查询日志文件，示例如下： -不指定时间范围时，只会解析当前 TiDB 正在写入的慢日志文件的慢查询数据： +不指定时间范围时，只会解析当前 TiDB 正在写入的慢查询日志文件的慢查询数据： {{< copyable "sql" >}} @@ -273,7 +269,7 @@ from slow_query; +----------+----------------------------+----------------------------+ ``` -指定查询 `2020-03-10 00:00:00` 到 `2020-03-11 00:00:00` 时间范围后，会定位指定时间范围内的慢日志文件后解析慢查询数据： +指定查询 `2020-03-10 00:00:00` 到 `2020-03-11 00:00:00` 时间范围后，会定位指定时间范围内的慢查询日志文件后解析慢查询数据： {{< copyable "sql" >}} @@ -296,7 +292,7 @@ where time > '2020-03-10 00:00:00' > **注意：** > -> 如果指定时间范围内的慢日志文件被删除，或者并没有慢查询，则查询结果会返回空。 +> 如果指定时间范围内的慢查询日志文件被删除，或者并没有慢查询，则查询结果会返回空。 TiDB 4.0 中新增了 [`CLUSTER_SLOW_QUERY`](/information-schema/information-schema-slow-query.md#cluster_slow_query-table) 系统表，用来查询所有 TiDB 节点的慢查询信息，表结构在 `SLOW_QUERY` 的基础上多增加了 `INSTANCE` 列，表示该行慢查询信息来自的 TiDB 节点地址。使用方式和 [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) 系统表一样。 @@ -507,9 +503,9 @@ select instance, count(*) from information_schema.cluster_slow_query where time +---------------+----------+ ``` -### 查询仅出现在异常时间段的慢日志 +### 查询仅出现在异常时间段的慢查询日志 -假如发现 `2020-03-10 13:24:00` ~ `2020-03-10 13:27:00` 的 QPS 降低或者延迟上升等问题，可能是由于突然出现大查询导致的，可以用下面 SQL 查询仅出现在异常时间段的慢日志，其中 `2020-03-10 13:20:00` ~ `2020-03-10 13:23:00` 为正常时间段。 +假如发现 `2020-03-10 13:24:00` ~ `2020-03-10 13:27:00` 的 QPS 降低或者延迟上升等问题，可能是由于突然出现大查询导致的，可以用下面 SQL 查询仅出现在异常时间段的慢查询日志，其中 `2020-03-10 13:20:00` ~ `2020-03-10 13:23:00` 为正常时间段。 {{< copyable "sql" >}} @@ -560,7 +556,7 @@ min(prev_stmt) | digest | 24bd6d8a9b238086c9b8c3d240ad4ef32f79ce94cf5a468c0b8fe1eb5f8d03df ``` -## 解析其他的 TiDB 慢日志文件 +## 解析其他的 TiDB 慢查询日志文件 TiDB 通过 session 变量 `tidb_slow_query_file` 控制查询 `INFORMATION_SCHEMA.SLOW_QUERY` 时要读取和解析的文件，可通过修改改 session 变量的值来查询其他慢查询日志文件的内容： @@ -570,9 +566,9 @@ TiDB 通过 session 变量 `tidb_slow_query_file` 控制查询 `INFORMATION_SCHE set tidb_slow_query_file = "/path-to-log/tidb-slow.log" ``` -## 用 `pt-query-digest` 工具分析 TiDB 慢日志 +## 用 `pt-query-digest` 工具分析 TiDB 慢查询日志 -可以用 `pt-query-digest` 工具分析 TiDB 慢日志。 +可以用 `pt-query-digest` 工具分析 TiDB 慢查询日志。 > **注意：** > From 3c2e2743cf673ec3998a68c7b44cec94d811d290 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 10 Dec 2025 11:07:48 +0800 Subject: [PATCH 19/42] Put two system variables in alphabetical order --- system-variables.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/system-variables.md b/system-variables.md index cc0b651daa21..a1efd16d9784 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5061,16 +5061,15 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) > > 跳过字符检查可能会使 TiDB 检测不到应用写入的非法 UTF-8 字符，进一步导致执行 `ANALYZE` 时解码错误，以及引入其他未知的编码问题。如果应用不能保证写入字符串的合法性，不建议跳过该检查。 -### `tidb_slow_log_threshold` +### `tidb_slow_log_max_per_sec` 从 v9.0.0 版本开始引入 - 作用域：GLOBAL -- 是否持久化到集群：否，仅作用于当前连接的 TiDB 实例 +- 是否持久化到集群：是 - 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制：否 -- 默认值：`300` +- 默认值：`0` - 类型：整数型 -- 范围：`[-1, 9223372036854775807]` -- 单位：毫秒 -- 输出慢日志的耗时阈值，默认为 300 ms。如果查询耗时大于这个值，会视作一个慢查询，并记录到慢查询日志。注意，当日志的输出级别 [`log.level`](/tidb-configuration-file.md#level) 是 `"debug"` 时，所有查询都会记录到慢日志，不受该变量的限制。 +- 范围：`[0, 1000000]` +- 控制每个 TiDB 节点每秒打印慢日志的次数上限，默认值为 `0`。当该变量值为 `0` 时，表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 `0` 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢日志。 ### `tidb_slow_log_rules` 从 v9.0.0 版本开始引入 @@ -5085,15 +5084,16 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) > > 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 -### `tidb_slow_log_max_per_sec` 从 v9.0.0 版本开始引入 +### `tidb_slow_log_threshold` - 作用域：GLOBAL -- 是否持久化到集群：是 +- 是否持久化到集群：否，仅作用于当前连接的 TiDB 实例 - 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制：否 -- 默认值：`0` +- 默认值：`300` - 类型：整数型 -- 范围：`[0, 1000000]` -- 控制每个 TiDB 节点每秒打印慢日志的次数上限，默认值为 `0`。当该变量值为 `0` 时，表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 `0` 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢日志。 +- 范围：`[-1, 9223372036854775807]` +- 单位：毫秒 +- 输出慢日志的耗时阈值，默认为 300 ms。如果查询耗时大于这个值，会视作一个慢查询，并记录到慢查询日志。注意，当日志的输出级别 [`log.level`](/tidb-configuration-file.md#level) 是 `"debug"` 时，所有查询都会记录到慢日志，不受该变量的限制。 ### `tidb_slow_query_file` From eb4863a2f8e09b37513f187d60379f043f9fb133 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 10 Dec 2025 11:10:03 +0800 Subject: [PATCH 20/42] Update wording for consistency and clarity --- system-variables.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/system-variables.md b/system-variables.md index a1efd16d9784..e4bb98e86be7 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5069,7 +5069,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值：`0` - 类型：整数型 - 范围：`[0, 1000000]` -- 控制每个 TiDB 节点每秒打印慢日志的次数上限，默认值为 `0`。当该变量值为 `0` 时，表示不限制每个节点每秒打印的慢日志数量。当该变量值大于 `0` 时，会限制每个节点每秒打印的慢日志数量不超过该值，超过部分的慢日志将被丢弃，不会写入慢日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢日志。 +- 控制每个 TiDB 节点每秒打印慢查询日志的次数上限，默认值为 `0`。当该变量值为 `0` 时，表示不限制每个节点每秒打印的慢查询日志数量。当该变量值大于 `0` 时，会限制每个节点每秒打印的慢查询日志数量不超过该值，超过部分的慢查询日志将被丢弃，不会写入慢查询日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢查询日志。 ### `tidb_slow_log_rules` 从 v9.0.0 版本开始引入 @@ -5078,11 +5078,11 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制：否 - 默认值："" - 类型：字符串 -- 用于定义慢日志的触发规则，支持基于多维度指标的组合条件，实现更加灵活和精细化的日志记录控制。 +- 用于定义慢查询日志的触发规则，支持基于多维度指标的组合条件，实现更加灵活和精细化的日志记录控制。 > **注意** > -> 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢日志打印频率，防止基于规则的慢日志触发过于频繁。 +> 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢查询日志打印频率，防止基于规则的慢查询日志触发过于频繁。 ### `tidb_slow_log_threshold` From 29dedf032b21728da3d2102c30d61784a36072f1 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Wed, 10 Dec 2025 11:10:58 +0800 Subject: [PATCH 21/42] Use a tip --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index e4bb98e86be7..cf967c405850 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5080,7 +5080,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 类型：字符串 - 用于定义慢查询日志的触发规则，支持基于多维度指标的组合条件，实现更加灵活和精细化的日志记录控制。 -> **注意** +> **Tip** > > 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢查询日志打印频率，防止基于规则的慢查询日志触发过于频繁。 From b36d8457b3a33a98584db4adb91ea1ac8b985e49 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 15 Dec 2025 15:37:04 +0800 Subject: [PATCH 22/42] Update identify-slow-queries.md --- identify-slow-queries.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 3e9c17d11efa..5bcd8db18011 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -196,9 +196,9 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * 配置的规则优先生效，`tidb_slow_log_threshold` 将被忽略。 * 若希望规则中仍包含 `query_time` 的触发条件，可在设置规则时指定。 * 规则匹配逻辑（多条规则之间采用 OR 关系）： - * Session 作用域规则：优先匹配，如果匹配成功，则打印慢查询日志。 - * Global 作用域规则：仅在 Session 规则未匹配时考虑： - * 若规则指定了 `ConnID` 并与当前 Session 的 `ConnID` 匹配，则使用该规则。 + * SESSION 作用域规则：优先匹配，如果匹配成功，则打印慢查询日志。 + * GLOBAL 作用域规则：仅在 SESSION 作用域规则未匹配时考虑： + * 若规则指定了 `ConnID` 并与当前会话的 `ConnID` 匹配，则使用该规则。 * 若规则未指定 `ConnID`（全局通用规则），则使用该规则。 * 显示变量的行为与普通系统变量一致。 From ade8cad38709c8497d8978989a5a1b34f5bc7b73 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 15 Dec 2025 16:09:40 +0800 Subject: [PATCH 23/42] Update system-variables.md --- system-variables.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index cf967c405850..bd7802b3b9c6 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5069,7 +5069,8 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值：`0` - 类型：整数型 - 范围：`[0, 1000000]` -- 控制每个 TiDB 节点每秒打印慢查询日志的次数上限，默认值为 `0`。当该变量值为 `0` 时，表示不限制每个节点每秒打印的慢查询日志数量。当该变量值大于 `0` 时，会限制每个节点每秒打印的慢查询日志数量不超过该值，超过部分的慢查询日志将被丢弃，不会写入慢查询日志文件。该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢查询日志。 +- 控制每个 TiDB 节点每秒打印慢查询日志的次数上限，默认值为 `0`。当该变量值为 `0` 时，表示不限制每个节点每秒打印的慢查询日志数量。当该变量值大于 `0` 时，会限制每个节点每秒打印的慢查询日志数量不超过该值，超过部分的慢查询日志将被丢弃，不会写入慢查询日志文件。 +- 该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢查询日志。 ### `tidb_slow_log_rules` 从 v9.0.0 版本开始引入 From 1f1e530b298a638f26640717083fc1161f8b40c7 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 15 Dec 2025 16:11:04 +0800 Subject: [PATCH 24/42] Update system-variables.md --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index bd7802b3b9c6..d4386cad8456 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5081,7 +5081,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 类型：字符串 - 用于定义慢查询日志的触发规则，支持基于多维度指标的组合条件，实现更加灵活和精细化的日志记录控制。 -> **Tip** +> **Tip：** > > 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢查询日志打印频率，防止基于规则的慢查询日志触发过于频繁。 From 3fed400a44789a4083897c0cbb5dd67a486f2a06 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Mon, 15 Dec 2025 16:13:30 +0800 Subject: [PATCH 25/42] Update system-variables.md --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index d4386cad8456..f58994c8dd75 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5083,7 +5083,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) > **Tip：** > -> 建议在启用 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢查询日志打印频率，防止基于规则的慢查询日志触发过于频繁。 +> 建议在启用 `tidb_slow_log_rules` 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢查询日志打印频率，防止基于规则的慢查询日志触发过于频繁。 ### `tidb_slow_log_threshold` From 128b8a902ec4e23acb720ec36af7fcacbe5ece8f Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 16 Dec 2025 09:46:13 +0800 Subject: [PATCH 26/42] Update identify-slow-queries.md Co-authored-by: xixirangrang --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 5bcd8db18011..4c45d086ce71 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -200,7 +200,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * GLOBAL 作用域规则：仅在 SESSION 作用域规则未匹配时考虑： * 若规则指定了 `ConnID` 并与当前会话的 `ConnID` 匹配，则使用该规则。 * 若规则未指定 `ConnID`（全局通用规则），则使用该规则。 - * 显示变量的行为与普通系统变量一致。 + * 使用 `SHOW VARIABLES`、`SELECT @@GLOBAL.tidb_slow_log_rules`、 `SELECT @@SESSION.tidb_slow_log_rules` 显示该变量的行为与其他系统变量一致。 > **Tip** > From f66d3ebae4c98d5353aa8d0ef11b5b9e0b3db0b7 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Tue, 16 Dec 2025 09:46:48 +0800 Subject: [PATCH 27/42] Update system-variables.md --- system-variables.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index f58994c8dd75..16e3118a64d6 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5069,7 +5069,9 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值：`0` - 类型：整数型 - 范围：`[0, 1000000]` -- 控制每个 TiDB 节点每秒打印慢查询日志的次数上限，默认值为 `0`。当该变量值为 `0` 时，表示不限制每个节点每秒打印的慢查询日志数量。当该变量值大于 `0` 时，会限制每个节点每秒打印的慢查询日志数量不超过该值，超过部分的慢查询日志将被丢弃，不会写入慢查询日志文件。 +- 控制每个 TiDB 节点每秒打印慢查询日志的次数上限。 + - 当值为 `0` （默认值）时，表示不限制每秒打印的慢查询日志数量。 + - 当值大于 `0` 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢查询日志文件。 - 该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢查询日志。 ### `tidb_slow_log_rules` 从 v9.0.0 版本开始引入 From f5bd7b76a95fca1e9b7be2845b564e6deacdedca Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 16 Dec 2025 15:39:58 +0800 Subject: [PATCH 28/42] Update identify-slow-queries.md Co-authored-by: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 4c45d086ce71..19b40ecb2f48 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -194,7 +194,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * 慢查询日志触发仍依赖 `tidb_slow_log_threshold`，`query_time` 阈值取自该变量，以保持向后兼容。 * 如果已设置 `tidb_slow_log_rules`： * 配置的规则优先生效，`tidb_slow_log_threshold` 将被忽略。 - * 若希望规则中仍包含 `query_time` 的触发条件，可在设置规则时指定。 + * 若希望规则中仍使用 `SQL 执行时间` 作为输出慢日志的条件之一，可在设置规则时使用`query_time` 并设置阈值。 * 规则匹配逻辑（多条规则之间采用 OR 关系）： * SESSION 作用域规则：优先匹配，如果匹配成功，则打印慢查询日志。 * GLOBAL 作用域规则：仅在 SESSION 作用域规则未匹配时考虑： From 4641e17e8b69c09de05c67c6283a475184352d57 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 16 Dec 2025 15:41:26 +0800 Subject: [PATCH 29/42] Update identify-slow-queries.md Co-authored-by: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 19b40ecb2f48..2adde58d9bdc 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -191,7 +191,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：用于设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢查询日志中。默认值是 300 ms。 * [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 * 如果未设置 `tidb_slow_log_rules`： - * 慢查询日志触发仍依赖 `tidb_slow_log_threshold`，`query_time` 阈值取自该变量，以保持向后兼容。 + * 慢查询日志触发仍依赖 `tidb_slow_log_threshold`。注：`query_time` 阈值的含义同该变量，均表示 SQL 执行时长阈值，以保持向后兼容。 * 如果已设置 `tidb_slow_log_rules`： * 配置的规则优先生效，`tidb_slow_log_threshold` 将被忽略。 * 若希望规则中仍使用 `SQL 执行时间` 作为输出慢日志的条件之一，可在设置规则时使用`query_time` 并设置阈值。 From 55c71f82e3c1e0f506733845cd77c36ac94e72ab Mon Sep 17 00:00:00 2001 From: Lynn Date: Wed, 17 Dec 2025 16:34:34 +0800 Subject: [PATCH 30/42] *: add rule items --- identify-slow-queries.md | 49 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 2adde58d9bdc..8d9d28ac7af6 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -189,7 +189,30 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ## 相关系统变量 * [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：用于设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢查询日志中。默认值是 300 ms。 -* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。 +* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。该变量下，支持把以下字段作为筛选条件，来设置输出慢查询日志的条件： + * 支持的筛选字段(下面字段说明可以参考：[字段含义说明](/#字段含义说明))： + * Slow Query 基础信息： + * `Query_time`、`Parse_time`、`Compile_time`、`Optimize_time`、`Wait_TS`、`Rewrite_time` + * `Digest`、`Plan_digest`、`Is_internal`、`Succ` + * `Exec_retry_count`、`Backoff_time`、`Write_sql_response_total` + * 和事务执行相关的字段： + * `Prewrite_time`、`Commit_time`、`Write_keys`、`Write_size`、`Prewrite_region` + * 和 SQL 执行的用户相关的字段： + * `Conn_ID`、`DB`、`Session_alias` + * 和 TiKV Coprocessor Task 相关的字段： + * `Process_time`、`Total_keys`、`Process_keys`、`Num_cop_tasks` + * 和内存使用相关的字段： + * `Mem_max` + * 和硬盘使用相关的字段： + * `Disk_max` + * 和资源管控相关的字段： + * `Resource_group` + * 和网络传输相关的字段： + * `KV_total`、`PD_total` + * `Unpacked_bytes_sent_tikv_total`、`Unpacked_bytes_received_tikv_total` + * `Unpacked_bytes_sent_tikv_cross_zone`、`Unpacked_bytes_received_tikv_cross_zone` + * `Unpacked_bytes_sent_tiflash_total`、`Unpacked_bytes_received_tiflash_total` + * `Unpacked_bytes_sent_tiflash_cross_zone`、`Unpacked_bytes_received_tiflash_cross_zone` * 如果未设置 `tidb_slow_log_rules`： * 慢查询日志触发仍依赖 `tidb_slow_log_threshold`。注：`query_time` 阈值的含义同该变量，均表示 SQL 执行时长阈值，以保持向后兼容。 * 如果已设置 `tidb_slow_log_rules`： @@ -201,6 +224,30 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * 若规则指定了 `ConnID` 并与当前会话的 `ConnID` 匹配，则使用该规则。 * 若规则未指定 `ConnID`（全局通用规则），则使用该规则。 * 使用 `SHOW VARIABLES`、`SELECT @@GLOBAL.tidb_slow_log_rules`、 `SELECT @@SESSION.tidb_slow_log_rules` 显示该变量的行为与其他系统变量一致。 + * 使用示例： + * 标准格式（SESSION 作用域）： + + ```sql + SET SESSION tidb_slow_log_rules = 'Query_time: 500, Is_internal: false'; + ``` + + * 错误格式（SESSION 作用域不支持 ConnID）： + + ```sql + SET SESSION tidb_slow_log_rules = 'ConnID: 12, Query_time: 500, Is_internal: false'; + ``` + + * 全局规则（适用于所有连接）： + + ```sql + SET GLOBAL tidb_slow_log_rules = 'Query_time: 500, Is_internal: false'; + ``` + + * 指定特定连接的全局规则（分别适用于 `ConnID:11` 和 `ConnID:11` 的两个连接）： + + ```sql + SET GLOBAL tidb_slow_log_rules = 'ConnID: 11, Query_time: 500, Is_internal: false; ConnID: 12, Query_time: 600, Process_time: 300, DB: db1'; + ``` > **Tip** > From a6f9a21457a82a511dbc62a932d08964d27415e8 Mon Sep 17 00:00:00 2001 From: Lynn Date: Wed, 17 Dec 2025 16:35:47 +0800 Subject: [PATCH 31/42] Update identify-slow-queries.md Co-authored-by: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 8d9d28ac7af6..2756ac6bad97 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -175,7 +175,7 @@ Slow Query 基础信息： ## 相关 Hint -你可以通过 Hint `WRITE_SLOW_LOG` 强制控制输出慢查询日志。 +自 v9.0.0 版本中引入 hint，你可以通过 Hint `WRITE_SLOW_LOG` 强制控制输出慢查询日志。 - 该 Hint 不受任何阈值或触发规则限制，即无论该 SQL 查询是否达到慢查询日志打印阈值，都会打印慢查询日志。 - 目前只支持强制开启打印慢查询日志，暂不支持通过 `WRITE_SLOW_LOG(FALSE)` 强制关闭打印慢查询日志。 From bdd7a967a2a86d9b3bf956e2349be0a5f12f442d Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 23 Dec 2025 10:15:12 +0800 Subject: [PATCH 32/42] Update identify-slow-queries.md Co-authored-by: xixirangrang --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 2756ac6bad97..16af41a7c9c8 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -175,7 +175,7 @@ Slow Query 基础信息： ## 相关 Hint -自 v9.0.0 版本中引入 hint，你可以通过 Hint `WRITE_SLOW_LOG` 强制控制输出慢查询日志。 +自 v9.0.0 版本中引入 Hint，你可以使用 `WRITE_SLOW_LOG` Hint 强制 TiDB 将特定 SQL 的执行信息输出至慢查询日志，无论其执行时长是否达到阈值。这有助于捕捉 SQL 执行时的详细元数据，例如执行计划和资源消耗。例如，在出现偶发性能波动问题时，某些 SQL 仅在特定条件下（如数据量突增或索引失效）才会变慢，而平时执行很快，因此难以通过默认阈值捕获。这种情况下，可以通过预先在业务 SQL 中添加该 Hint，确保在问题复现的瞬间，系统能完整记录下该次执行的详细信息。 - 该 Hint 不受任何阈值或触发规则限制，即无论该 SQL 查询是否达到慢查询日志打印阈值，都会打印慢查询日志。 - 目前只支持强制开启打印慢查询日志，暂不支持通过 `WRITE_SLOW_LOG(FALSE)` 强制关闭打印慢查询日志。 From 2dddd6895fd68e8ab5ea360baa52ca869a2396a6 Mon Sep 17 00:00:00 2001 From: houfaxin Date: Wed, 7 Jan 2026 14:35:18 +0800 Subject: [PATCH 33/42] Update identify-slow-queries.md --- identify-slow-queries.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 16af41a7c9c8..51f95a04e953 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -189,25 +189,25 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ## 相关系统变量 * [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：用于设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢查询日志中。默认值是 300 ms。 -* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。该变量下，支持把以下字段作为筛选条件，来设置输出慢查询日志的条件： - * 支持的筛选字段(下面字段说明可以参考：[字段含义说明](/#字段含义说明))： +* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。该变量下，支持把以下字段作为筛选条件，来设置输出慢查询日志的条件。详情请参考[字段含义说明](#字段含义说明)： + - 支持的筛选字段： * Slow Query 基础信息： * `Query_time`、`Parse_time`、`Compile_time`、`Optimize_time`、`Wait_TS`、`Rewrite_time` * `Digest`、`Plan_digest`、`Is_internal`、`Succ` * `Exec_retry_count`、`Backoff_time`、`Write_sql_response_total` - * 和事务执行相关的字段： + * 事务执行相关的字段： * `Prewrite_time`、`Commit_time`、`Write_keys`、`Write_size`、`Prewrite_region` - * 和 SQL 执行的用户相关的字段： + * SQL 执行的用户相关的字段： * `Conn_ID`、`DB`、`Session_alias` - * 和 TiKV Coprocessor Task 相关的字段： + * TiKV Coprocessor Task 相关的字段： * `Process_time`、`Total_keys`、`Process_keys`、`Num_cop_tasks` - * 和内存使用相关的字段： + * 内存使用相关的字段： * `Mem_max` - * 和硬盘使用相关的字段： + * 硬盘使用相关的字段： * `Disk_max` - * 和资源管控相关的字段： + * 资源管控相关的字段： * `Resource_group` - * 和网络传输相关的字段： + * 网络传输相关的字段： * `KV_total`、`PD_total` * `Unpacked_bytes_sent_tikv_total`、`Unpacked_bytes_received_tikv_total` * `Unpacked_bytes_sent_tikv_cross_zone`、`Unpacked_bytes_received_tikv_cross_zone` From 4682f4ef0f1000ffd1e42c86cd5b9b392fe36a61 Mon Sep 17 00:00:00 2001 From: houfaxin Date: Wed, 7 Jan 2026 15:15:28 +0800 Subject: [PATCH 34/42] Update identify-slow-queries.md --- identify-slow-queries.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 51f95a04e953..991b6062f012 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -189,7 +189,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; ## 相关系统变量 * [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold)：用于设置慢查询日志的阈值，执行时间超过阈值的 SQL 语句将被记录到慢查询日志中。默认值是 300 ms。 -* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。该变量下，支持把以下字段作为筛选条件，来设置输出慢查询日志的条件。详情请参考[字段含义说明](#字段含义说明)： +* [`tidb_slow_log_rules`](/system-variables.md#tidb_slow_log_rules-从-v900-版本开始引入)：用于定义慢查询日志的触发规则，支持多维度指标组合条件，以实现更加灵活和精细化的日志记录控制。该变量在 v9.0.0 版本中引入，逐步替代传统的单一阈值控制方式，即替代 `tidb_slow_log_threshold` 的使用。该变量支持将以下字段作为筛选条件，设置输出慢查询日志的条件。详情请参考[字段含义说明](#字段含义说明)。 - 支持的筛选字段： * Slow Query 基础信息： * `Query_time`、`Parse_time`、`Compile_time`、`Optimize_time`、`Wait_TS`、`Rewrite_time` @@ -231,7 +231,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; SET SESSION tidb_slow_log_rules = 'Query_time: 500, Is_internal: false'; ``` - * 错误格式（SESSION 作用域不支持 ConnID）： + * 错误格式（SESSION 作用域不支持 `ConnID`）： ```sql SET SESSION tidb_slow_log_rules = 'ConnID: 12, Query_time: 500, Is_internal: false'; @@ -249,14 +249,14 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; SET GLOBAL tidb_slow_log_rules = 'ConnID: 11, Query_time: 500, Is_internal: false; ConnID: 12, Query_time: 600, Process_time: 300, DB: db1'; ``` - > **Tip** + > **Tip:** > > - `tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 > - 在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 -* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢查询日志的上限，默认值为 0。 - * 当值为 0 时，表示不限制每秒打印的慢查询日志数量。 - * 当值大于 0 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢查询日志文件。 +* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢查询日志的上限，默认值为 `0`。 + * 当值为 `0` 时，表示不限制每秒打印的慢查询日志数量。 + * 当值大于 `0` 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢查询日志文件。 * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以避免规则触发频繁打印慢查询日志。 * [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 * [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时，是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 @@ -277,8 +277,6 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; 在性能测试中可以关闭自动收集算子的执行信息： -{{< copyable "sql" >}} - ```sql set @@tidb_enable_collect_execution_info=0; ``` From ad92333ebf89e522a6a374a74369e9dfd0909274 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 20 Jan 2026 16:44:00 +0800 Subject: [PATCH 35/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 991b6062f012..214b53088bad 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -175,7 +175,7 @@ Slow Query 基础信息： ## 相关 Hint -自 v9.0.0 版本中引入 Hint，你可以使用 `WRITE_SLOW_LOG` Hint 强制 TiDB 将特定 SQL 的执行信息输出至慢查询日志，无论其执行时长是否达到阈值。这有助于捕捉 SQL 执行时的详细元数据，例如执行计划和资源消耗。例如，在出现偶发性能波动问题时，某些 SQL 仅在特定条件下（如数据量突增或索引失效）才会变慢，而平时执行很快，因此难以通过默认阈值捕获。这种情况下，可以通过预先在业务 SQL 中添加该 Hint，确保在问题复现的瞬间，系统能完整记录下该次执行的详细信息。 +从 v9.0.0 开始，你可以使用 `WRITE_SLOW_LOG` Hint。该 Hint 用于强制 TiDB 将特定 SQL 的执行信息输出至慢查询日志，无论其执行时长是否达到阈值。这有助于捕获 SQL 执行过程中的详细元数据，如执行计划和资源消耗。例如，在出现偶发性能抖动问题时，某些 SQL 仅在特定条件下（如数据量突增或索引失效）才会变慢，而平时执行速度很快，因此难以通过默认的慢查询阈值捕获。这种情况下，可以预先在业务 SQL 中添加 `WRITE_SLOW_LOG` Hint，确保在问题复现的瞬间，系统能完整记录下该次 SQL 执行的详细信息。 - 该 Hint 不受任何阈值或触发规则限制，即无论该 SQL 查询是否达到慢查询日志打印阈值，都会打印慢查询日志。 - 目前只支持强制开启打印慢查询日志，暂不支持通过 `WRITE_SLOW_LOG(FALSE)` 强制关闭打印慢查询日志。 From f9f199ed83df5823501bc27a09ca5a228a2f025e Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 20 Jan 2026 16:44:22 +0800 Subject: [PATCH 36/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 214b53088bad..0c5935174261 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -217,7 +217,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * 慢查询日志触发仍依赖 `tidb_slow_log_threshold`。注：`query_time` 阈值的含义同该变量，均表示 SQL 执行时长阈值，以保持向后兼容。 * 如果已设置 `tidb_slow_log_rules`： * 配置的规则优先生效，`tidb_slow_log_threshold` 将被忽略。 - * 若希望规则中仍使用 `SQL 执行时间` 作为输出慢日志的条件之一，可在设置规则时使用`query_time` 并设置阈值。 + * 若希望规则中仍使用 SQL 执行时间作为输出慢日志的条件之一，可在设置规则时使用`query_time` 并设置阈值。 * 规则匹配逻辑（多条规则之间采用 OR 关系）： * SESSION 作用域规则：优先匹配，如果匹配成功，则打印慢查询日志。 * GLOBAL 作用域规则：仅在 SESSION 作用域规则未匹配时考虑： From f4d6bb723904970d88ace9c84d25d3f16cb8b678 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 20 Jan 2026 16:44:31 +0800 Subject: [PATCH 37/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 0c5935174261..e87f5e9d4628 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -223,7 +223,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * GLOBAL 作用域规则：仅在 SESSION 作用域规则未匹配时考虑： * 若规则指定了 `ConnID` 并与当前会话的 `ConnID` 匹配，则使用该规则。 * 若规则未指定 `ConnID`（全局通用规则），则使用该规则。 - * 使用 `SHOW VARIABLES`、`SELECT @@GLOBAL.tidb_slow_log_rules`、 `SELECT @@SESSION.tidb_slow_log_rules` 显示该变量的行为与其他系统变量一致。 + * 使用 `SHOW VARIABLES`、`SELECT @@GLOBAL.tidb_slow_log_rules`、`SELECT @@SESSION.tidb_slow_log_rules` 显示该变量的行为与其他系统变量一致。 * 使用示例： * 标准格式（SESSION 作用域）： From 6a7bbdc9d7f86153131a34b2245592e9e89e50ff Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 20 Jan 2026 17:17:18 +0800 Subject: [PATCH 38/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index e87f5e9d4628..2eebf70beccd 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -252,7 +252,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; > **Tip:** > > - `tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 - > - 在资源充足的测试环境（1 TiDB：16C/48G，3 TiKV：16C/48G）中，多次 sysbench 测试结果表明：当多维慢查询日志规则生成的慢查询日志量处于半小时内数百万级时，对性能影响较小；但若日志量达到千万级，则会导致 TPS、延迟出现明显下降。在业务负载较高或 CPU/内存接近瓶颈时，应谨慎配置 `tidb_slow_log_rules`，避免规则过宽导致日志洪泛。建议结合 `tidb_slow_log_max_per_sec` 限制日志打印速率，以降低对业务性能的影响。 + > - 在资源充足的测试环境（1 个 TiDB 节点，16 核 CPU、48 GiB 内存；3 个 TiKV 节点，每个 16 核 CPU、48 GiB 内存）中，多次 sysbench 测试结果表明：当多维慢查询日志规则在 30 分钟内生成数百万条慢查询日志时，对性能影响较小；但当日志量达到千万级时，TPS 会明显下降，延迟也会显著增加。在业务负载较高或 CPU、内存资源接近瓶颈的情况下，应谨慎配置 `tidb_slow_log_rules`，避免因规则过宽导致日志洪泛。建议结合使用 `tidb_slow_log_max_per_sec` 来限制日志打印速率，以降低对业务性能的影响。 * [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢查询日志的上限，默认值为 `0`。 * 当值为 `0` 时，表示不限制每秒打印的慢查询日志数量。 From 76ff930fa796345d6c80525f6873832e5e409d1a Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 20 Jan 2026 17:17:41 +0800 Subject: [PATCH 39/42] Update system-variables.md Co-authored-by: Lilian Lee --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index 16e3118a64d6..63ed5d8b67f8 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5069,7 +5069,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 默认值：`0` - 类型：整数型 - 范围：`[0, 1000000]` -- 控制每个 TiDB 节点每秒打印慢查询日志的次数上限。 +- 控制每个 TiDB 节点每秒打印的慢查询日志的数量上限。 - 当值为 `0` （默认值）时，表示不限制每秒打印的慢查询日志数量。 - 当值大于 `0` 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢查询日志文件。 - 该变量常与 [`tidb_slow_log_rules`](#tidb_slow_log_rules-从-v900-版本开始引入) 结合使用，以防止在高负载情况下产生过多的慢查询日志。 From 37d50162ded462c24b8ceeaf84938f08ce759515 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 20 Jan 2026 17:18:18 +0800 Subject: [PATCH 40/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 2eebf70beccd..5fdf164e7eb7 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -254,7 +254,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; > - `tidb_slow_log_rules` 用于替换单一阈值的方式，实现更灵活和精细化的慢查询日志控制，支持多维度指标组合条件。 > - 在资源充足的测试环境（1 个 TiDB 节点，16 核 CPU、48 GiB 内存；3 个 TiKV 节点，每个 16 核 CPU、48 GiB 内存）中，多次 sysbench 测试结果表明：当多维慢查询日志规则在 30 分钟内生成数百万条慢查询日志时，对性能影响较小；但当日志量达到千万级时，TPS 会明显下降，延迟也会显著增加。在业务负载较高或 CPU、内存资源接近瓶颈的情况下，应谨慎配置 `tidb_slow_log_rules`，避免因规则过宽导致日志洪泛。建议结合使用 `tidb_slow_log_max_per_sec` 来限制日志打印速率，以降低对业务性能的影响。 -* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢查询日志的上限，默认值为 `0`。 +* [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢查询日志数量的上限，默认值为 `0`。 * 当值为 `0` 时，表示不限制每秒打印的慢查询日志数量。 * 当值大于 `0` 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢查询日志文件。 * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以避免规则触发频繁打印慢查询日志。 From 17ba70cbcd8f2b40b05611aa5f8aab05c5643575 Mon Sep 17 00:00:00 2001 From: Lynn Date: Tue, 20 Jan 2026 17:20:12 +0800 Subject: [PATCH 41/42] Update identify-slow-queries.md Co-authored-by: Lilian Lee --- identify-slow-queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/identify-slow-queries.md b/identify-slow-queries.md index 5fdf164e7eb7..48ca86196cf8 100644 --- a/identify-slow-queries.md +++ b/identify-slow-queries.md @@ -257,7 +257,7 @@ SELECT /*+ WRITE_SLOW_LOG */ count(*) FROM t t1, t t2 WHERE t1.a = t2.b; * [`tidb_slow_log_max_per_sec`](/system-variables.md#tidb_slow_log_max_per_sec-从-v900-版本开始引入)：用于设置每秒打印慢查询日志数量的上限，默认值为 `0`。 * 当值为 `0` 时，表示不限制每秒打印的慢查询日志数量。 * 当值大于 `0` 时，TiDB 每秒最多打印指定数量的慢查询日志，超过部分将被丢弃，不会写入慢查询日志文件。 - * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以避免规则触发频繁打印慢查询日志。 + * 建议在启用了 `tidb_slow_log_rules` 后配置该变量，以防止基于规则的慢查询日志触发过于频繁。 * [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len)：设置慢查询日志记录 SQL 语句的最大长度。默认值是 4096 byte。 * [`tidb_redact_log`](/system-variables.md#tidb_redact_log)：设置慢查询日志记录 SQL 时，是否将用户数据脱敏用 `?` 代替。默认值是 `0`，即关闭该功能。 * [`tidb_enable_collect_execution_info`](/system-variables.md#tidb_enable_collect_execution_info)：设置是否记录执行计划中各个算子的物理执行信息，默认值是 `1`。开启该功能会导致性能降低约 3%。开启后查看 `Plan` 的示例如下： From 3faa506e5016d2bc3cd6f6a7fb3d77e25e15a718 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Tue, 20 Jan 2026 17:30:23 +0800 Subject: [PATCH 42/42] Update Tip format --- system-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system-variables.md b/system-variables.md index 63ed5d8b67f8..cf5a8301c5de 100644 --- a/system-variables.md +++ b/system-variables.md @@ -5083,7 +5083,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) - 类型：字符串 - 用于定义慢查询日志的触发规则，支持基于多维度指标的组合条件，实现更加灵活和精细化的日志记录控制。 -> **Tip：** +> **Tip:** > > 建议在启用 `tidb_slow_log_rules` 后，同时配置 [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-从-v900-版本开始引入)，以限制慢查询日志打印频率，防止基于规则的慢查询日志触发过于频繁。