Refine slow log description (#18366) (#18644)

pingcap · Aug 20, 2024 · 4d68f76 · 4d68f76
1 parent 9abe9a8
commit 4d68f76
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/system-variables.md b/system-variables.md
@@ -1994,7 +1994,7 @@ Query OK, 0 rows affected, 1 warning (0.00 sec)
 - Default value: `300`
 - Range: `[-1, 9223372036854775807]`
 - Unit: Milliseconds
-- This variable is used to output the threshold value of the time consumed by the slow log. When the time consumed by a query is larger than this value, this query is considered as a slow log and its log is output to the slow query log.
+- This variable outputs the threshold value of the time consumed by the slow log, and is set to 300 milliseconds by default. When the time consumed by a query is larger than this value, this query is considered as a slow query and its log is output to the slow query log. Note that when the output level of [`log.level`](https://docs.pingcap.com/tidb/v5.4/tidb-configuration-file#level) is `"debug"`, all queries are recorded in the slow query log, regardless of the setting of this variable.
 
 Usage example:
 

diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md
@@ -237,8 +237,9 @@ Configuration items related to log.
 ### `slow-threshold`
 
 - Outputs the threshold value of consumed time in the slow log.
-- Default value: `300ms`
-- If the value in a query is larger than the default value, it is a slow query and is output to the slow log.
+- Default value: `300`
+- Unit: Milliseconds
+- When the time consumed by a query is larger than this value, this query is considered as a slow query and its log is output to the slow query log. Note that when the output level of [`log.level`](#level) is `"debug"`, all queries are recorded in the slow query log, regardless of the setting of this parameter.
 
 ### `record-plan-in-slow-log`