Use Resource Control to Achieve Resource Isolation

As a cluster administrator, you can use the resource control feature to create resource groups, set quotas for resource groups, and bind users to those groups.

The TiDB resource control feature provides two layers of resource management capabilities: the flow control capability at the TiDB layer and the priority scheduling capability at the TiKV layer. The two capabilities can be enabled separately or simultaneously. See the Parameters for resource control for details. This allows the TiDB layer to control the flow of user read and write requests based on the quotas set for the resource groups, and allows the TiKV layer to schedule the requests based on the priority mapped to the read and write quota. By doing this, you can ensure resource isolation for your applications and meet quality of service (QoS) requirements.

• TiDB flow control: TiDB flow control uses the token bucket algorithm. If there are not enough tokens in a bucket, and the resource group does not specify the BURSTABLE option, the requests to the resource group will wait for the token bucket to backfill the tokens and retry. The retry might fail due to timeout.

• TiKV scheduling: You can set the absolute priority (PRIORITY) as needed. Different resources are scheduled according to the PRIORITY setting. Tasks with high PRIORITY are scheduled first. If you do not set the absolute priority, TiKV uses the value of RU_PER_SEC of each resource group to determine the priority of the read and write requests for each resource group. Based on the priorities, the storage layer uses the priority queue to schedule and process requests.

Starting from v7.4.0, the resource control feature supports controlling TiFlash resources. Its principle is similar to that of TiDB flow control and TiKV scheduling:

• TiFlash flow control: With the TiFlash pipeline execution model, TiFlash can more accurately obtain the CPU consumption of different queries and convert it into Request Units (RU) for deduction. Traffic control is implemented using a token bucket algorithm.
• TiFlash scheduling: When system resources are insufficient, TiFlash schedules pipeline tasks among multiple resource groups based on their priorities. The specific logic is: First, TiFlash assesses the PRIORITY of the resource group, then considers the CPU usage and RU_PER_SEC. As a result, if rg1 and rg2 have the same PRIORITY but the RU_PER_SEC of rg2 is twice that of rg1, the CPU usage of rg2 is twice that of rg1.

Scenarios for resource control

The introduction of the resource control feature is a milestone for TiDB. It can divide a distributed database cluster into multiple logical units. Even if an individual unit overuses resources, it does not crowd out the resources needed by other units.

With this feature, you can:

• Combine multiple small and medium-sized applications from different systems into a single TiDB cluster. When the workload of an application grows larger, it does not affect the normal operation of other applications. When the system workload is low, busy applications can still be allocated the required system resources even if they exceed the set quotas, so as to achieve the maximum utilization of resources.
• Choose to combine all test environments into a single TiDB cluster, or group the batch tasks that consume more resources into a single resource group. It can improve hardware utilization and reduce operating costs while ensuring that critical applications can always get the necessary resources.
• When there are mixed workloads in a system, you can put different workloads into separate resource groups. By using the resource control feature, you can ensure that the response time of transactional applications is not affected by data analysis or batch applications.
• When the cluster encounters an unexpected SQL performance issue, you can use SQL bindings along with resource groups to temporarily limit the resource consumption of a SQL statement.

In addition, the rational use of the resource control feature can reduce the number of clusters, ease the difficulty of operation and maintenance, and save management costs.

Limitations

Resource control incurs additional scheduling overhead. Therefore, there might be a slight performance degradation (less than 5%) when this feature is enabled.

What is Request Unit (RU)

Request Unit (RU) is a unified abstraction unit in TiDB for system resources, which currently includes CPU, IOPS, and IO bandwidth metrics. It is used to indicate the amount of resources consumed by a single request to the database. The number of RUs consumed by a request depends on a variety of factors, such as the type of operations, and the amount of data being queried or modified. Currently, the RU contains consumption statistics for the resources in the following table:

Parameters for resource control

The resource control feature introduces the following system variables or parameters:

• TiDB: you can use the tidb_enable_resource_control system variable to control whether to enable flow control for resource groups.

• TiKV: you can use the resource-control.enabled parameter to control whether to use request scheduling based on resource groups.
• TiFlash: you can use the tidb_enable_resource_control system variable and the enable_resource_control configuration item (introduced in v7.4.0) to control whether to enable TiFlash resource control.

Starting from TiDB v7.0.0, tidb_enable_resource_control and resource-control.enabled are enabled by default. The results of the combinations of these two parameters are shown in the following table.

Starting from v7.4.0, the TiFlash configuration item enable_resource_control is enabled by default. It works together with tidb_enable_resource_control to control the TiFlash resource control feature. TiFlash resource control only performs flow control and priority scheduling when both enable_resource_control and tidb_enable_resource_control are enabled. Additionally, when enable_resource_control is enabled, TiFlash uses the Pipeline execution model.

For more information about the resource control mechanism and parameters, see RFC: Global Resource Control in TiDB and TiFlash Resource Control.

How to use resource control

This section describes how to use the resource control feature to manage resource groups and control the resource allocation of each resource group.

Estimate cluster capacity

Before resource planning, you need to know the overall capacity of the cluster. TiDB provides the statement CALIBRATE RESOURCE to estimate the cluster capacity. You can use one of the following methods:

• Estimate capacity based on actual workload
• Estimate capacity based on hardware deployment

You can view the Resource Manager page in TiDB Dashboard. For more information, see CALIBRATE RESOURCE.

Manage resource groups

To create, modify, or delete a resource group, you need to have the SUPER or RESOURCE_GROUP_ADMIN privilege.

You can create a resource group for a cluster by using CREATE RESOURCE GROUP.

For an existing resource group, you can modify the RU_PER_SEC option (the rate of RU backfilling per second) of the resource group by using ALTER RESOURCE GROUP. The changes to the resource group take effect immediately.

You can delete a resource group by using DROP RESOURCE GROUP.

Create a resource group

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

1. Create a resource group rg1. The resource limit is 500 RUs per second and allows applications in this resource group to overrun resources.

   CREATE RESOURCE GROUP IF NOT EXISTS rg1 RU_PER_SEC = 500 BURSTABLE;
   

2. Create a resource group rg2. The RU backfill rate is 600 RUs per second and does not allow applications in this resource group to overrun resources.

   CREATE RESOURCE GROUP IF NOT EXISTS rg2 RU_PER_SEC = 600;
   

3. Create a resource group rg3 with the absolute priority set to HIGH. The absolute priority currently supports LOW|MEDIUM|HIGH. The default value is MEDIUM.

   CREATE RESOURCE GROUP IF NOT EXISTS rg3 RU_PER_SEC = 100 PRIORITY = HIGH;
   

Bind resource groups

TiDB supports three levels of resource group settings as follows.

• User level. Bind a user to a specific resource group via the CREATE USER or ALTER USER statement. After a user is bound to a resource group, sessions created by the user are automatically bound to the corresponding resource group.
• Session level. Set the resource group for the current session via SET RESOURCE GROUP.
• Statement level. Set the resource group for the current statement via RESOURCE_GROUP() Optimizer Hint.

Bind users to a resource group

The following example creates a user usr1 and binds the user to the resource group rg1. rg1 is the resource group created in the example in Create Resource Group.

CREATE USER 'usr1'@'%' IDENTIFIED BY '123' RESOURCE GROUP rg1;

The following example uses ALTER USER to bind the user usr2 to the resource group rg2. rg2 is the resource group created in the example in Create Resource Group.

ALTER USER usr2 RESOURCE GROUP rg2;

After you bind users, the resource consumption of newly created sessions will be controlled by the specified quota (Request Unit, RU). If the system workload is relatively high and there is no spare capacity, the resource consumption rate of usr2 will be strictly controlled not to exceed the quota. Because usr1 is bound by rg1 with BURSTABLE configured, the consumption rate of usr1 is allowed to exceed the quota.

If there are too many requests that result in insufficient resources for the resource group, the client's requests will wait. If the wait time is too long, the requests will report an error.

To unbind users from a resource group, you can simply bind them to the default group again as follows:

ALTER USER 'usr3'@'%' RESOURCE GROUP `default`;

For more details, see ALTER USER ... RESOURCE GROUP.

Bind the current session to a resource group

By binding a session to a resource group, the resource usage of the corresponding session is limited by the specified usage (RU).

The following example binds the current session to the resource group rg1.

SET RESOURCE GROUP rg1;

Bind the current statement to a resource group

By adding the RESOURCE_GROUP(resource_group_name) hint to a SQL statement, you can specify the resource group to which the statement is bound. This hint supports SELECT, INSERT, UPDATE, and DELETE statements.

The following example binds the current statement to the resource group rg1.

SELECT /*+ RESOURCE_GROUP(rg1) */ * FROM t limit 10;

Manage queries that consume more resources than expected (Runaway Queries)

A runaway query is a query (SELECT statement only) that consumes more time or resources than expected. The term runaway queries is used in the following to describe the feature of managing the runaway query.

• Starting from v7.2.0, the resource control feature introduces the management of runaway queries. You can set criteria for a resource group to identify runaway queries and automatically take actions to prevent them from exhausting resources and affecting other queries. You can manage runaway queries for a resource group by including the QUERY_LIMIT field in CREATE RESOURCE GROUP or ALTER RESOURCE GROUP.
• Starting from v7.3.0, the resource control feature introduces manual management of runaway watches, enabling quick identification of runaway queries for a given SQL statement or Digest. You can execute the statement QUERY WATCH to manually manage the runaway queries watch list in the resource group.

QUERY_LIMIT parameters

Supported condition setting:

• EXEC_ELAPSED: a query is identified as a runaway query when the query execution time exceeds this limit.

Supported operations (ACTION):

• DRYRUN: no action is taken. The records are appended for the runaway queries. This is mainly used to observe whether the condition setting is reasonable.
• COOLDOWN: the execution priority of the query is lowered to the lowest level. The query continues to execute with the lowest priority and does not occupy resources of other operations.
• KILL: the identified query is automatically terminated and reports an error Query execution was interrupted, identified as runaway query.

To avoid too many concurrent runaway queries that exhaust system resources, the resource control feature introduces a quick identification mechanism, which can quickly identify and isolate runaway queries. You can use this feature through the WATCH clause. When a query is identified as a runaway query, this mechanism extracts the matching feature (defined by the parameter after WATCH) of the query. In the next period of time (defined by DURATION), the matching feature of the runaway query is added to the watch list, and the TiDB instance matches queries with the watch list. The matching queries are directly marked as runaway queries and isolated according to the corresponding action, instead of waiting for them to be identified by conditions. The KILL operation terminates the query and reports an error Quarantined and interrupted because of being in runaway watch list.

There are three methods for WATCH to match for quick identification:

• EXACT indicates that only SQL statements with exactly the same SQL text are quickly identified.
• SIMILAR indicates all SQL statements with the same pattern are matched by Plan Digest, and the literal values are ignored.
• PLAN indicates all SQL statements with the same pattern are matched by Plan Digest.

The DURATION option in WATCH indicates the duration of the identification item, which is infinite by default.

After a watch item is added, neither the matching feature nor the ACTION is changed or deleted whenever the QUERY_LIMIT configuration is changed or deleted. You can use QUERY WATCH REMOVE to remove a watch item.

The parameters of QUERY_LIMIT are as follows:

Examples

1. Create a resource group rg1 with a quota of 500 RUs per second, and define a runaway query as one that exceeds 60 seconds, and lower the priority of the runaway query.

   CREATE RESOURCE GROUP IF NOT EXISTS rg1 RU_PER_SEC = 500 QUERY_LIMIT=(EXEC_ELAPSED='60s', ACTION=COOLDOWN);
   

2. Change the rg1 resource group to terminate the runaway queries, and mark the queries with the same pattern as runaway queries immediately in the next 10 minutes.

   ALTER RESOURCE GROUP rg1 QUERY_LIMIT=(EXEC_ELAPSED='60s', ACTION=KILL, WATCH=SIMILAR DURATION='10m');
   

3. Change the rg1 resource group to cancel the runaway query check.

   ALTER RESOURCE GROUP rg1 QUERY_LIMIT=NULL;
   

QUERY WATCH parameters

For more information about the synopsis of QUERY WATCH, see QUERY WATCH.

The parameters are as follows:

• The RESOURCE GROUP specifies a resource group. The matching features of runaway queries added by this statement are added to the watch list of the resource group. This parameter can be omitted. If omitted, it applies to the default resource group.

• The meaning of ACTION is the same as QUERY LIMIT. This parameter can be omitted. If omitted, the corresponding action after identification adopts the ACTION configured by QUERY LIMIT in the resource group, and the action does not change with the QUERY LIMIT configuration. If there is no ACTION configured in the resource group, an error is reported.

• The QueryWatchTextOption parameter has three options: SQL DIGEST, PLAN DIGEST, and SQL TEXT.

  • SQL DIGEST is the same as that of SIMILAR. The following parameters accept strings, user-defined variables, or other expressions that yield string result. The string length must be 64, which is the same as the Digest definition in TiDB.
  • PLAN DIGEST is the same as PLAN. The following parameter is a Digest string.
  • SQL TEXT matches the input SQL as a raw string (EXACT), or parses and compiles it into SQL DIGEST (SIMILAR) or PLAN DIGEST (PLAN), depending on the following parameter.

• Add a matching feature to the runaway query watch list for the default resource group (you need to set QUERY LIMIT for the default resource group in advance).

  QUERY WATCH ADD ACTION KILL SQL TEXT EXACT TO 'select * from test.t2';
  

• Add a matching feature to the runaway query watch list for the rg1 resource group by parsing the SQL into SQL Digest. When ACTION is not specified, the ACTION option already configured for the rg1 resource group is used.

  QUERY WATCH ADD RESOURCE GROUP rg1 SQL TEXT SIMILAR TO 'select * from test.t2';
  

• Add a matching feature to the runaway query watch list for the rg1 resource group using PLAN DIGEST.

  QUERY WATCH ADD RESOURCE GROUP rg1 ACTION KILL PLAN DIGEST 'd08bc323a934c39dc41948b0a073725be3398479b6fa4f6dd1db2a9b115f7f57';
  

• Get the watch item ID by querying INFORMATION_SCHEMA.RUNAWAY_WATCHES and delete the watch item.

  SELECT * from information_schema.runaway_watches ORDER BY id;
  

  *************************** 1. row ***************************
                  ID: 20003
  RESOURCE_GROUP_NAME: rg2
          START_TIME: 2023-07-28 13:06:08
          END_TIME: UNLIMITED
              WATCH: Similar
          WATCH_TEXT: 5b7fd445c5756a16f910192ad449c02348656a5e9d2aa61615e6049afbc4a82e
              SOURCE: 127.0.0.1:4000
              ACTION: Kill
  1 row in set (0.00 sec)
  

  QUERY WATCH REMOVE 20003;
  

Observability

You can get more information about runaway queries from the following system tables and INFORMATION_SCHEMA:

• The mysql.tidb_runaway_queries table contains the history records of all runaway queries identified in the past 7 days. Take one of the rows as an example:

  MySQL [(none)]> SELECT * FROM mysql.tidb_runaway_queries LIMIT 1\G
  *************************** 1. row ***************************
  resource_group_name: rg1
                 time: 2023-06-16 17:40:22
           match_type: identify
               action: kill
         original_sql: select * from sbtest.sbtest1
          plan_digest: 5b7d445c5756a16f910192ad449c02348656a5e9d2aa61615e6049afbc4a82e
          tidb_server: 127.0.0.1:4000
  

  In the preceding output,match_type indicates how the runaway query is identified. The value can be one of the following:

  • identify means that it matches the condition of the runaway query.
  • watch means that it matches the quick identification rule in the watch list.

• The information_schema.runaway_watches table contains records of quick identification rules for runaway queries. For more information, see RUNAWAY_WATCHES.

Manage background tasks

Background tasks, such as data backup and automatic statistics collection, are low-priority but consume many resources. These tasks are usually triggered periodically or irregularly. During execution, they consume a lot of resources, thus affecting the performance of online high-priority tasks.

Starting from v7.4.0, the TiDB resource control feature supports managing background tasks. When a task is marked as a background task, TiKV dynamically limits the resources used by this type of task to avoid the impact on the performance of other foreground tasks. TiKV monitors the CPU and IO resources consumed by all foreground tasks in real time, and calculates the resource threshold that can be used by background tasks based on the total resource limit of the instance. All background tasks are restricted by this threshold during execution.

BACKGROUND parameters

TASK_TYPES: specifies the task types that need to be managed as background tasks. Use commas (,) to separate multiple task types.

TiDB supports the following types of background tasks:

• lightning: perform import tasks using TiDB Lightning. Both physical and logical import modes of TiDB Lightning are supported.
• br: perform backup and restore tasks using BR. PITR is not supported.
• ddl: control the resource usage during the batch data write back phase of Reorg DDLs.
• stats: the collect statistics tasks that are manually executed or automatically triggered by TiDB.
• background: a reserved task type. You can use the tidb_request_source_type system variable to specify the task type of the current session as background.

By default, the task types that are marked as background tasks are "", and the management of background tasks is disabled. To enable background task management, you need to manually modify the background task type of the default resource group. After a background task is identified and matched, Resource Control is automatically performed. This means that when system resources are insufficient, the background tasks are automatically reduced to the lowest priority to ensure the execution of foreground tasks.

Examples

1. Modify the default resource group and mark br and ddl as background tasks.

   ALTER RESOURCE GROUP `default` BACKGROUND=(TASK_TYPES='br,ddl');
   

2. Change the default resource group to revert the background task type to its default value.

   ALTER RESOURCE GROUP `default` BACKGROUND=NULL;
   

3. Change the default resource group to set the background task type to empty. In this case, all tasks of this resource group are not treated as background tasks.

   ALTER RESOURCE GROUP `default` BACKGROUND=(TASK_TYPES="");
   

4. View the background task type of the default resource group.

   SELECT * FROM information_schema.resource_groups WHERE NAME="default";
   

   The output is as follows:

   +---------+------------+----------+-----------+-------------+---------------------+
   | NAME    | RU_PER_SEC | PRIORITY | BURSTABLE | QUERY_LIMIT | BACKGROUND          |
   +---------+------------+----------+-----------+-------------+---------------------+
   | default | UNLIMITED  | MEDIUM   | YES       | NULL        | TASK_TYPES='br,ddl' |
   +---------+------------+----------+-----------+-------------+---------------------+
   

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:

   SET @@tidb_request_source_type="background";
   /* Add background task type */
   ALTER RESOURCE GROUP `default` BACKGROUND=(TASK_TYPES="background");
   /* Execute LOAD DATA in the current session */
   LOAD DATA INFILE "s3://resource-control/Lightning/test.customer.aaaa.csv"
   

Disable resource control

1. Execute the following statement to disable the resource control feature.

   SET GLOBAL tidb_enable_resource_control = 'OFF';
   

2. Set the TiKV parameter resource-control.enabled to false to disable scheduling based on the RU of the resource group.

3. Set the TiFlash configuration item enable_resource_control to false to disable TiFlash resource control.

View RU consumption

You can view information about RU consumption.

View the RU consumption by SQL

You can view the RU consumption of SQL statements in the following ways:

• The system variable tidb_last_query_info
• EXPLAIN ANALYZE
• Slow queries and corresponding system table
• statements_summary

View the RUs consumed by the last SQL execution by querying the system variable tidb_last_query_info

TiDB provides the system variable tidb_last_query_info. This system variable records the information of the last DML statement executed, including the RUs consumed by the SQL execution.

Example:

1. Run the UPDATE statement:

   UPDATE sbtest.sbtest1 SET k = k + 1 WHERE id = 1;
   

   Query OK, 1 row affected (0.01 sec)
   Rows matched: 1  Changed: 1  Warnings: 0
   

2. Query the system variable tidb_last_query_info to view the information of the last executed statement:

   SELECT @@tidb_last_query_info;
   

   +------------------------------------------------------------------------------------------------------------------------+
   | @@tidb_last_query_info                                                                                                 |
   +------------------------------------------------------------------------------------------------------------------------+
   | {"txn_scope":"global","start_ts":446809472210829315,"for_update_ts":446809472210829315,"ru_consumption":4.34885578125} |
   +------------------------------------------------------------------------------------------------------------------------+
   1 row in set (0.01 sec)
   

   In the result, ru_consumption is the RUs consumed by the execution of this SQL statement.

View RUs consumed during SQL execution by EXPLAIN ANALYZE

You can use the EXPLAIN ANALYZE statement to get the amount of RUs consumed during SQL execution. Note that the amount of RUs is affected by the cache (for example, coprocessor cache). When the same SQL is executed multiple times, the amount of RUs consumed by each execution might be different. The RU value does not represent the exact value for each execution, but can be used as a reference for estimation.

Slow queries and the corresponding system table

When you enable resource control, the slow query log of TiDB and the corresponding system table INFORMATION_SCHEMA.SLOW_QUERY contain the resource group, RU consumption of the corresponding SQL, and the time spent waiting for available RUs.

View RU statistics by statements_summary

The system table INFORMATION_SCHEMA.statements_summary in TiDB stores the normalized and aggregated statistics of SQL statements. You can use the system table to view and analyze the execution performance of SQL statements. It also contains statistics about resource control, including the resource group name, RU consumption, and the time spent waiting for available RUs. For more details, see statements_summary fields description.

View the RU consumption of resource groups

Starting from v7.6.0, TiDB provides the system table mysql.request_unit_by_group to store the historical records of the RU consumption of each resource group.

Example:

SELECT * FROM request_unit_by_group LIMIT 5;

+----------------------------+----------------------------+----------------+----------+
| start_time                 | end_time                   | resource_group | total_ru |
+----------------------------+----------------------------+----------------+----------+
| 2024-01-01 00:00:00.000000 | 2024-01-02 00:00:00.000000 | default        |   334147 |
| 2024-01-01 00:00:00.000000 | 2024-01-02 00:00:00.000000 | rg1            |     4172 |
| 2024-01-01 00:00:00.000000 | 2024-01-02 00:00:00.000000 | rg2            |    34028 |
| 2024-01-02 00:00:00.000000 | 2024-01-03 00:00:00.000000 | default        |   334088 |
| 2024-01-02 00:00:00.000000 | 2024-01-03 00:00:00.000000 | rg1            |     3850 |
+----------------------------+----------------------------+----------------+----------+
5 rows in set (0.01 sec)

Monitoring metrics and charts

TiDB regularly collects runtime information about resource control and provides visual charts of the metrics in Grafana's TiDB > Resource Control dashboard. The metrics are detailed in the Resource Control section of TiDB Important Monitoring Metrics.

TiKV also records the request QPS from different resource groups. For more details, see TiKV Monitoring Metrics Detail.

You can view the data of resource groups in the current RESOURCE_GROUPS table in TiDB Dashboard. For more details, see Resource Manager page.

Tool compatibility

The resource control feature does not impact the regular usage of data import, export, and other replication tools. BR, TiDB Lightning, and TiCDC do not currently support processing DDL operations related to resource control, and their resource consumption is not limited by resource control.

FAQ

1. Do I have to disable resource control if I don't want to use resource groups?

   No. Users who do not specify any resource groups will be bound to the default resource group that has unlimited resources. When all users belong to the default resource group, the resource allocation method is the same as when the resource control is disabled.

2. Can a database user be bound to several resource groups?

   No. A database user can only be bound to one resource group. However, during the session runtime, you can use SET RESOURCE GROUP to set the resource group used by the current session. You can also use the optimizer hint RESOURCE_GROUP() to set the resource group for the running statement.

3. What happens when the total resource allocation (RU_PER_SEC) of all resource groups exceeds the system capacity?

   TiDB does not verify the capacity when you create a resource group. As long as the system has enough available resources, TiDB can meet the resource requirements of each resource group. When the system resources exceed the limit, TiDB prioritizes satisfying requests from resource groups with higher priority. If requests with the same priority cannot all be met, TiDB allocates resources proportionally according to the resource allocation (RU_PER_SEC).

See also

• CREATE RESOURCE GROUP
• ALTER RESOURCE GROUP
• DROP RESOURCE GROUP
• RESOURCE GROUP RFC