使用资源管控 (Resource Control) 实现资源隔离

使用资源管控特性，集群管理员可以定义资源组 (Resource Group)，通过资源组限定配额。

TiDB 资源管控特性提供了两层资源管理能力，包括在 TiDB 层的流控能力和 TiKV 层的优先级调度的能力。两个能力可以单独或者同时开启，详情请参见参数组合效果表。将用户绑定到某个资源组后，TiDB 层会根据用户所绑定资源组设定的配额对用户的读写请求做流控，TiKV 层会根据配额映射的优先级来对请求做调度。通过流控和调度这两层控制，可以实现应用的资源隔离，满足服务质量 (QoS) 要求。

• TiDB 流控：TiDB 流控使用令牌桶算法 做流控。如果桶内令牌数不够，而且资源组没有指定 BURSTABLE 特性，属于该资源组的请求会等待令牌桶回填令牌并重试，重试可能会超时失败。
• TiKV 调度：你可以为资源组设置绝对优先级 (PRIORITY)，不同的资源按照 PRIORITY 的设置进行调度，PRIORITY 高的任务会被优先调度。如果没有设置绝对优先级 (PRIORITY)，TiKV 会将资源组的 RU_PER_SEC 取值映射成各自资源组读写请求的优先级，并基于各自的优先级在存储层使用优先级队列调度处理请求。

使用场景

资源管控特性的引入对 TiDB 具有里程碑的意义。它能够将一个分布式数据库集群划分成多个逻辑单元，即使个别单元对资源过度使用，也不会挤占其他单元所需的资源。利用该特性：

• 你可以将多个来自不同系统的中小型应用合入一个 TiDB 集群中，个别应用的负载升高，不会影响其他业务的正常运行。而在系统负载较低的时候，繁忙的应用即使超过设定的读写配额，也仍然可以被分配到所需的系统资源，达到资源的最大化利用。
• 你可以选择将所有测试环境合入一个集群，或者将消耗较大的批量任务编入一个单独的资源组，在保证重要应用获得必要资源的同时，提升硬件利用率，降低运行成本。
• 当系统中存在多种业务负载时，可以将不同的负载分别放入各自的资源组。利用资源管控技术，确保交易类业务的响应时间不受数据分析或批量业务的影响。
• 当集群遇到突发的 SQL 性能问题，可以结合 SQL Binding 和资源组，临时限制某个 SQL 的资源消耗。

此外，合理利用资源管控特性可以减少集群数量，降低运维难度及管理成本。

使用限制

目前，资源管控特性具有以下限制:

• 只支持对前台客户发起的读写请求做限流和调度，不支持对 DDL 以及 Auto Analyze 等后台任务的限流和调度。
• 资源管控将带来额外的调度开销。因此，开启该特性后，性能可能会有轻微下降。

什么是 Request Unit (RU)

Request Unit (RU) 是 TiDB 对 CPU、IO 等系统资源的统一抽象的计量单位，用于表示对数据库的单个请求消耗的资源量。请求消耗的 RU 数量取决于多种因素，例如操作类型或正在检索或修改的数据量。目前，RU 包含以下资源的统计信息：

估算 SQL 所消耗的 RU

你可以通过 EXPLAIN ANALYZE 语句获取到 SQL 执行时所消耗的 RU。注意 RU 的大小会受缓存的影响（比如下推计算结果缓存），多次执行同一条 SQL 所消耗的 RU 可能会有不同。因此这个 RU 值并不代表每次执行的精确值，但可以作为估算的参考。

相关参数

资源管控特性引入了两个新的全局开关变量：

• TiDB：通过配置全局变量 tidb_enable_resource_control 控制是否打开资源组流控。
• TiKV：通过配置参数 resource-control.enabled 控制是否使用基于资源组配额的请求调度。

从 v7.0.0 开始，两个开关都被默认打开。这两个参数的组合效果见下表：

关于资源管控实现机制及相关参数的详细介绍，请参考 RFC: Global Resource Control in TiDB。

使用方法

下面介绍如何使用资源管控特性。

预估集群容量

在进行资源规划之前，你需要了解集群的整体容量。TiDB 提供了命令 CALIBRATE RESOURCE 用来估算集群容量。目前提供两种估算方式：

• 根据实际负载估算容量
• 基于硬件部署估算容量

可通过 TiDB Dashboard 资源管控页面进行查看。详情请参考 CALIBRATE RESOURCE 预估方式。

管理资源组

创建、修改、删除资源组，需要拥有 SUPER 或者 RESOURCE_GROUP_ADMIN 权限。

你可以通过 CREATE RESOURCE GROUP 在集群中创建资源组。

对于已有的资源组，可以通过 ALTER RESOURCE GROUP 修改资源组的配额，对资源组的配额修改会立即生效。

可以使用 DROP RESOURCE GROUP 删除资源组。

创建资源组

下面举例说明如何创建资源组。

1. 创建 rg1 资源组，限额是每秒 500 RU，并且允许这个资源组的应用超额占用资源。

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

2. 创建 rg2 资源组，RU 的回填速度是每秒 600 RU。在系统资源充足的时候，不允许这个资源组的应用超额占用资源。

   CREATE RESOURCE GROUP IF NOT EXISTS rg2 RU_PER_SEC = 600;
   

3. 创建 rg3 资源组，设置绝对优先级为 HIGH。绝对优先级目前支持 LOW|MEDIUM|HIGH，资源组的默认绝对优先级为 MEDIUM。

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

绑定资源组

TiDB 支持如下三个级别的资源组设置：

• 用户级别。通过 CREATE USER 或 ALTER USER 语句将用户绑定到特定的资源组。绑定后，对应的用户新创建的会话会自动绑定对应的资源组。
• 会话级别。通过 SET RESOURCE GROUP 设置当前会话使用的资源组。
• 语句级别。通过 RESOURCE_GROUP() Optimizer Hint 设置当前语句使用的资源组。

将用户绑定到资源组

下面的示例创建一个用户 usr1 并将其绑定到资源组 rg1。其中 rg1 为创建资源组示例中创建的资源组。

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

下面示例使用 ALTER USER 将用户 usr2 绑定到资源组 rg2。其中 rg2 为创建资源组示例中创建的资源组。

ALTER USER usr2 RESOURCE GROUP rg2;

绑定用户后，用户新建立的会话对资源的占用会受到指定用量 (RU) 的限制。如果系统负载比较高，没有多余的容量，用户 usr2 的资源消耗速度会被严格控制不超过指定用量。由于 usr1 绑定的 rg1 配置了 BURSTABLE，所以 usr1 消耗速度允许超过指定用量。

如果资源组对应的请求太多导致资源组的资源不足，客户端的请求处理会发生等待。如果等待时间过长，请求会报错。

要解除用户与资源组的绑定，只需将其重新绑定到 default 资源组即可，如下所示：

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

更多信息，请参见 ALTER USER ... RESOURCE GROUP。

将当前会话绑定到资源组

通过把当前会话绑定到资源组，会话对资源的占用会受到指定用量 (RU) 的限制。

下面的示例将当前的会话绑定至资源组 rg1。

SET RESOURCE GROUP rg1;

将语句绑定到资源组

通过在 SQL 语句中添加 RESOURCE_GROUP(resource_group_name) Hint，可以将该语句绑定到指定的资源组。此 Hint 支持 SELECT、INSERT、UPDATE、DELETE 四种语句。

示例：

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

管理资源消耗超出预期的查询 (Runaway Queries)

Runaway Query 是指执行时间或消耗资源超出预期的查询（仅指 SELECT 语句）。下面使用 Runaway Queries 表示管理 Runaway Query 这一功能。

• 自 v7.2.0 起，TiDB 资源管控引入了对 Runaway Queries 的管理。你可以针对某个资源组设置条件来识别 Runaway Queries，并自动发起应对操作，防止集群资源完全被 Runaway Queries 占用而影响其他正常查询。你可以在 CREATE RESOURCE GROUP 或者 ALTER RESOURCE GROUP 中配置 QUERY_LIMIT 字段，通过规则识别来管理资源组的 Runaway Queries。
• 自 v7.3.0 起，TiDB 资源管控引入了手动管理 Runaway Queries 监控列表的功能，将给定的 SQL 或者 Digest 添加到隔离监控列表，从而实现快速隔离 Runaway Queries。你可以执行语句 QUERY WATCH，手动管理资源组中的 Runaway Queries 监控列表。

QUERY_LIMIT 参数说明

支持的条件设置：

• EXEC_ELAPSED: 当查询执行的时间超限时，识别为 Runaway Query。

支持的应对操作 (ACTION)：

• DRYRUN：对执行 Query 不做任何操作，仅记录识别的 Runaway Query。主要用于观测设置条件是否合理。
• COOLDOWN：将查询的执行优先级降到最低，查询仍旧会以低优先级继续执行，不占用其他操作的资源。
• KILL：识别到的查询将被自动终止，报错 Query execution was interrupted, identified as runaway query。

为了避免并发的 Runaway Query 过多导致系统资源耗尽，资源管控引入了 Runaway Query 监控机制，能够快速识别并隔离 Runaway Query。该功能通过 WATCH 子句实现，当某一个查询被识别为 Runaway Query 之后，会提取这个查询的匹配特征（由 WATCH 后的匹配方式参数决定），在接下来的一段时间里（由 DURATION 定义），这个 Runaway Query 的匹配特征会被加入到监控列表，TiDB 实例会将查询和监控列表进行匹配，匹配到的查询直接标记为 Runaway Query，而不再等待其被条件识别，并按照当前应对操作进行隔离。其中 KILL 会终止该查询，并报错 Quarantined and interrupted because of being in runaway watch list。

WATCH 有三种匹配方式：

• EXACT 表示完全相同的 SQL 才会被快速识别
• SIMILAR 表示会忽略字面值 (Literal)，通过 SQL Digest 匹配所有模式 (Pattern) 相同的 SQL
• PLAN 表示通过 Plan Digest 匹配所有模式 (Pattern) 相同的 SQL

WATCH 中的 DURATION 选项，用于表示此识别项的持续时间，默认为无限长。

添加监控项后，匹配特征和 ACTION 都不会随着 QUERY_LIMIT 配置的修改或删除而改变或删除。可以使用 QUERY WATCH REMOVE 来删除监控项。

QUERY_LIMIT 具体格式如下：

示例

1. 创建 rg1 资源组，限额是每秒 500 RU，并且定义超过 60 秒为 Runaway Query，并对 Runaway Query 降低优先级执行。

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

2. 修改 rg1 资源组，对 Runaway Query 直接终止，并且在接下来的 10 分钟里，把相同模式的查询直接标记为 Runaway Query。

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

3. 修改 rg1 资源组，取消 Runaway Queries 检查。

   ALTER RESOURCE GROUP rg1 QUERY_LIMIT=NULL;
   

QUERY WATCH 语句说明

语法详见 QUERY WATCH。

参数说明如下：

• RESOURCE GROUP 用于指定资源组。此语句添加的 Runaway Queries 监控特征将添加到该资源组的监控列表中。此参数可以省略，省略时作用于 default 资源组。

• ACTION 的含义与 QUERY LIMIT 相同。此参数可以省略，省略时表示识别后的对应操作采用此时资源组中 QUERY LIMIT 配置的 ACTION，且不会随着 QUERY LIMIT 配置的改变而改变。如果资源组没有配置 ACTION，会报错。

• QueryWatchTextOption 参数有 SQL DIGEST、PLAN DIGEST、SQL TEXT 三种类型。

  • SQL DIGEST 的含义与 QUERY LIMIT WATCH 类型中的 SIMILAR 相同，后面紧跟的参数可以是字符串、用户自定义变量以及其他计算结果为字符串的表达式。字符串长度必须为 64，与 TiDB 中关于 Digest 的定义一致。
  • PLAN DIGEST 的含义与 PLAN 相同。输入参数为 Digest 字符串。
  • SQL TEXT 可以根据后面紧跟的参数，将输入的 SQL 的原始字符串（使用 EXACT 选项）作为模式匹配项，或者经过解析和编译转化为 SQL DIGEST（使用 SIMILAR 选项）、PLAN DIGEST（使用 PLAN 选项）来作为模式匹配项。

• 为默认资源组的 Runaway Queries 监控列表添加监控匹配特征（需要提前为默认资源组设置 QUERY LIMIT）。

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

• 通过将 SQL 解析成 SQL Digest，为 rg1 资源组的 Runaway Queries 监控列表添加监控匹配特征。未指定 ACTION 时，使用 rg1 资源组已配置的 ACTION。

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

• 通过 PLAN Digest 为 rg1 资源组的 Runaway Queries 监控列表添加监控匹配特征。

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

• 通过查询 INFORMATION_SCHEMA.RUNAWAY_WATCHES 获取监控项 ID，删除该监控项。

  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;
  

可观测性

可以通过以下系统表和 INFORMATION_SCHEMA 表获得 Runaway 相关的更多信息：

• mysql.tidb_runaway_queries 表中包含了过去 7 天内所有识别到的 Runaway Queries 的历史记录。以其中一行为例：

  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
  

  其中，match_type 为该 Runaway Query 的来源，其值如下：

  • identify 表示命中条件。
  • watch 表示被快速识别机制命中。

• information_schema.runaway_watches 表中包含了 Runaway Queries 的快速识别规则记录。详见 RUNAWAY_WATCHES。

关闭资源管控特性

1. 执行以下命令关闭资源管控特性：

   SET GLOBAL tidb_enable_resource_control = 'OFF';
   

2. 将 TiKV 参数 resource-control.enabled 设为 false，关闭按照资源组配额调度。

监控与图表

TiDB 会定时采集资源管控的运行时信息，并在 Grafana 的 Resource Control Dashboard 中提供了相关指标的可视化图表，详见 Resource Control 监控指标详解。

TiKV 中也记录了来自于不同资源组的请求 QPS，详见 TiKV 监控指标详解。

TiDB Dashboard 中可以查看当前 RESOURCE_GROUPS 表中资源组的数据。详见 TiDB Dashboard 资源管控页面。

工具兼容性

资源管控不影响数据导入导出以及其他同步工具的正常使用，BR、TiDB Lightning、TiCDC 等工具不支持对资源管控相关 DDL 的处理，这些工具的资源消耗也不受资源管控的限制。

常见问题

1. 如果我暂时不想使用资源组对资源进行管控，是否一定要关闭这个特性？

   不需要。没有指定任何资源组的用户，将被放入系统预定义的 default 资源组，而 default 资源组默认拥有无限用量。当所有用户都属于 default 资源组时，资源分配方式与关闭资源管控时相同。

2. 一个数据库用户是否可以绑定到不同的资源组？

   不能。一个数据库用户只能绑定到一个资源组。但是，在会话运行的过程中，可以通过 SET RESOURCE GROUP 设置当前会话使用的资源组。你也可以通过优化器 RESOURCE_GROUP() Hint 为运行的语句设置资源组。

3. 当各个资源组设置的用量 (RU_PER_SEC) 总和超出系统容量会发生什么？

   TiDB 在创建资源组时不会检查容量。只要系统有足够的空闲资源，TiDB 就会满足每个资源组的用量设置。当系统资源超过限制时，TiDB 会优先满足高优先级 (PRIORITY) 资源组的请求。如果同一优先级的请求无法全部满足，TiDB 会根据用量 (RU_PER_SEC) 的大小按比例分配。

另请参阅

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