Query Circuit Breaker
クエリ回路ブレーカーは、長時間実行されるクエリやリソース集約型クエリがシステムに悪影響を与えることを防ぐ保護メカニズムです。クエリが事前に定義されたリソースまたは時間制限を超えた場合、回路ブレーカーメカニズムがクエリを自動的に終了し、システムパフォーマンス、リソース使用量、および他のクエリへの悪影響を回避します。このメカニズムにより、マルチユーザー環境でクラスターの安定性が保証され、単一のクエリがシステムリソースを枯渇させたり応答速度を低下させたりすることを防ぎ、全体的な可用性と効率性を向上させます。
Dorisでは、2つのタイプの回路ブレーカー戦略があります：
-
計画時回路ブレーキング、すなわちSQL Block Ruleで、特定のパターンに一致するステートメントの実行を防ぐために使用されます。ブロックルールはDDLおよびDMLを含む任意のステートメントに適用されます。通常、ブロックルールはクラスターの安定性を向上させるためにデータベース管理者（DBA）によって設定されます。例えば、
- クエリが過多の行データをスキャンすることを防ぐ
- クエリが過多のパーティションをスキャンすることを防ぐ
- グローバル変数を変更するステートメントを防いで、クラスター設定への偶発的変更を回避する
- 通常過多のリソースを消費するクエリパターンを防ぐ
-
実行時回路ブレーキング、すなわちWorkload Policyで、実行時にクエリの実行時間、スキャンされるデータ量、メモリ消費をリアルタイムで監視し、ルールベースのクエリ回路ブレーキングを実装します。
SQL Block Rule
ブロックパターンに応じて、以下に分類できます：
- スキャン行数ブロックルール
- スキャンパーティション数ブロックルール
- スキャンバケット数ブロックルール
- クエリステートメント正規表現マッチングブロックルール
- クエリステートメントハッシュ値マッチングブロックルール
ブロックルールは、ブロッキングの範囲に応じて以下のように分類できます：
- グローバルレベルブロッキングルール
- ユーザーレベルブロッキングルール
使用方法
グローバルレベルブロッキングルール
CREATE SQL_BLOCK_RULE rule_001
PROPERTIES (
"sql"="select \\* from t",
"global" = "true",
"enable" = "true"
)
このようにして、グローバルレベルのブロッキングルールを作成しました。このルールはrule_001という名前です。クエリステートメントの正規表現マッチングルールが設定され、正規表現select \\* from tにマッチするすべてのクエリステートメントをブロックします。
これはグローバルレベルのブロッキングルールであるため、上記の正規表現にマッチするステートメントを実行するユーザーはすべてブロックされます。例えば：
MySQL root@127.0.0.1:test> select * from t;
(1105, 'errCode = 2, detailMessage = errCode = 2, detailMessage = SQL match regex SQL block rule: rule_001')
ユーザーレベルのブロッキングルール
CREATE SQL_BLOCK_RULE rule_001
PROPERTIES (
"sql"="select * from t",
"global" = "false",
"enable" = "true"
)
グローバルレベルのブロッキングルールとは異なり、ユーザーレベルのブロッキングルールは指定されたユーザーのみに適用されます。ブロッキングルールを作成する際、プロパティ"global"を"false"に設定します。すると、このブロッキングルールはユーザーレベルのブロッキングルールとして扱われます。
ユーザーレベルのブロッキングルールを有効にするには、このルールを使用する必要があるユーザーに対して、対応するプロパティを設定する必要もあります。例えば：
set property for 'root' 'SQL_block_rules' = 'rule_001';
したがって、上記の設定後、rootユーザーがクエリを実行すると、rule_001という名前のブロッキングルールが適用されます。
MySQL root@127.0.0.1:test> set property for 'root' 'SQL_block_rules' = '';
Query OK, 0 rows affected
Time: 0.018s
MySQL root@127.0.0.1:test> select * from t;
+----+----+
| id | c1 |
+----+----+
| 1 | 1 |
+----+----+
1 row in set
Time: 0.027s
MySQL root@127.0.0.1:test> set property for 'root' 'SQL_block_rules' = 'rule_001';
Query OK, 0 rows affected
Time: 0.008s
MySQL root@127.0.0.1:test> select * from t;
(1105, 'errCode = 2, detailMessage = errCode = 2, detailMessage = SQL match regex SQL block rule: rule_001')
- ユーザーに対して複数のユーザーレベルブロッキングルールを追加したい場合は、ルールリストにすべてのルール名をカンマで区切って記載してください。
- ユーザーのすべてのユーザーレベルブロッキングルールを削除したい場合は、ルールリストを空文字列に設定してください。
その他の操作
ブロッキングルールを変更または削除する必要がある場合は、ブロッキングルールに関するSQLマニュアルを参照してください。
使用例
以下のシナリオで使用できます：
- 指定した行数を超えるスキャンをブロック
- 指定したパーティション数を超えるスキャンをブロック
- 指定したバケット数を超えるスキャンをブロック
- 特定のパターンを持つクエリをブロック
指定した行数を超えるスキャンをブロック
データのスキャンはBEのIOおよびCPUリソースを大幅に消費します。そのため、不要なデータスキャンはクラスタの安定性にとって大きな課題となります。日常的な使用において、SELECT * FROM tのような盲目的なフルTableスキャン操作がしばしば発生します。このようなクエリがクラスタに損害を与えることを防ぐため、単一のクエリが単一のTableでスキャンする行数の上限を設定できます。
CREATE SQL_BLOCK_RULE rule_card
PROPERTIES
(
"cardinality" = "1000",
"global" = "true",
"enable" = "true"
);
上記のルールが設定されている場合、単一のTableスキャンが1000行を超えると、クエリの実行が禁止されます。 スキャンされる行数の計算は実行フェーズではなく計画フェーズで行われることに注意してください。そのため、行数を計算する際は、パーティションとbucketプルーニングのみが考慮され、スキャンされる行数に対する他のフィルタリング条件の影響は考慮されません。つまり、最悪のケースが考慮されます。そのため、実際にスキャンされる行数が設定値より少ないクエリもブロックされる可能性があります。
指定されたパーティション数を超えるデータのスキャンを防ぐ
多くのパーティションをスキャンすると、BEのCPU消費量が大幅に増加する可能性があります。さらに、クエリが外部Tableに対するものである場合、大きなネットワークオーバーヘッドとメタデータ取得オーバーヘッドが発生する可能性が高くなります。日常の使用では、これはパーティション列のフィルタリング条件の記述を忘れたり、間違って記述したりすることが原因であることが多いです。このようなクエリがクラスタに損害を与えることを防ぐため、単一のTableに対する単一のクエリでスキャンされるパーティション数の上限を設定できます。
CREATE SQL_BLOCK_RULE rule_part_num
PROPERTIES
(
"partition_num" = "30",
"global" = "true",
"enable" = "true"
);
上記のルールが設定されている場合、単一Tableでスキャンされるパーティション数が30を超えると、クエリの実行が禁止されます。 スキャンされるパーティション数の計算は実行フェーズではなく、プランニングフェーズで完了することに注意してください。そのため、不完全なパーティションプルーニングにより、より多くのパーティションが保持される場合があります。したがって、実際にスキャンされるパーティション数が設定値より少ないクエリもブロックされる可能性があります。
過度なバケット数でのデータスキャンの防止
あまりにも多くのバケットをスキャンすることは、BEのCPU消費量を大幅に増加させる可能性があります。このようなクエリがクラスターに害を与えることを防ぐために、単一のクエリが単一Tableでスキャンできるパーティション数に上限を設定することができます。
CREATE SQL_BLOCK_RULE rule_teblet_num
PROPERTIES
(
"tablet_num" = "200",
"global" = "true",
"enable" = "true"
);
上記のルールが設定されている場合、単一のTableでスキャンされるバケット数が200を超えると、クエリの実行が禁止されます。
スキャンされるバケット数の計算は実行フェーズではなく、プランニングフェーズで行われることに注意することが重要です。そのため、不完全なバケットプルーニングにより、より多くのパーティションが保持される可能性があります。その結果、実際のスキャンバケット数が設定値より少ないクエリもブロックされる可能性があります。
特定のパターンを持つクエリのブロック
高い計算複雑度や長いプランニング時間など、様々な理由により、特定のパターンを使用するクエリをブロックしたい場合があります。
例えば、abs関数をブロックする場合です。この目的を達成するために、以下の正規表現ブロックルールを使用できます。
CREATE SQL_BLOCK_RULE rule_abs
PROPERTIES(
"sql"="(?i)abs\\s*\\(.+\\)",
"global"="true",
"enable"="true"
);
上記の正規表現において：
(?i)は大文字小文字を区別しないマッチングを示します。absはブロック対象のターゲット関数です。\s*はabsと左括弧の間に任意の量の空白文字が許可されることを意味します。\(.+\)は関数パラメータにマッチします。
同様に、類似の方法を使用して set global をブロックして意図しない変数変更を防いだり、truncate table をブロックして意図しないデータ削除を防いだりできます。
FAQ
Q: 正規表現ブロッキングルールはクラスタに副作用がありますか？
A: はい。正規表現マッチングは計算集約的です。複雑な正規表現や過度に多くのregexブロッキングルールを使用する場合、FE上のCPU負荷を大幅に増加させる可能性があります。そのため、regexブロッキングルールは慎重に追加してください。必要でない限り複雑な正規表現の使用は避けてください。
Q: ブロッキングルールを一時的に無効にできますか？
A: はい。ブロッキングルールを変更して、その"enable"プロパティを"false"に設定してください。
Q: ブロッキングルール内の正規表現はどの標準を使用しますか？
A: ブロッキングルール内の正規表現はJavaの正規表現構文を使用します。一般的な表現についてはSQL構文マニュアルを参照してください。完全なマニュアルは https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html にあります
Workload Policy
SQL Block Ruleは計画時のサーキットブレーカー用設定ですが、計画時のコスト計算が不正確になる場合があり（特に非常に複雑なクエリの場合、正確な見積もりが困難）、ルールが効果的でなかったり誤検出を引き起こす可能性があります。Workload Policyは、クエリ実行中の特定のメトリクスをリアルタイムで監視し、実行時状態が期待に応えないクエリをサーキットブレークできるようにすることで、この制限に対処します。これにより、予期しない大きなクエリが過度なリソースを消費してクラスタの安定性に影響を与えることを防ぎます。一般的な実行時監視メトリクスは以下の通りです：
- クエリ実行時間
- BE当たりのスキャン行数
- BE当たりのスキャンバイト数
- BE当たりのメモリ使用量
バージョン情報
Dorisバージョン2.1以降、Workload Policyを使用して大きなクエリのサーキットブレークを実装できます。
| Version | since 2.1 |
|---|---|
| select | yes |
| insert into select | yes |
| insert into values | no |
| stream load | yes |
| routine load | yes |
| backup | no |
| compaction | no |
Workload Policyの作成
CREATE WORKLOAD Policy コマンドを使用してリソース管理ポリシーを作成します。
以下の例では、test_cancel_Policy という名前のPolicyを作成し、クラスタ内で1000ms以上実行されているクエリをキャンセルします。現在のステータスは有効です。Workload Policyを作成するには admin_priv 権限が必要です。
create workload policy test_cancel_Policy
Conditions(query_time > 1000)
Actions(cancel_query)
properties('enabled'='true');
Workload Policyを作成する際、以下を指定する必要があります：
- Conditionはポリシーのトリガー条件を表します。複数のConditionはカンマ「,」で連結することで「AND」関係を表現できます。上記の例では、
query_time > 1000はクエリ時間が1秒を超えた場合にPolicyがトリガーされることを示しています。現在サポートされているConditionは以下の通りです：
| Conditions | デスクリプション |
|---|---|
| username | クエリが持つユーザー名で、FEでのset_session_variable Actionのみをトリガーします。 |
| be_scan_rows | 単一のBEプロセスでSQLがスキャンした行数。SQLがBE上で並行実行される場合、複数の並行実行の累積値となります。 |
| be_scan_bytes | 単一のBEプロセスでSQLがスキャンしたバイト数。SQLがBE上で並行実行される場合、複数の並行実行の累積値となります。単位はバイトです。 |
| query_time | 単一のBEプロセスでのSQLの実行時間。単位はミリ秒です。 |
| query_be_memory_bytes | 単一のBEプロセスでのSQLのメモリ使用量。SQLがBE上で並行実行される場合、複数の並行実行の累積値となります。単位はバイトです。 |
- Actionは条件がトリガーされた際に実行されるアクションを表します。現在、Policyは1つのActionのみ定義できます（
set_session_variableを除く）。上記の例では、cancel_queryはクエリのキャンセルを示しています。現在サポートされているActionは以下の通りです：
| Actions | デスクリプション |
|---|---|
| cancel_query | クエリをキャンセルします。 |
| set_session_variable | set session variable文をトリガーします。単一のポリシーは複数のset_session_variableオプションを持つことができ、現在はusername ConditionによってFEでのみトリガーされます。 |
- Propertiesは現在のPolicyの属性を定義し、有効かどうかとその優先度を含みます。
| Properties | デスクリプション |
|---|---|
| enabled | trueまたはfalseを指定でき、デフォルトはtrueでPolicyが有効であることを示します。falseはPolicyが無効であることを示します。 |
| priority | 0から100の整数で、デフォルトは0、Policyの優先度を表します。値が高いほど優先度が高くなります。この属性は主に、クエリが複数のPolicyにマッチした場合、最も優先度の高いPolicyのみが選択されることを保証します。 |
| workload_group | 現在、Policyは1つのworkload groupにバインドでき、このPolicyが特定のWorkload Groupからのクエリにのみ適用されることを意味します。デフォルトは空で、すべてのクエリに適用されることを意味します。 |
Workload PolicyをWorkload Groupにバインドする
デフォルトでは、Workload Policyはサポートされているすべてのクエリに適用されます。Policyが特定のWorkload Groupのみを対象とするように指定したい場合、workload_groupオプションを通じてWorkload Groupをバインドする必要があります。文は以下の通りです：
create workload policy test_cancel_big_query
Conditions(query_time > 1000)
Actions(cancel_query)
properties('workload_group'='normal')
重要事項
- 同じPolicyのConditionsとActionsは、両方がFEであるか、両方がBEである必要があります。例えば、
set_session_variableとcancel_queryは同じPolicy内で設定することはできません。Conditionsbe_scan_rowsとusernameは同じPolicy内で設定することはできません。 - 現在、Policiesは固定時間間隔で非同期スレッドによって実行されるため、ポリシー実行に一定の遅延が発生します。例えば、ユーザーがスキャンした行数が1,000,000を超えた場合にクエリをキャンセルするポリシーを設定し、その時点でクラスターリソースが比較的アイドル状態である場合、キャンセルポリシーが有効になる前にクエリが完了する可能性があります。現在の間隔は500msであり、この間隔よりも短い実行時間のクエリはポリシーチェックを回避する可能性があります。
- 現在サポートされている負荷タイプには、select/insert、select/stream load、broker load、routine loadが含まれます。
- 単一のクエリは複数のPoliciesと一致する可能性がありますが、最も高い優先度を持つPolicyのみが有効になります。
- ActionsとConditionsの変更は現在サポートされておらず、削除して再作成することによってのみ変更できます。
Workload Policy実演
1. Session Variable変更テスト
Adminアカウントのセッション変数で並行性関連パラメータの変更を試行します。
-- log on admin to check variables
show variables like '%parallel_fragment_exec_instance_num%';
+-------------------------------------+-------+---------------+---------+
| Variable_name | Value | Default_Value | Changed |
+-------------------------------------+-------+---------------+---------+
| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
+-------------------------------------+-------+---------------+---------+
1 row in set (0.00 sec)
-- Create a Policy to modify the concurrency parameters of the admin account.
create workload Policy test_set_var_Policy
Conditions(username='admin')
Actions(set_session_variable 'parallel_fragment_exec_instance_num=1')
-- After some time, check the admin account's parameters again.
show variables like '%parallel_fragment_exec_instance_num%';
+-------------------------------------+-------+---------------+---------+
| Variable_name | Value | Default_Value | Changed |
+-------------------------------------+-------+---------------+---------+
| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
+-------------------------------------+-------+---------------+---------+
1 row in set (0.01 sec)
2. Big Query Circuit Breaker Test
3秒以上実行されるクエリをサーキットブレイクするテストです。以下は、ckbenchのq29の成功実行の監査ログで、このSQLの完了に4.5秒かかったことを示しています。
mySQL [hits]>SELECT REGEXP_REPLACE(Referer, '^https?://(?:www\.)?([^/]+)/.*$', '\1') AS k, AVG(length(Referer)) AS l, COUNT(*) AS c, MIN(Referer) FROM hits WHERE Referer <> '' GROUP BY k HAVING COUNT(*) > 100000 ORDER BY l DESC LIMIT 25;
+-----------------------------------------------------------------------+------------------+----------+---------------------------------------------------------------------------------------------------------------------+
| k | l | c | min(Referer) |
+-----------------------------------------------------------------------+------------------+----------+---------------------------------------------------------------------------------------------------------------------+
| 1 | 85.4611926713085 | 67259319 | http://%26ad%3D1%25EA%25D0%26utm_source=web&cd=19590&input_onlist/би-2 место будущей кондицин |
| http:%2F%2Fwwww.regnancies/search&evL8gE&where=all&filmId=bEmYZc_WTDE | 69 | 207347 | http:%2F%2Fwwww.regnancies/search&evL8gE&where=all&filmId=bEmYZc_WTDE |
| http://новострашная | 31 | 740277 | http://новострашная |
| http://loveche.html?ctid | 24 | 144901 | http://loveche.html?ctid |
| http://rukodeliveresult | 23 | 226135 | http://rukodeliveresult |
| http://holodilnik.ru | 20 | 133893 | http://holodilnik.ru |
| http://smeshariki.ru | 20 | 210736 | http://smeshariki.ru |
| http:%2F%2Fviewtopic | 20 | 391115 | http:%2F%2Fviewtopic |
| http:%2F%2Fwwww.ukr | 19 | 655178 | http:%2F%2Fwwww.ukr |
| http:%2F%2FviewType | 19 | 148907 | http:%2F%2FviewType |
| http://state=2008 | 17 | 139630 | http://state=2008 |
+-----------------------------------------------------------------------+------------------+----------+---------------------------------------------------------------------------------------------------------------------+
11 rows in set (4.50 sec)
3秒以上実行されるクエリをキャンセルするPolicyを作成します。
create workload Policy test_cancel_3s_query
Conditions(query_time > 3000)
Actions(cancel_query)
SQLを再実行すると、SQL実行が直接エラーを報告することが確認できます。
mySQL [hits]>SELECT REGEXP_REPLACE(Referer, '^https?://(?:www\.)?([^/]+)/.*$', '\1') AS k, AVG(length(Referer)) AS l, COUNT(*) AS c, MIN(Referer) FROM hits WHERE Referer <> '' GROUP BY k HAVING COUNT(*) > 100000 ORDER BY l DESC LIMIT 25;
ERROR 1105 (HY000): errCode = 2, detailMessage = (127.0.0.1)[CANCELLED]query cancelled by workload Policy,id:12345