Query Circuit Breaker
Query circuit breakingは、長時間実行されるクエリやリソース消費の多いクエリがシステムに悪影響を与えることを防ぐ保護メカニズムです。クエリが事前定義されたリソースまたは時間の制限を超えた場合、circuit breakerメカニズムは自動的にクエリを終了し、システムパフォーマンス、リソース使用量、および他のクエリへの悪影響を回避します。このメカニズムはマルチユーザー環境でクラスターの安定性を確保し、単一のクエリがシステムリソースを枯渇させたり応答速度を低下させたりすることを防ぎ、全体的な可用性と効率を向上させます。
Dorisには、2つのタイプのcircuit breaker戦略があります：
-
Planning-time circuit breaking、すなわちSQL Block Ruleは、特定のパターンにマッチするステートメントの実行を防ぐために使用されます。Block rulesはDDLおよびDMLを含む任意のステートメントに適用されます。通常、block rulesはデータベース管理者（DBA）によってクラスターの安定性を高めるために設定されます。例えば、
- クエリが過度に多くの行のデータをスキャンすることを防ぐ
- クエリが過度に多くのパーティションをスキャンすることを防ぐ
- グローバル変数を変更するステートメントを防ぎ、クラスター設定への偶発的な変更を回避する
- 通常過度にリソースを消費するクエリパターンを防ぐ
-
Runtime circuit breaking、すなわちWorkload Policyは、クエリの実行時間、スキャンされるデータ量、およびメモリ消費をランタイム中にリアルタイムで監視し、ルールベースのquery circuit breakingを実装します。
SQL Block Rule
blockパターンに応じて、以下に分類できます：
- Scan row count block rule
- Scan partition count block rule
- Scan bucket count block rule
- Query statement regex matching block rule
- Query statement hash value matching block rule
Blocking rulesは、blockingの範囲に応じて分類できます：
- Global-levelのblocking rules
- User-levelのblocking rules
使用法
Global-levelのblocking rules
CREATE SQL_BLOCK_RULE rule_001
PROPERTIES (
"sql"="select \\* from t",
"global" = "true",
"enable" = "true"
)
このようにして、グローバルレベルのブロッキングルールを作成しました。このルールはrule_001という名前です。クエリステートメントのregex一致ルールが設定されており、regex select \\* from tに一致するすべてのクエリステートメントをブロックします。
これはグローバルレベルのブロッキングルールであるため、上記のregexに一致するステートメントを実行するすべてのユーザーがブロックされます。例えば：
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のような盲目的なフルテーブルスキャン操作がよく発生します。このようなクエリがクラスタに損害を与えることを防ぐために、単一のテーブルで単一のクエリがスキャンする行数の上限を設定できます。
CREATE SQL_BLOCK_RULE rule_card
PROPERTIES
(
"cardinality" = "1000",
"global" = "true",
"enable" = "true"
);
上記のルールが設定されている場合、単一のテーブルスキャンが1000行を超えると、クエリの実行が禁止されます。 スキャンされる行数の計算は実行フェーズではなく、プランニングフェーズで行われることに注意してください。そのため、行数を計算する際は、パーティションとバケットのpruningのみが考慮され、その他のフィルタリング条件がスキャンされる行数に与える影響は考慮されません。つまり、最悪のケースシナリオが考慮されます。そのため、実際にスキャンされる行数が設定値未満のクエリもブロックされる可能性があります。
指定されたパーティション数を超えるデータスキャンの防止
あまりにも多くのパーティションをスキャンすると、BEのCPU消費量が大幅に増加する可能性があります。さらに、クエリが外部テーブルに対するものである場合、大幅なネットワークオーバーヘッドとメタデータ取得オーバーヘッドが発生する可能性が高くなります。日常的な使用において、これはパーティション列のフィルタリング条件を書き忘れたり、正しく書けていないことが原因であることが多いです。このようなクエリがクラスターに損害を与えることを防ぐため、単一のテーブルに対する単一のクエリでスキャンされるパーティション数の上限を設定できます。
CREATE SQL_BLOCK_RULE rule_part_num
PROPERTIES
(
"partition_num" = "30",
"global" = "true",
"enable" = "true"
);
上記のルールが設定されている場合、単一テーブルでスキャンされるパーティション数が30を超えると、クエリの実行が禁止されます。 スキャンされるパーティション数の計算は実行フェーズではなく、プランニングフェーズで完了することに注意してください。そのため、不完全なパーティションプルーニングにより、より多くのパーティションが保持される場合があります。したがって、実際にスキャンされるパーティション数が設定値より少ないクエリもブロックされる可能性があります。
過剰なBucket数でのデータスキャンの防止
あまりに多くのbucketをスキャンすると、BEのCPU消費量が大幅に増加する可能性があります。このようなクエリがクラスターに害を与えることを防ぐために、単一のクエリが単一テーブルでスキャンできるパーティション数の上限を設定することができます。
CREATE SQL_BLOCK_RULE rule_teblet_num
PROPERTIES
(
"tablet_num" = "200",
"global" = "true",
"enable" = "true"
);
上記のルールが設定されている場合、単一テーブルでスキャンされるバケット数が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毎のメモリ使用量
バージョン注記
Workload Policyは大きなクエリのサーキットブレーキングの実装に使用できます。
| SQL | サポート状況 |
|---|---|
| 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 | Description |
|---|---|
| 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 | Description |
|---|---|
| cancel_query | クエリをキャンセルします。 |
| set_session_variable | set session variable文をトリガーします。単一のポリシーは複数のset_session_variableオプションを持つことができ、現在はusername ConditionによってFEでのみトリガーされます。 |
- Propertiesは現在のPolicyの属性を定義し、有効かどうかとその優先度を含みます。
| Properties | Description |
|---|---|
| enabled | trueまたはfalseを指定でき、デフォルトはtrueでPolicyが有効であることを示します。falseはPolicyが無効であることを示します。 |
| priority | 0から100の範囲の整数、デフォルトは0で、Policyの優先度を表します。値が高いほど優先度が高くなります。この属性は主に、クエリが複数のPolicyにマッチした場合に、最も優先度の高いPolicyのみが選択されることを保証します。 |
| workload_group | 現在、Policyは1つのワークロードグループにバインドでき、この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の条件とアクションは、両方ともFEであるか両方ともBEである必要があります。例えば、
set_session_variableとcancel_queryを同一Policy内で設定することはできません。条件be_scan_rowsとusernameを同一Policy内で設定することはできません。 - 現在、Policyは固定時間間隔で非同期スレッドによって実行されるため、ポリシー実行にある程度の遅延が発生します。例えば、ユーザーがスキャン行数が1,000,000を超えた場合にクエリをキャンセルするポリシーを設定し、その時点でクラスターリソースが比較的アイドル状態の場合、キャンセルポリシーが有効になる前にクエリが完了する可能性があります。現在の間隔は500msで、この間隔より短い実行時間のクエリはポリシーチェックを回避する可能性があります。
- 現在サポートされているロードタイプには、select/insert、select/stream load、broker load、routine loadが含まれます。
- 単一のクエリは複数のPolicyにマッチする可能性がありますが、最も優先度の高いPolicyのみが有効になります。
- ActionsとConditionsの変更は現在サポートされていません。削除して再作成することでのみ変更できます。
Workload Policyのデモンストレーション
1. セッション変数変更テスト
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 テスト
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