Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
4 changes: 4 additions & 0 deletions statement-summary-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ The following is a sample output of querying `statements_summary`:
>
> - In TiDB, the time unit of fields in statement summary tables is nanosecond (ns), whereas in MySQL the time unit is picosecond (ps).
> - Starting from v7.5.1 and v7.6.0, for clusters with [resource control](/tidb-resource-control-ru-groups.md) enabled, `statements_summary` will be aggregated by resource group, for example, the same statements executed in different resource groups will be collected as different records.
> - Starting from v8.5.7, you can use [`tidb_stmt_summary_group_by_user`](/system-variables.md#tidb_stmt_summary_group_by_user-new-in-v857) to control whether to further aggregate statement summaries by execution user. When the variable value is `ON`, the same SQL digest executed by different users is collected as different records, and the `SAMPLE_USER` field of each record indicates the execution user corresponding to the record.
Comment thread
nolouch marked this conversation as resolved.
Outdated

## `statements_summary_history`

Expand Down Expand Up @@ -145,6 +146,8 @@ The following system variables are used to control the statement summary:

- `tidb_stmt_summary_max_sql_length`: Specifies the longest display length of `DIGEST_TEXT` and `QUERY_SAMPLE_TEXT`. The default value is `4096`.
- `tidb_stmt_summary_internal_query`: Determines whether to count the TiDB SQL statements. `1` means to count, and `0` means not to count. The default value is `0`.
- `tidb_stmt_summary_group_by_user`: Determines whether to further aggregate statement summaries by execution user. `1` means to aggregate by user, and `0` means not to aggregate by user. The default value is `0`. After this variable is enabled, the same SQL digest executed by different users is aggregated into different rows, which might increase the number of statement summary records and memory usage. Modifying this variable clears the current in-memory statement summary data.
- `tidb_stmt_summary_persist_evicted`: Determines whether to write statement summary records that are evicted by LRU to the statement summary log after [statements summary persistence](#persist-statements-summary) is enabled. `1` means to write, and `0` means not to write. The default value is `0`. After this variable is enabled, the log contains JSON records marked with `"evicted": true`, and the amount of logs increases as LRU evictions become more frequent.
Comment thread
nolouch marked this conversation as resolved.
Outdated

An example of the statement summary configuration is shown as follows:

Expand Down Expand Up @@ -262,6 +265,7 @@ After statements summary persistence is enabled, the memory keeps only the curre
>
> - When statements summary persistence is enabled, the `tidb_stmt_summary_history_size` configuration described in the [Parameter configuration](#parameter-configuration) section will no longer take effect because the memory does not keep the history data. Instead, the following three configurations will be used to control the retention period and size of history data for persistence: [`tidb_stmt_summary_file_max_days`](/tidb-configuration-file.md#tidb_stmt_summary_file_max_days-new-in-v660), [`tidb_stmt_summary_file_max_size`](/tidb-configuration-file.md#tidb_stmt_summary_file_max_size-new-in-v660), and [`tidb_stmt_summary_file_max_backups`](/tidb-configuration-file.md#tidb_stmt_summary_file_max_backups-new-in-v660).
> - The smaller the value of `tidb_stmt_summary_refresh_interval`, the more immediate data is written to the disk. However, this also means more redundant data is written to the disk.
> - Starting from v8.5.7, you can enable [`tidb_stmt_summary_persist_evicted`](/system-variables.md#tidb_stmt_summary_persist_evicted-new-in-v857) to write records evicted by LRU to the statement summary log. The written JSON records are marked with `"evicted": true` for downstream log consumers to identify and are not returned as query results of `statements_summary_history` or `cluster_statements_summary_history`.
Comment thread
nolouch marked this conversation as resolved.
Outdated

</CustomContent>

Expand Down
16 changes: 16 additions & 0 deletions system-variable-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3949,6 +3949,14 @@ Referenced in:
- [TiDB Configuration File](/tidb-configuration-file.md)
- [TiDB 6.6.0 Release Notes](/releases/release-6.6.0.md)

### tidb_stmt_summary_group_by_user

Referenced in:

- [SHOW [GLOBAL|SESSION] VARIABLES](/sql-statements/sql-statement-show-variables.md)
- [Statement Summary Tables](/statement-summary-tables.md)
- [System Variables](/system-variables.md#tidb_stmt_summary_group_by_user-new-in-v857)

### tidb_stmt_summary_history_size

Referenced in:
Expand Down Expand Up @@ -3992,6 +4000,14 @@ Referenced in:
- [TiDB 5.0.4 Release Notes](/releases/release-5.0.4.md)
- [TiDB 4.0.14 Release Notes](/releases/release-4.0.14.md)

### tidb_stmt_summary_persist_evicted

Referenced in:

- [SHOW [GLOBAL|SESSION] VARIABLES](/sql-statements/sql-statement-show-variables.md)
- [Statement Summary Tables](/statement-summary-tables.md)
- [System Variables](/system-variables.md#tidb_stmt_summary_persist_evicted-new-in-v857)

### tidb_stmt_summary_refresh_interval

Referenced in:
Expand Down
22 changes: 22 additions & 0 deletions system-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -6330,6 +6330,17 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md).

</CustomContent>

### tidb_stmt_summary_group_by_user <span class="version-mark">New in v8.5.7</span>

- Scope: GLOBAL
- Persists to cluster: Yes
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
- Type: Boolean
- Default value: `OFF`
- This variable controls whether to include the user that executes SQL statements as an aggregation dimension in [statement summary tables](/statement-summary-tables.md). When the variable value is `OFF`, the same SQL digest executed by different users is aggregated into the same row, and the `SAMPLE_USER` field displays one sampled user. When the variable value is `ON`, the same SQL digest executed by different users is aggregated into different rows, and the `SAMPLE_USER` field of each row indicates the execution user corresponding to the row.
- Modifying this variable clears the current in-memory statement summary data because data before and after the modification uses different aggregation dimensions. Historical data that has been persisted to the disk is not affected.
- After this variable is enabled, the number of statement summary records might increase with the number of different execution users for the same SQL digest, which increases memory usage.
Comment thread
nolouch marked this conversation as resolved.
Outdated

### tidb_stmt_summary_history_size <span class="version-mark">New in v4.0</span>

> **Note:**
Expand Down Expand Up @@ -6405,6 +6416,17 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md).

</CustomContent>

### tidb_stmt_summary_persist_evicted <span class="version-mark">New in v8.5.7</span>

- Scope: GLOBAL
- Persists to cluster: Yes
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
- Type: Boolean
- Default value: `OFF`
- This variable controls whether to write statement summary records that are evicted by LRU to the statement summary log after [statements summary persistence](/statement-summary-tables.md#persist-statements-summary) is enabled. The written JSON records are marked with `"evicted": true` for downstream log consumers to identify.
- This variable takes effect only for the persistent implementation of statement summary. Records marked with `"evicted": true` are not returned as query results of `statements_summary_history` or `cluster_statements_summary_history`.
- After this variable is enabled, the amount of statement summary logs increases as LRU evictions become more frequent. Evicted records are written by using an asynchronous buffer mechanism. When the buffer queue is full, new evicted records might be dropped.
Comment thread
nolouch marked this conversation as resolved.
Outdated

### tidb_stmt_summary_refresh_interval <span class="version-mark">New in v4.0</span>

> **Note:**
Expand Down