TiDB メモリ制御

現在、TiDB は単一の SQL クエリのメモリ クォータを追跡し、メモリ使用量が特定のしきい値を超えた場合に OOM (メモリ不足) を防止したり、OOM のトラブルシューティングを行ったりするためのアクションを実行できます。システム変数tidb_mem_oom_actionは、クエリがメモリ制限に達したときに実行するアクションを指定します。

  • LOGの値は、 tidb_mem_quota_queryの制限に達したときにクエリが引き続き実行されることを意味しますが、TiDB はログにエントリを出力します。
  • CANCELは、TiDB がtidb_mem_quota_query制限に達した直後に SQL クエリの実行を停止し、クライアントにエラーを返すことを意味します。エラー情報には、SQL 実行プロセスでメモリを消費する各物理実行演算子のメモリ使用量が明確に示されます。

クエリのメモリ クォータを構成する

システム変数tidb_mem_quota_queryは、クエリの制限をバイト単位で設定します。いくつかの使用例:

-- Set the threshold value of memory quota for a single SQL query to 8GB: SET tidb_mem_quota_query = 8 << 30;
-- Set the threshold value of memory quota for a single SQL query to 8MB: SET tidb_mem_quota_query = 8 << 20;
-- Set the threshold value of memory quota for a single SQL query to 8KB: SET tidb_mem_quota_query = 8 << 10;

tidb-server インスタンスのメモリ使用量のしきい値を構成する

TiDB 構成ファイルで、 server-memory-quotaを構成することにより、tidb-server インスタンスのメモリ使用量のしきい値を設定できます。

次の例では、tidb-server インスタンスの合計メモリ使用量を 32 GB に設定します。

[performance] server-memory-quota = 34359738368

この構成では、tidb-server インスタンスのメモリ使用量が 32 GB に達すると、メモリ使用量が 32 GB を下回るまで、インスタンスは実行中の SQL ステートメントをランダムに強制終了し始めます。強制終了された SQL 操作は、クライアントにOut Of Global Memory Limit!エラー メッセージを返します。

過剰なメモリ使用量のアラームをトリガーする

デフォルトの構成では、マシンのメモリ使用量が合計メモリの 80% に達すると、tidb-server インスタンスはアラーム ログを出力し、関連するステータス ファイルを記録します。 memory-usage-alarm-ratioを構成することで、メモリ使用率のしきい値を設定できます。詳細なアラーム ルールについては、 memory-usage-alarm-ratioの説明を参照してください。

アラームが一度トリガーされた後、メモリ使用率が 10 秒以上しきい値を下回り、再びしきい値に達した場合にのみ、アラームが再度トリガーされることに注意してください。さらに、アラームによって生成された過剰なステータス ファイルを保存しないようにするために、現在、TiDB は最近の 5 つのアラーム中に生成されたステータス ファイルのみを保持します。

次の例では、アラームをトリガーするメモリ集約型の SQL ステートメントを作成します。

  1. memory-usage-alarm-ratio0.8を設定:

    [performance] memory-usage-alarm-ratio = 0.8
  2. CREATE TABLE t(a int);を実行し、1000 行のデータを挿入します。

  3. select * from t t1 join t t2 join t t3 order by t1.aを実行します。この SQL ステートメントは 10 億件のレコードを出力します。これは大量のメモリを消費するため、アラームがトリガーされます。

  4. 合計システム メモリ、現在のシステム メモリ使用量、tidb-server インスタンスのメモリ使用量、およびステータス ファイルのディレクトリを記録するtidb.logのファイルを確認します。

    [2020/11/30 15:25:17.252 +08:00] [WARN] [memory_usage_alarm.go:141] ["tidb-server has the risk of OOM. Running SQLs and heap profile will be recorded in record path"] ["is server-memory-quota set"=false] ["system memory total"=33682427904] ["system memory usage"=27142864896] ["tidb-server memory usage"=22417922896] [memory-usage-alarm-ratio=0.8] ["record path"="/tmp/1000_tidb/MC4wLjAuMDo0MDAwLzAuMC4wLjA6MTAwODA=/tmp-storage/record"]

    上記のログ ファイルの例のフィールドは、次のように説明されています。

    • is server-memory-quota setserver-memory-quotaが設定されているかどうかを示します。
    • system memory totalは、現在のシステムの合計メモリを示します。
    • system memory usageは、現在のシステム メモリ使用量を示します。
    • tidb-server memory usageは、tidb-server インスタンスのメモリ使用量を示します。
    • memory-usage-alarm-ratiomemory-usage-alarm-ratioの値を示します。
    • record pathは、ステータス ファイルのディレクトリを示します。
  5. ステータス ファイルのディレクトリ (上記の例では、ディレクトリは/tmp/1000_tidb/MC4wLjAuMDo0MDAwLzAuMC4wLjA6MTAwODA=/tmp-storage/recordです) に、 goroutinueheap 、およびrunning_sqlを含む一連のファイルが表示されます。これら 3 つのファイルの末尾には、ステータス ファイルがログに記録された時刻が付けられます。それぞれ、ゴルーチンのスタック情報、ヒープメモリの使用状況、アラーム発生時の実行中のSQL情報を記録します。 running_sqlのログ内容の形式については、 expensive-queriesを参照してください。

tidb-server のその他のメモリ制御動作

フロー制御

  • TiDB は、データを読み取るオペレーターの動的メモリー制御をサポートしています。デフォルトでは、このオペレーターは、データの読み取りを許可するスレッドの最大数を使用しtidb_distsql_scan_concurrency 。 1 回の SQL 実行のメモリー使用量が毎回tidb_mem_quota_queryを超えると、データを読み取るオペレーターは 1 つのスレッドを停止します。

  • このフロー制御動作は、システム変数tidb_enable_rate_limit_actionによって制御されます。

  • フロー制御動作がトリガーされると、TiDB はキーワードmemory exceeds quota, destroy one token nowを含むログを出力します。

ディスクこぼれ

TiDB は、実行オペレーターのディスクスピルをサポートしています。 SQL 実行のメモリ使用量がメモリ クォータを超えると、tidb-server は実行オペレータの中間データをディスクにスピルして、メモリの負荷を軽減することができます。ディスク スピルをサポートする演算子には、Sort、MergeJoin、HashJoin、HashAgg などがあります。

  • ディスク スピルの動作は、 tidb_mem_quota_queryoom-use-tmp-storagetmp-storage-path 、およびtmp-storage-quotaパラメータによって共同で制御されます。
  • ディスク スピルがトリガーされると、TiDB はキーワードmemory exceeds quota, spill to disk nowまたはmemory exceeds quota, set aggregate mode to spill-modeを含むログを出力します。
  • Sort、MergeJoin、および HashJoin オペレーターのディスク スピルは v4.0.0 で導入されました。 HashAgg オペレーターのディスク スピルは v5.2.0 で導入されました。
  • Sort、MergeJoin、または HashJoin を含む SQL 実行によって OOM が発生すると、TiDB はデフォルトでディスク スピルをトリガーします。 HashAgg を含む SQL 実行によって OOM が発生した場合、TiDB はデフォルトでディスク スピルをトリガーしません。システム変数tidb_executor_concurrency = 1を構成して、HashAgg のディスク スピルをトリガーできます。

ノート:

HashAgg のディスク スピルは、 DISTINCTの集計関数を含む SQL 実行をサポートしていません。 DISTINCTの集計関数を含む SQL 実行でメモリが大量に使用される場合、ディスク スピルは適用されません。

次の例では、メモリを消費する SQL ステートメントを使用して、HashAgg のディスク スピル機能を示します。

  1. SQL ステートメントのメモリ クォータを 1 GB (既定では 1 GB) に構成します。

    SET tidb_mem_quota_query = 1 << 30;
  2. 1 つのテーブルCREATE TABLE t(a int);を作成し、256 行の異なるデータを挿入します。

  3. 次の SQL ステートメントを実行します。

    [tidb]> explain analyze select /*+ HASH_AGG() */ count(*) from t t1 join t t2 join t t3 group by t1.a, t2.a, t3.a;

    この SQL ステートメントを実行すると大量のメモリが占有されるため、次の「メモリ クォータが不足しています」というエラー メッセージが返されます。

    ERROR 1105 (HY000): Out Of Memory Quota![conn_id=3]
  4. システム変数をtidb_executor_concurrency対 1 で構成します。この構成では、メモリが不足すると、HashAgg は自動的にディスク スピルをトリガーしようとします。

    SET tidb_executor_concurrency = 1;
  5. 同じ SQL ステートメントを実行します。今回は、ステートメントが正常に実行され、エラー メッセージが返されていないことがわかります。次の詳細な実行計画から、HashAgg が 600 MB のハード ディスク領域を使用したことがわかります。

    [tidb]> explain analyze select /*+ HASH_AGG() */ count(*) from t t1 join t t2 join t t3 group by t1.a, t2.a, t3.a;
    +---------------------------------+-------------+----------+-----------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------+----------+ | id | estRows | actRows | task | access object | execution info | operator info | memory | disk | +---------------------------------+-------------+----------+-----------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------+----------+ | HashAgg_11 | 204.80 | 16777216 | root | | time:1m37.4s, loops:16385 | group by:test.t.a, test.t.a, test.t.a, funcs:count(1)->Column#7 | 1.13 GB | 600.0 MB | | └─HashJoin_12 | 16777216.00 | 16777216 | root | | time:21.5s, loops:16385, build_hash_table:{total:267.2µs, fetch:228.9µs, build:38.2µs}, probe:{concurrency:1, total:35s, max:35s, probe:35s, fetch:962.2µs} | CARTESIAN inner join | 8.23 KB | 4 KB | | ├─TableReader_21(Build) | 256.00 | 256 | root | | time:87.2µs, loops:2, cop_task: {num: 1, max: 150µs, proc_keys: 0, rpc_num: 1, rpc_time: 145.1µs, copr_cache_hit_ratio: 0.00} | data:TableFullScan_20 | 885 Bytes | N/A | | │ └─TableFullScan_20 | 256.00 | 256 | cop[tikv] | table:t3 | tikv_task:{time:23.2µs, loops:256} | keep order:false, stats:pseudo | N/A | N/A | | └─HashJoin_14(Probe) | 65536.00 | 65536 | root | | time:728.1µs, loops:65, build_hash_table:{total:307.5µs, fetch:277.6µs, build:29.9µs}, probe:{concurrency:1, total:34.3s, max:34.3s, probe:34.3s, fetch:278µs} | CARTESIAN inner join | 8.23 KB | 4 KB | | ├─TableReader_19(Build) | 256.00 | 256 | root | | time:126.2µs, loops:2, cop_task: {num: 1, max: 308.4µs, proc_keys: 0, rpc_num: 1, rpc_time: 295.3µs, copr_cache_hit_ratio: 0.00} | data:TableFullScan_18 | 885 Bytes | N/A | | │ └─TableFullScan_18 | 256.00 | 256 | cop[tikv] | table:t2 | tikv_task:{time:79.2µs, loops:256} | keep order:false, stats:pseudo | N/A | N/A | | └─TableReader_17(Probe) | 256.00 | 256 | root | | time:211.1µs, loops:2, cop_task: {num: 1, max: 295.5µs, proc_keys: 0, rpc_num: 1, rpc_time: 279.7µs, copr_cache_hit_ratio: 0.00} | data:TableFullScan_16 | 885 Bytes | N/A | | └─TableFullScan_16 | 256.00 | 256 | cop[tikv] | table:t1 | tikv_task:{time:71.4µs, loops:256} | keep order:false, stats:pseudo | N/A | N/A | +---------------------------------+-------------+----------+-----------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------+----------+ 9 rows in set (1 min 37.428 sec)