Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Refine slow log description (#18366) #18642

Merged
merged 7 commits into from
Aug 20, 2024
Merged

Refine slow log description (#18366) #18642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
92652b8
Add temp.md
lilin90 Jul 26, 2024
e346bca
Delete temp.md
lilin90 Jul 26, 2024
eb484e9
Refine descriptions for completeness and clarity
lilin90 Aug 20, 2024
4ae807a
Update link for check
lilin90 Aug 20, 2024
e1a1905
Update wording for consistency
lilin90 Aug 20, 2024
1a3380e
Apply suggestions from code review
lilin90 Aug 20, 2024
00a6dca
Update system-variables.md
lilin90 Aug 20, 2024
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 system-variables.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading