WORKLOAD GROUP

SinceVersion dev

workload group 可限制组内任务在单个be节点上的计算资源和内存资源的使用。当前支持query绑定到workload group。

workload group属性

cpu_share: 必选，用于设置workload group获取cpu时间的多少，可以实现cpu资源软隔离。cpu_share 是相对值，表示正在运行的workload group可获取cpu资源的权重。例如，用户创建了3个workload group g-a、g-b和g-c，cpu_share 分别为 10、30、40，某一时刻g-a和g-b正在跑任务，而g-c没有任务，此时g-a可获得 25% (10 / (10 + 30))的cpu资源，而g-b可获得75%的cpu资源。如果系统只有一个workload group正在运行，则不管其cpu_share的值为多少，它都可获取全部的cpu资源。
memory_limit: 必选，用于设置workload group可以使用be内存的百分比。workload group内存限制的绝对值为：物理内存 * mem_limit * memory_limit，其中 mem_limit 为be配置项。系统所有workload group的 memory_limit总合不可超过100%。workload group在绝大多数情况下保证组内任务可使用memory_limit的内存，当workload group内存使用超出该限制后，组内内存占用较大的任务可能会被cancel以释放超出的内存，参考 enable_memory_overcommit。
enable_memory_overcommit: 可选，用于开启workload group内存软隔离，默认为false。如果设置为false，则该workload group为内存硬隔离，系统检测到workload group内存使用超出限制后将立即cancel组内内存占用最大的若干个任务，以释放超出的内存；如果设置为true，则该workload group为内存软隔离，如果系统有空闲内存资源则该workload group在超出memory_limit的限制后可继续使用系统内存，在系统总内存紧张时会cancel组内内存占用最大的若干个任务，释放部分超出的内存以缓解系统内存压力。建议在有workload group开启该配置时，所有workload group的 memory_limit 总和低于100%，剩余部分用于workload group内存超发。

workload group使用

开启 experimental_enable_workload_group 配置项，在fe.conf中设置：

experimental_enable_workload_group=true

在开启该配置后系统会自动创建名为normal的默认workload group。

创建workload group：

create workload group if not exists g1
properties (
    "cpu_share"="10",
    "memory_limit"="30%",
    "enable_memory_overcommit"="true"
);

创建workload group详细可参考：CREATE-WORKLOAD-GROUP，另删除workload group可参考DROP-WORKLOAD-GROUP；修改workload group可参考：ALTER-WORKLOAD-GROUP；查看workload group可参考：WORKLOAD_GROUPS()和SHOW-WORKLOAD-GROUPS。

开启pipeline执行引擎，workload group cpu隔离基于pipeline执行引擎实现，因此需开启session变量：

set experimental_enable_pipeline_engine = true;

绑定workload group。

通过设置user property 将user默认绑定到workload group，默认为normal:

set property 'default_workload_group' = 'g1';

当前用户的查询将默认使用'g1'。

通过session变量指定workload group, 默认为空:

set workload_group = 'g2';

session变量workload_group优先于 user property default_workload_group, 在workload_group为空时，查询将绑定到default_workload_group, 在session变量workload_group不为空时，查询将绑定到workload_group。

如果是非admin用户，需要先执行SHOW-WORKLOAD-GROUPS 确认下当前用户能否看到该workload group，不能看到的workload group可能不存在或者当前用户没有权限，执行查询时会报错。给worklaod group授权参考：grant语句。

执行查询，查询将关联到指定的 workload group。

查询排队功能

create workload group if not exists test_group
properties (
    "cpu_share"="10",
    "memory_limit"="30%",
    "max_concurrency" = "10",
    "max_queue_size" = "20",
    "queue_timeout" = "3000"
);

目前的workload group支持查询排队的功能，可以在新建group时进行指定，需要以下三个参数:

max_concurrency，当前group允许的最大查询数;超过最大并发的查询到来时会进入排队逻辑
max_queue_size，查询排队的长度;当队列满了之后，新来的查询会被拒绝
queue_timeout，查询在队列中等待的时间，如果查询等待时间超过这个值，那么查询会被拒绝，时间单位为毫秒

需要注意的是，目前的排队设计是不感知FE的个数的，排队的参数只在单FE粒度生效，例如：

一个Doris集群配置了一个work load group，设置max_concurrency = 1 如果集群中有1FE，那么这个workload group在Doris集群视角看同时只会运行一个SQL 如果有3台FE，那么在Doris集群视角看最大可运行的SQL个数为3

WORKLOAD GROUP

workload group属性​

workload group使用​

查询排队功能​

workload group属性

workload group使用

查询排队功能