Skip to content

Commit

Permalink
Refine slow log description (#18366) (#18642)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Aug 20, 2024
1 parent 10c22ba commit 86c1a86
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion system-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -5258,7 +5258,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/v8.1/tidb-configuration-file#level) is `"debug"`, all queries are recorded in the slow query log, regardless of the setting of this variable.

### tidb_slow_query_file

Expand Down
5 changes: 3 additions & 2 deletions tidb-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ Configuration items related to log.
- Outputs the threshold value of consumed time in the slow log.
- Default value: `300`
- Unit: Milliseconds
- If the value in a query is larger than the default value, it is a slow query and is output to the slow log.
- 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.
- Since v6.1.0, the threshold value of consumed time in the slow log is specified by the TiDB configuration item [`instance.tidb_slow_log_threshold`](/tidb-configuration-file.md#tidb_slow_log_threshold) or the system variable [`tidb_slow_log_threshold`](/system-variables.md#tidb_slow_log_threshold). `slow-threshold` still takes effect. But if `slow-threshold` and `instance.tidb_slow_log_threshold` are set at the same time, the latter takes effect.

### `record-plan-in-slow-log`
Expand Down Expand Up @@ -900,10 +900,11 @@ Configuration items related to read isolation.

### `tidb_slow_log_threshold`

- This configuration 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.
- Outputs the threshold value of the time consumed by the slow log.
- Default value: `300`
- Range: `[-1, 9223372036854775807]`
- 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.
- Before v6.1.0, this configuration is set by `slow-threshold`.

### `in-mem-slow-query-topn-num` <span class="version-mark">New in v7.3.0</span>
Expand Down

0 comments on commit 86c1a86

Please sign in to comment.