AnalyticDB for MySQL在數據庫系統中提供了工作負載管理模塊，您可以使用Workload Manager命令配置工作負載管理規則，并通過多個規則對不同負載進行精細化控制，提高集群的整體運行狀態。本文介紹如何配置工作負載管理規則。
前提條件
AnalyticDB for MySQL集群需要同時滿足以下條件：
集群系列需為數倉版。
集群的內核版本需為3.1.6.3及以上版本。
說明如何查看和升級集群內核版本，請參見查看和升級版本。
注意事項
僅3.1.10.0及以上內核版本的集群支持使用WLM命令修改規則。
AnalyticDB for MySQL對規則采用軟刪除策略，要求規則名稱唯一，所以重建的新規則不能與已刪除規則使用相同的規則名稱。
創建規則
語法
wlm add_rule
name=<ruleName>
type=query
action=<ruleAtion>
predicate='<property><operator><value> && <property><operator><value>'
[attrs='<ruleAttrs>']
[resource_group=<ruleResource_group>]
[description='<ruleDescription>']
[compatible_group=<compatible_group_name>]
[enabled=<ruleEnabled>]
[priority=<rulePriority>]等號兩側不允許有空格。
參數說明
參數名稱 | 是否必填 | 參數說明 |
name | 是 | 規則名稱。 說明 規則名稱要求唯一，新建規則不能與已刪除規則使用相同的規則名稱。 |
type | 是 | 規則類型，固定為query。 |
action | 是 | 工作負載管理提供的控制手段，滿足匹配條件后，會觸發操作。 控制手段的詳細說明，請參見控制手段。 |
predicate | 是 | 謂詞條件。 predicate語法：
|
attrs | 否 | 當action為RESUBMIT_RESOURCE_GROUP、ADD_PROPERTIES或BLOCK_WITH_PROB時attrs為必填項。 如何填寫attrs，請參見控制手段的配置方法。 說明 填寫該參數時，兩側需要使用單引號。 |
resource_group | 否 | 資源組名稱，默認為user_default。 說明 您可以登錄云原生數據倉庫AnalyticDB MySQL控制臺，單擊目標集群ID，在資源組管理頁面查看集群的資源組。 |
description | 否 | 描述信息。 說明 填寫該參數時，兩側需要使用單引號。 |
compatible_group | 否 | 相容組。 默認情況下，匹配規則的方式是從規則的優先級由高到低依次匹配規則，匹配到一條就直接結束。也可以將同時匹配多條規則的需求設置為同一個相容組。在規則匹配時，優先匹配優先級最高的規則，如果已匹配的規則存在相容組，相容組中剩余規則如有能同時匹配的，則同時匹配。 |
enabled | 否 | 是否啟用規則，取值說明：
|
priority | 否 | 啟用優先級高的規則，默認為0。 每次匹配規則，只會匹配一條優先級最高的規則，優先級相同時，則根據創建時間越早的規則先進行匹配。 |
示例
示例1：創建一條規則名稱為testRule1的規則，當用戶名為test且Pattern歷史執行時間50分位值大于60000 ms時結束查詢。
wlm add_rule name=testRule1 type=query action=kill predicate='user=test && PATTERN_RT_P50>60000';返回結果如下：
+---------------------------------+ | result | +---------------------------------+ | insert rule 'testRule1' success | +---------------------------------+示例2：創建一條規則名稱為testRule2的規則，將用戶名為test且用戶IP在（10.10.10.10，192.168.0.1，192.0.2.1）中的查詢，增加
query_priority=low的Hint，將查詢優先級設置為low。wlm add_rule name=testRule2 type=query action=ADD_PROPERTIES attrs='{"add_prop":{"query_priority":"low"}}' predicate='user=test && source_ip in 10.10.10.10,192.168.0.1,192.0.2.1';返回結果如下：
+---------------------------------+ | result | +---------------------------------+ | insert rule 'testRule2' success | +---------------------------------+示例3：為testResourceGroup資源組創建一條規則名稱為testRule3的規則，優先級為5，將用戶名為test且類型為select的所有查詢全部結束。
wlm add_rule name=testRule3 type=query resource_group=testResourceGroup description='just a test' priority=5 action=kill predicate='user=test && query_task_type=1';返回結果如下：
+---------------------------------+ | result | +---------------------------------+ | insert rule 'testRule3' success | +---------------------------------+
修改規則
僅3.1.10.0及以上內核版本的集群支持使用WLM命令修改規則。
如何查看集群內核版本，請參見如何查看實例版本信息。如需升級內核版本，請聯系技術支持。
語法
wlm update_rule
id=<ruleId>
name=<ruleName>
type=query
action=<ruleAtion>
predicate='<property><operator><value> && <property><operator><value>'
[attrs='<ruleAttrs>']
[resource_group=<ruleResource_group>]
[description='<ruleDescription>']
[compatible_group=<compatible_group_name>]
[enabled=<ruleEnabled>]
[priority=<rulePriority>]等號兩側不允許有空格。
參數說明
參數名稱 | 是否必填 | 參數說明 |
id | 否 | 規則ID。規則ID是唯一的，用于匹配相應規則，且不支持修改。 說明 您可以通過 |
name | 否 | 規則名稱。修改規則名稱時，需要使用規則ID匹配相應規則。 說明 修改后的規則不能與已創建的規則使用相同的規則名稱，否則會覆蓋已創建的同名規則。 |
type | 否 | 規則類型，固定為query。 |
action | 否 | 工作負載管理提供的控制手段，滿足匹配條件后，會觸發操作。 控制手段的詳細說明，請參見控制手段。 |
predicate | 否 | 謂詞條件。 predicate語法：
|
attrs | 否 | 當action為RESUBMIT_RESOURCE_GROUP、ADD_PROPERTIES或BLOCK_WITH_PROB時attrs為必填項。 如何填寫attrs，請參見控制手段的配置方法。 填寫該參數時，兩側需要使用單引號。 |
resource_group | 否 | 資源組名稱，默認為user_default。 說明 您可以登錄云原生數據倉庫AnalyticDB MySQL控制臺，單擊目標集群ID，在資源組管理頁面查看集群的資源組。 |
description | 否 | 描述信息。 說明 填寫該參數時，兩側需要使用單引號。 |
compatible_group | 否 | 相容組。 默認情況下，匹配規則的方式是從規則的優先級由高到低依次匹配規則，匹配到一條就直接結束。也可以將同時匹配多條規則的需求設置為同一個相容組。在規則匹配時，優先匹配優先級最高的規則，如果已匹配的規則存在相容組，相容組中剩余規則如有能同時匹配的，則同時匹配。 |
enabled | 否 | 是否啟用規則，取值說明：
|
priority | 否 | 啟用優先級高的規則，默認為0。 每次匹配規則，只會匹配一條優先級最高的規則，優先級相同時，則根據創建時間越早的規則先進行匹配。 |
示例
示例1：將規則ID為2的規則名稱修改為Rule。
wlm update_rule id=2 name=Rule;返回結果如下：
+-----------------+ | result | +-----------------+ | update rule 2 | +-----------------+示例2：將testRule1規則的條件修改為當用戶名為test且Pattern歷史執行時間50分位值大于80000 ms時結束查詢。
wlm update_rule name=testRule1 predicate='user=test && PATTERN_RT_P50>80000';或使用testRule1規則所對應的規則ID修改：
wlm update_rule id=1 predicate='user=test && PATTERN_RT_P50>80000';返回結果如下：
+-----------------+ | result | +-----------------+ | update rule 1 | +-----------------+示例3：將滿足testRule1規則的查詢投遞至testgroup資源組繼續執行。
修改前，testRule1規則為kill掉滿足條件的查詢：
wlm add_rule name=testRule1 type=query action=kill predicate='user=test && PATTERN_RT_P50>60000';修改testRule1規則，把當前資源組的查詢都投遞到testgroup資源組執行：
wlm update_rule name=testRule1 action=RESUBMIT_RESOURCE_GROUP attrs='{ "resubmit":{ "resource_group": "testgroup" } }'說明如何填寫attrs，請參見控制手段的配置方法。
返回結果如下：
+-----------------+ | result | +-----------------+ | update rule 1 | +-----------------+
查詢規則
語法
wlm list_rule
[id=<ruleID>]
[name='<ruleName>'\G]參數說明
參數名稱 | 是否必填 | 參數說明 |
id | 否 | 規則ID。 說明 不填寫ID和name將查詢所有未被刪除的規則，包括規則ID。 |
name | 否 | 規則名稱。 說明
|
\G | 否 | 將查詢結果按列打印，將每個字段打印到單獨的行。 |
示例
示例1：查詢規則ID為testID1的規則。
wlm list_rule id=1 \G;返回結果如下：
id: 1 name: testRule4 description: NULL type: QUERY resource_group: user_default enabled: 1 priority: 0 version: 1 life_cycle: BEFORE_QUEUEING compatible_group: valid_begin: null valid_end: null creator: kepler update_user: kepler create_time: 2022-09-16 14:00:18 update_time: 2022-09-16 14:00:18 predicate: [{"property":"${session.user}","value":"test","operator":"equal"},{"property":"${session.source_ip}","value":"1,2,3","operator":"in"}] action: ADD_PROPERTIES attrs: {"add_prop":{"query_priority":"low"}} 1 row in set (0.11 sec)示例2：查詢規則ID為testID1，規則名稱為testRule4的規則。
mysql> wlm list_rule id=1 name='testRule4' \G;返回結果如下：
id: 1 name: testRule4 description: NULL type: QUERY resource_group: user_default enabled: 1 priority: 0 version: 1 life_cycle: BEFORE_QUEUEING compatible_group: valid_begin: null valid_end: null creator: kepler update_user: kepler create_time: 2022-09-16 14:00:18 update_time: 2022-09-16 14:00:18 predicate: [{"property":"${session.user}","value":"test","operator":"equal"},{"property":"${session.source_ip}","value":"1,2,3","operator":"in"}] action: ADD_PROPERTIES attrs: {"add_prop":{"query_priority":"low"}} 1 row in set (0.09 sec)
屏蔽規則
語法
wlm disable_rule id=<ruleID>參數說明
參數名稱 | 是否必填 | 參數說明 |
id | 是 | 規則ID。 說明 您可以執行 |
示例
示例1：屏蔽ID為testID1的規則。
wlm disable_rule id=1;返回結果如下：
+------------------+ | result | +------------------+ | disable rule 1 | +------------------+示例2：查詢ID為testID1的規則。
wlm list_rule id=1\G;返回結果如下：
id: 1 name: testRule4 description: NULL type: QUERY resource_group: user_default enabled: 0 priority: 0 version: 1 life_cycle: BEFORE_QUEUEING compatible_group: valid_begin: null valid_end: null creator: kepler update_user: kepler create_time: 2022-09-16 14:00:18 update_time: 2022-09-16 14:00:18 predicate: [{"property":"${session.user}","value":"test","operator":"equal"},{"property":"${session.source_ip}","value":"1,2,3","operator":"in"}] action: ADD_PROPERTIES attrs: {"add_prop":{"query_priority":"low"}}
啟用規則
語法
wlm enable_rule id=<ruleID>參數說明
參數名稱 | 是否必填 | 參數說明 |
id | 是 | 規則ID。 說明 您可以執行 |
示例
示例1：啟用ID為testID1的規則。
wlm enable_rule id=1;返回結果如下：
+----------------+ | result | +----------------+ | enable rule 1 | +----------------+示例2：查詢ID為testID1的規則。
wlm list_rule id=1\G;返回結果如下：
id: 1 name: testRule4 description: NULL type: QUERY resource_group: user_default enabled: 1 priority: 0 version: 1 life_cycle: BEFORE_QUEUEING compatible_group: valid_begin: null valid_end: null creator: kepler update_user: kepler create_time: 2022-09-16 14:00:18 update_time: 2022-09-16 14:00:18 predicate: [{"property":"${session.user}","value":"test","operator":"equal"},{"property":"${session.source_ip}","value":"1,2,3","operator":"in"}] action: ADD_PROPERTIES attrs: {"add_prop":{"query_priority":"low"}}
刪除規則
語法
wlm delete_rule id=<ruleID>參數說明
參數名稱 | 是否必填 | 參數說明 |
id | 是 | 規則ID。 說明 您可以執行 |
示例
示例1：刪除ID為testID1的規則。
wlm delete_rule id=1;返回結果如下：
+----------------+ | result | +----------------+ | delete rule 1 | +----------------+示例2：查詢ID為testID1的規則。
wlm list_rule id=1\G;返回結果如下：
Empty set
計算pattern_hash
語法
wlm calc_pattern_hash <SQL>參數說明
參數說明 | 是否必填 | 說明 |
SQL | 是 | SELECT語句或帶有SELECT的寫入語句。 |
示例
計算查詢語句的pattern_hash。
wlm calc_pattern_hash select * from t where a=1 and b=2;返回結果如下：
+-----------------------------------+----------------------+
| raw_sql | pattern_hash |
+-----------------------------------+----------------------+
| select * from t where a=1 and b=2 | -4759960226441980963 |
+-----------------------------------+----------------------+打印WLM幫助信息
不帶任何參數執行wlm命令即會打印幫助信息。
wlm;返回結果如下：
+---------------------------+-------------------------------------+
| command | description |
+---------------------------+-------------------------------------+
| calc_pattern_hash | calculate pattern_hash of query |
| add_rule | add a new rule |
| list_rule id=[x]|name=[x] | list all rules OR filter by id/name |
| disable_rule id=[x] | disable a rule by id |
| enable_rule id=[x] | enable a rule by id |
| delete_rule id=[x] | delete a rule by id |
| update_rule id=[x] | update a rule by id |
+---------------------------+-------------------------------------+附錄
附錄1：屬性
類別 | 字段 | 數據類型 | 說明 |
查詢屬性 | user | 字符串 | 發送查詢的用戶。 |
source_ip | 字符串 | 發送查詢的IP。 | |
query_task_type | 數值 | 查詢的類型，取值說明：
| |
query_table_list | 字符串列表 | 查詢掃描到的表。 | |
query_db_list | 字符串列表 | 查詢掃描到的數據庫。 | |
pattern_hash | 數值 | 查詢Pattern的Hash值，用于確定同類Pattern的查詢。 | |
sql | 字符串 | 查詢原始的SQL語句。 重要 僅3.1.8.3及以上內核版本的集群支持該屬性。 | |
查詢運行時指標 說明 查詢運行時指標用于在查詢進入隊列后，對查詢進行控制。 | QUERY_PROCESS_TIME | 數值 | 查詢過程中所有Task的耗時總和，可以粗略地衡量一個查詢的計算量。單位：ms。 |
QUERY_EXECUTION_TIME | 數值 | 查詢執行耗時（不含排隊耗時）。單位：ms。 | |
QUERY_SUBMITTED_TIME | 數值 | 創建查詢的時間戳。 | |
QUERY_TOTAL_TASK | 數值 | 查詢物理執行計劃Task總數。 | |
QUERY_INPUT_DATA_SIZE | 數值 | 查詢的讀取數據量。單位：MB。 | |
QUERY_SHUFFLE_DATA_SIZE | 數值 | 查詢的Shuffle數據量。單位：MB。 | |
QUERY_OUTPUT_DATA_SIZE | 數值 | 查詢的輸出數據量。單位：MB。 | |
QUERY_PEAK_MEMORY | 數值 | 查詢的Peak Memory，單位：MB。 | |
QUERY_TOTAL_STAGES | 數值 | 查詢執行計劃的Stages總數。 | |
查詢Pattern屬性 說明 查詢Pattern屬性可以反映查詢歷史的執行情況。 | PATTERN_RT_P50 | 數值 | 同Pattern查詢歷史執行時間50分位值。單位：ms。 |
PATTERN_RT_P90 | 數值 | 同Pattern查詢歷史執行時間90分位值。單位：ms。 | |
PATTERN_EXECUTION_TIME_P50 | 數值 | 同Pattern查詢歷史執行時間（去除排隊）50分位值。單位：ms。 | |
PATTERN_EXECUTION_TIME_P90 | 數值 | 同Pattern查詢歷史執行時間（去除排隊）90分位值。單位：ms。 | |
PATTERN_WALL_TIME_P50 | 數值 | 同Pattern查詢歷史Wall Time50分位值。單位：ms。 | |
PATTERN_WALL_TIME_P90 | 數值 | 同Pattern查詢歷史Wall Time90分位值。單位：ms。 | |
PATTERN_SHUFFLE_SIZE_AVG | 數值 | 同Pattern查詢歷史Shuffle數據平均值。單位：單位：Byte。 | |
PATTERN_PEAK_MEMORY_AVG | 數值 | 同Pattern查詢歷史Peak Memory平均值。單位：Byte。 | |
PATTERN_INPUT_POSITION_AVG | 數值 | 同Pattern查詢歷史輸入記錄數平均值。單位：行。 | |
PATTERN_OUTPUT_POSITION_AVG | 數值 | 同Pattern查詢歷史輸出記錄數平均值。單位：行。 |
附錄2：運算符
運算符 | 適用的數據類型 | 說明 |
> | 數值 | 無 |
< | 數值 | 無 |
= | 數值、字符串 | 無 |
>= | 數值 | 無 |
<= | 數值 | 無 |
!= | 數值、字符串 | 無 |
in | 字符串列表 | 字符串列表是否存在交集。 |
contains | 字符串 | 字符串中是否包含某些特定字符串，主要用于查詢原始的SQL語句。 重要 僅3.1.8.3及以上內核版本的集群支持該運算符。 |
附錄3：控制手段
控制手段 | 說明 | attrs配置方法 |
KILL | 結束查詢。 | 無 |
RESUBMIT_RESOURCE_GROUP | 停止當前資源組內滿足條件查詢，并提交到另一個資源組執行。 | { "resubmit": {"resource_group":"<resource_group_name>"}} resource_group_name：資源組名稱。 說明 您可以登錄云原生數據倉庫AnalyticDB MySQL控制臺，單擊目標集群ID，在資源組管理頁面查看集群的資源組。 |
ADD_PROPERTIES | 修改查詢的屬性。通常用于修改查詢優先級，也可以修改Hint配置的其他查詢屬性。 | { "add_prop": {"query_priority": "<Priority level>", "force":"false"}}
|
BLOCK_WITH_PROB | 以一定概率在查詢入隊前結束查詢。通常用于限流。 | { "block_prob": {"prob":<prob_value>}} prob_value：結束查詢的概率，取值范圍為0~1。 |