Skip to content

Commit ad59fae

Browse files
lhy1024lhy1024
authored
resource control: support more mode for BURSTABLE (#21138)
1 parent 827df4f commit ad59fae

6 files changed

+67
-51
lines changed

‎information-schema/information-schema-resource-groups.md‎

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,17 @@ DESC resource_groups;
1717
```
1818

1919
```sql
20-
+------------+-------------+------+------+---------+-------+
21-
| Field | Type | Null | Key | Default | Extra |
22-
+------------+-------------+------+------+---------+-------+
23-
| NAME | varchar(32) | NO | | NULL | |
24-
| RU_PER_SEC | bigint(21) | YES | | NULL | |
25-
| PRIORITY | varchar(6) | YES | | NULL | |
26-
| BURSTABLE | varchar(3) | YES | | NULL | |
27-
+------------+-------------+------+------+---------+-------+
28-
3 rows in set (0.00 sec)
20+
+-------------+--------------+------+------+---------+-------+
21+
| Field | Type | Null | Key | Default | Extra |
22+
+-------------+--------------+------+------+---------+-------+
23+
| NAME | varchar(32) | NO | | NULL | |
24+
| RU_PER_SEC | varchar(21) | YES | | NULL | |
25+
| PRIORITY | varchar(6) | YES | | NULL | |
26+
| BURSTABLE | varchar(3) | YES | | NULL | |
27+
| QUERY_LIMIT | varchar(256) | YES | | NULL | |
28+
| BACKGROUND | varchar(256) | YES | | NULL | |
29+
+-------------+--------------+------+------+---------+-------+
30+
6 rows in set (0.00 sec)
2931
```
3032

3133
## Examples
@@ -35,11 +37,11 @@ SELECT * FROM information_schema.resource_groups; -- View all resource groups. T
3537
```
3638

3739
```sql
38-
+---------+------------+----------+-----------+
39-
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE |
40-
+---------+------------+----------+-----------+
41-
| default | UNLIMITED | MEDIUM | YES |
42-
+---------+------------+----------+-----------+
40+
+---------+------------+----------+-----------+-------------+------------+
41+
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND |
42+
+---------+------------+----------+-----------+-------------+------------+
43+
| default | UNLIMITED | MEDIUM | UNLIMITED | NULL | NULL |
44+
+---------+------------+----------+-----------+-------------+------------+
4345
```
4446

4547
```sql
@@ -68,11 +70,11 @@ SELECT * FROM information_schema.resource_groups WHERE NAME = 'rg1'; -- View the
6870
```
6971

7072
```sql
71-
+------+------------+----------+-----------+-------------+
72-
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT |
73-
+------+------------+----------+-----------+-------------+
74-
| rg1 | 1000 | MEDIUM | NO | NULL |
75-
+------+------------+----------+-----------+-------------+
73+
+------+------------+----------+-----------+-------------+------------+
74+
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND |
75+
+------+------------+----------+-----------+-------------+------------+
76+
| rg1 | 1000 | MEDIUM | OFF | NULL | NULL |
77+
+------+------------+----------+-----------+-------------+------------+
7678
1 row in set (0.00 sec)
7779
```
7880

@@ -81,8 +83,12 @@ The descriptions of the columns in the `RESOURCE_GROUPS` table are as follows:
8183
* `NAME`: the name of the resource group.
8284
* `RU_PER_SEC`: the backfilling speed of the resource group. The unit is RU/second, in which RU means [Request Unit](/tidb-resource-control-ru-groups.md#what-is-request-unit-ru).
8385
* `PRIORITY`: the absolute priority of tasks to be processed on TiKV. Different resources are scheduled according to the `PRIORITY` setting. Tasks with high `PRIORITY` are scheduled first. For resource groups with the same `PRIORITY`, tasks will be scheduled proportionally according to the `RU_PER_SEC` configuration. If `PRIORITY` is not specified, the default priority is `MEDIUM`.
84-
* `BURSTABLE`: whether to allow the resource group to overuse the available system resources.
86+
* `BURSTABLE`: whether to allow the resource group to overuse the available remaining system resources. Starting from v9.0.0, the following three modes are supported. If no value is specified for `BURSTABLE`, the `MODERATED` mode is enabled by default.
87+
88+
- `OFF`: indicates that the resource group is not allowed to overuse any remaining system resources.
89+
- `MODERATED`: indicates that the resource group is allowed to overuse remaining system resources to a limited extent, with priority given to allocated resources within its quota.
90+
- `UNLIMITED`: indicates that the resource group can overuse remaining system resources without limitation, and the excess system resources are treated as equal to the resources within the quota during allocation.
8591

8692
> **Note:**
8793
>
88-
> TiDB automatically creates a `default` resource group during cluster initialization. For this resource group, the default value of `RU_PER_SEC` is `UNLIMITED` (equivalent to the maximum value of the `INT` type, that is, `2147483647`) and it is in `BURSTABLE` mode. All requests that are not bound to any resource group are automatically bound to this `default` resource group. When you create a new configuration for another resource group, it is recommended to modify the `default` resource group configuration as needed.
94+
> TiDB automatically creates a `default` resource group during cluster initialization. For this resource group, the default value of `RU_PER_SEC` is `UNLIMITED` (equivalent to the maximum value of the `INT` type, that is, `2147483647`) and its `BURSTABLE` mode is `UNLIMITED`. All requests that are not bound to any resource group are automatically bound to this `default` resource group. You cannot delete the `default` resource group, but can modify its RU configuration.

‎sql-statements/sql-statement-alter-resource-group.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ DirectResourceGroupOption ::=
3333
"RU_PER_SEC" EqOpt LengthNum
3434
| "PRIORITY" EqOpt ResourceGroupPriorityOption
3535
| "BURSTABLE"
36-
| "BURSTABLE" EqOpt Boolean
36+
| "BURSTABLE" EqOpt "MODERATED"
37+
| "BURSTABLE" EqOpt "UNLIMITED"
38+
| "BURSTABLE" EqOpt "OFF"
3739
| "QUERY_LIMIT" EqOpt '(' ResourceGroupRunawayOptionList ')'
3840
| "QUERY_LIMIT" EqOpt '(' ')'
3941
| "QUERY_LIMIT" EqOpt "NULL"
@@ -84,7 +86,7 @@ TiDB supports the following `DirectResourceGroupOption`, where [Request Unit (RU
8486
|---------------|-------------------------------------|------------------------|
8587
| `RU_PER_SEC` | Rate of RU backfilling per second | `RU_PER_SEC = 500` indicates that this resource group is backfilled with 500 RUs per second |
8688
| `PRIORITY` | The absolute priority of tasks to be processed on TiKV | `PRIORITY = HIGH` indicates that the priority is high. If not specified, the default value is `MEDIUM`. |
87-
| `BURSTABLE` | If the `BURSTABLE` attribute is set, TiDB allows the corresponding resource group to use the available system resources when the quota is exceeded. |
89+
| `BURSTABLE` | Whether to allow the resource group to overuse the available remaining system resources | Starting from v9.0.0, the following three modes are supported: `OFF` indicates that the resource group is not allowed to overuse any remaining system resources. `MODERATED` indicates that the resource group is allowed to overuse remaining system resources to a limited extent. `UNLIMITED` indicates that the resource group can overuse remaining system resources without limitation. If no value is specified for `BURSTABLE`, the `MODERATED` mode is enabled by default. |
8890
| `QUERY_LIMIT` | When the query execution meets this condition, the query is identified as a runaway query and the corresponding action is executed. | `QUERY_LIMIT=(EXEC_ELAPSED='60s', ACTION=KILL, WATCH=EXACT DURATION='10m')` indicates that the query is identified as a runaway query when the execution time exceeds 60 seconds. The query is terminated. All SQL statements with the same SQL text will be terminated immediately in the coming 10 minutes. `QUERY_LIMIT=()` or `QUERY_LIMIT=NULL` means that runaway control is not enabled. See [Runaway Queries](/tidb-resource-control-runaway-queries.md). |
8991
| `BACKGROUND` | Configure the background tasks. For more details, see [Manage background tasks](/tidb-resource-control-background-tasks.md). | `BACKGROUND=(TASK_TYPES="br,stats", UTILIZATION_LIMIT=30)` indicates that the backup and restore and statistics collection related tasks are scheduled as background tasks, and background tasks can consume 30% of the TiKV resources at most. |
9092

@@ -124,7 +126,7 @@ SELECT * FROM information_schema.resource_groups WHERE NAME ='rg1';
124126
+------+------------+----------+-----------+-------------+------------+
125127
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND |
126128
+------+------------+----------+-----------+-------------+------------+
127-
| rg1 | 100 | MEDIUM | NO | NULL | NULL |
129+
| rg1 | 100 | MEDIUM | OFF | NULL | NULL |
128130
+------+------------+----------+-----------+-------------+------------+
129131
1 rows in set (1.30 sec)
130132
```
@@ -148,7 +150,7 @@ SELECT * FROM information_schema.resource_groups WHERE NAME ='rg1';
148150
+------+------------+----------+-----------+----------------------------------------------------------------+------------+
149151
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND |
150152
+------+------------+----------+-----------+----------------------------------------------------------------+------------+
151-
| rg1 | 200 | LOW | NO | EXEC_ELAPSED='1s', ACTION=COOLDOWN, WATCH=EXACT DURATION='30s' | NULL |
153+
| rg1 | 200 | LOW | OFF | EXEC_ELAPSED='1s', ACTION=COOLDOWN, WATCH=EXACT DURATION='30s' | NULL |
152154
+------+------------+----------+-----------+----------------------------------------------------------------+------------+
153155
1 rows in set (1.30 sec)
154156
```
@@ -168,11 +170,11 @@ SELECT * FROM information_schema.resource_groups WHERE NAME ='default';
168170
```
169171

170172
```sql
171-
+---------+------------+----------+-----------+-------------+-------------------------------------------+
172-
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND |
173-
+---------+------------+----------+-----------+-------------+-------------------------------------------+
174-
| default | UNLIMITED | MEDIUM | YES | NULL | TASK_TYPES='br,ddl', UTILIZATION_LIMIT=30 |
175-
+---------+------------+----------+-----------+-------------+-------------------------------------------+
173+
+---------+------------+----------+------------------+-------------+-------------------------------------------+
174+
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND |
175+
+---------+------------+----------+------------------+-------------+-------------------------------------------+
176+
| default | UNLIMITED | MEDIUM | UNLIMITED | NULL | TASK_TYPES='br,ddl', UTILIZATION_LIMIT=30 |
177+
+---------+------------+----------+------------------+-------------+-------------------------------------------+
176178
1 rows in set (1.30 sec)
177179
```
178180

‎sql-statements/sql-statement-create-resource-group.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ DirectResourceGroupOption ::=
3333
"RU_PER_SEC" EqOpt stringLit
3434
| "PRIORITY" EqOpt ResourceGroupPriorityOption
3535
| "BURSTABLE"
36-
| "BURSTABLE" EqOpt Boolean
36+
| "BURSTABLE" EqOpt "MODERATED"
37+
| "BURSTABLE" EqOpt "UNLIMITED"
38+
| "BURSTABLE" EqOpt "OFF"
3739
| "QUERY_LIMIT" EqOpt '(' ResourceGroupRunawayOptionList ')'
3840
| "QUERY_LIMIT" EqOpt '(' ')'
3941
| "QUERY_LIMIT" EqOpt "NULL"
@@ -81,13 +83,13 @@ TiDB supports the following `DirectResourceGroupOption`, where [Request Unit (RU
8183
|---------------|-------------------------------------|------------------------|
8284
| `RU_PER_SEC` | Rate of RU backfilling per second | `RU_PER_SEC = 500` indicates that this resource group is backfilled with 500 RUs per second |
8385
| `PRIORITY` | The absolute priority of tasks to be processed on TiKV | `PRIORITY = HIGH` indicates that the priority is high. If not specified, the default value is `MEDIUM`. |
84-
| `BURSTABLE` | If the `BURSTABLE` attribute is set, TiDB allows the corresponding resource group to use the available system resources when the quota is exceeded. |
86+
| `BURSTABLE` | Whether to allow the resource group to overuse the available remaining system resources | Starting from v9.0.0, the following three modes are supported: `OFF` indicates that the resource group is not allowed to overuse any remaining system resources. `MODERATED` indicates that the resource group is allowed to overuse remaining system resources to a limited extent. `UNLIMITED` indicates that the resource group can overuse remaining system resources without limitation. If no value is specified for `BURSTABLE`, the `MODERATED` mode is enabled by default. |
8587
| `QUERY_LIMIT` | When the query execution meets this condition, the query is identified as a runaway query and the corresponding action is executed. | `QUERY_LIMIT=(EXEC_ELAPSED='60s', ACTION=KILL, WATCH=EXACT DURATION='10m')` indicates that the query is identified as a runaway query when the execution time exceeds 60 seconds. The query is terminated. All SQL statements with the same SQL text will be terminated immediately in the coming 10 minutes. `QUERY_LIMIT=()` or `QUERY_LIMIT=NULL` means that runaway control is not enabled. See [Runaway Queries](/tidb-resource-control-runaway-queries.md). |
8688

8789
> **Note:**
8890
>
8991
> - The `CREATE RESOURCE GROUP` statement can only be executed when the global variable [`tidb_enable_resource_control`](/system-variables.md#tidb_enable_resource_control-new-in-v660) is set to `ON`.
90-
> TiDB automatically creates a `default` resource group during cluster initialization. For this resource group, the default value of `RU_PER_SEC` is `UNLIMITED` (equivalent to the maximum value of the `INT` type, that is, `2147483647`) and it is in `BURSTABLE` mode. All requests that are not bound to any resource group are automatically bound to this `default` resource group. When you create a new configuration for another resource group, it is recommended to modify the `default` resource group configuration as needed.
92+
> TiDB automatically creates a `default` resource group during cluster initialization. For this resource group, the default value of `RU_PER_SEC` is `UNLIMITED` (equivalent to the maximum value of the `INT` type, that is, `2147483647`) and its `BURSTABLE` mode is `UNLIMTED`. All requests that are not bound to any resource group are automatically bound to this `default` resource group. You cannot delete the `default` resource group, but can modify its RU configuration.
9193
> - Currently, only the `default` resource group supports modifying the `BACKGROUND` configuration.
9294
9395
## Examples
@@ -127,12 +129,12 @@ SELECT * FROM information_schema.resource_groups WHERE NAME ='rg1' or NAME = 'rg
127129
```
128130

129131
```sql
130-
+------+------------+----------+-----------+---------------------------------+
131-
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT |
132-
+------+------------+----------+-----------+---------------------------------+
133-
| rg1 | 100 | HIGH | YES | NULL |
134-
| rg2 | 200 | MEDIUM | NO | EXEC_ELAPSED=100ms, ACTION=KILL |
135-
+------+------------+----------+-----------+---------------------------------+
132+
+------+------------+----------+----------------+---------------------------------+
133+
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT |
134+
+------+------------+----------+----------------+---------------------------------+
135+
| rg1 | 100 | HIGH | MODERATED | NULL |
136+
| rg2 | 200 | MEDIUM | OFF | EXEC_ELAPSED=100ms, ACTION=KILL |
137+
+------+------------+----------+----------------+---------------------------------+
136138
2 rows in set (1.30 sec)
137139
```
138140

‎sql-statements/sql-statement-drop-resource-group.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ SELECT * FROM information_schema.resource_groups WHERE NAME ='rg1';
5555
```
5656

5757
```sql
58-
+------+------------+----------+-----------+-------------+
59-
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT |
60-
+------+------------+----------+-----------+-------------+
61-
| rg1 | 500 | MEDIUM | YES | NULL |
62-
+------+------------+----------+-----------+-------------+
58+
+------+------------+----------+----------------+-------------+
59+
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT |
60+
+------+------------+----------+----------------+-------------+
61+
| rg1 | 500 | MEDIUM | MODERATED | NULL |
62+
+------+------------+----------+----------------+-------------+
6363
1 row in set (0.01 sec)
6464
```
6565

‎tidb-resource-control-background-tasks.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@ By default, the task types that are marked as background tasks are `""`, and the
8181
The output is as follows:
8282

8383
```
84-
+---------+------------+----------+-----------+-------------+-------------------------------------------+
85-
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND |
86-
+---------+------------+----------+-----------+-------------+-------------------------------------------+
87-
| default | UNLIMITED | MEDIUM | YES | NULL | TASK_TYPES='br,ddl', UTILIZATION_LIMIT=30 |
88-
+---------+------------+----------+-----------+-------------+-------------------------------------------+
84+
+---------+------------+----------+-----------------+-------------+-------------------------------------------+
85+
| NAME | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND |
86+
+---------+------------+----------+-----------------+-------------+-------------------------------------------+
87+
| default | UNLIMITED | MEDIUM | UNLIMITED | NULL | TASK_TYPES='br,ddl', UTILIZATION_LIMIT=30 |
88+
+---------+------------+----------+-----------------+-------------+-------------------------------------------+
8989
```
9090

9191
5. To explicitly mark tasks in the current session as the background type, you can use `tidb_request_source_type` to explicitly specify the task type. The following is an example:

‎tidb-resource-control-ru-groups.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ You can delete a resource group by using [`DROP RESOURCE GROUP`](/sql-statements
185185

186186
The following is an example of how to create a resource group.
187187

188-
1. Create a resource group `rg1`. The resource limit is 500 RUs per second and allows applications in this resource group to overrun resources.
188+
1. Create a resource group `rg1`. The resource limit is 500 RUs per second and allows applications in this resource group to overrun resources. If no value is specified for `BURSTABLE`, the `MODERATED` mode is enabled by default.
189189

190190
```sql
191191
CREATE RESOURCE GROUP IF NOT EXISTS rg1 RU_PER_SEC = 500 BURSTABLE;
@@ -203,6 +203,12 @@ The following is an example of how to create a resource group.
203203
CREATE RESOURCE GROUP IF NOT EXISTS rg3 RU_PER_SEC = 100 PRIORITY = HIGH;
204204
```
205205

206+
4. Create a `rg4` resource group with a quota of 500 RUs per second, and allow applications in this group to use additional resources beyond the quota without limitation by setting the `BURSTABLE` mode to `UNLIMITED`.
207+
208+
```sql
209+
CREATE RESOURCE GROUP IF NOT EXISTS rg4 RU_PER_SEC = 500 BURSTABLE=UNLIMITED;
210+
```
211+
206212
### Bind resource groups
207213

208214
TiDB supports three levels of resource group settings as follows.
@@ -232,7 +238,7 @@ If there are too many requests that result in insufficient resources for the res
232238
> **Note:**
233239
>
234240
> - When you bind a user to a resource group by using `CREATE USER` or `ALTER USER`, it will not take effect for the user's existing sessions, but only for the user's new sessions.
235-
> - TiDB automatically creates a `default` resource group during cluster initialization. For this resource group, the default value of `RU_PER_SEC` is `UNLIMITED` (equivalent to the maximum value of the `INT` type, that is, `2147483647`) and it is in `BURSTABLE` mode. Statements that are not bound to a resource group are automatically bound to this resource group. This resource group does not support deletion, but you can modify the configuration of its RU.
241+
> - TiDB automatically creates a `default` resource group during cluster initialization. For this resource group, the default value of `RU_PER_SEC` is `UNLIMITED` (equivalent to the maximum value of the `INT` type, that is, `2147483647`) and its `BURSTABLE` is `UNLIMITED` mode. All requests that are not bound to any resource group are automatically bound to this `default` resource group. You cannot delete the `default` resource group, but can modify its RU configuration.
236242
237243
To unbind users from a resource group, you can simply bind them to the `default` group again as follows:
238244

0 commit comments

Comments
 (0)