PLAN REPLAYER を使用してクラスタのオンサイト情報を保存および復元する

TiDB クラスターの問題を特定してトラブルシューティングする場合、多くの場合、システムと実行計画に関する情報を提供する必要があります。より便利かつ効率的な方法で情報を取得し、クラスターの問題をトラブルシューティングできるように、TiDB v5.3.0 ではPLAN REPLAYERコマンドが導入されました。このコマンドを使用すると、クラスターのオンサイト情報を簡単に保存および復元できるようになり、トラブルシューティングの効率が向上し、管理のために問題をより簡単にアーカイブできるようになります。

PLAN REPLAYERの特徴は以下の通りです。

• オンサイトのトラブルシューティングで TiDB クラスターの情報を ZIP 形式のファイルにエクスポートしてstorage。
• 別の TiDB クラスターからエクスポートされた ZIP 形式のファイルをクラスターにインポートします。このファイルには、オンサイトのトラブルシューティングにおける後者の TiDB クラスターの情報が含まれています。

PLAN REPLAYER使用してクラスター情報をエクスポートする

PLAN REPLAYERを使用すると、TiDB クラスターのオンサイト情報を保存できます。エクスポートインターフェイスは次のとおりです。

PLAN REPLAYER DUMP EXPLAIN [ANALYZE] sql-statement;

TiDB はsql-statementに基づいて、次のオンサイト情報を整理してエクスポートします。

• TiDBのバージョン
• TiDB 構成
• TiDB セッション変数
• TiDB SQLバインディング
• sql-statementのテーブル スキーマ
• sql-statementのテーブルの統計
• EXPLAIN [ANALYZE] sql-statementの結果
• クエリ最適化のいくつかの内部手順

ノート：

PLAN REPLAYERはテーブルデータをエクスポートしません。

クラスタ情報のエクスポート例

use test;
create table t(a int, b int);
insert into t values(1,1), (2, 2), (3, 3);
analyze table t;

plan replayer dump explain select * from t;

PLAN REPLAYER DUMP 、上記のテーブル情報をZIPファイルにパッケージ化し、実行結果としてファイル識別子を返します。

ノート：

ZIPファイルは TiDB クラスターに最大 1 時間保存されます。 1 時間後、TiDB はそれを削除します。

MySQL [test]> plan replayer dump explain select * from t;

+------------------------------------------------------------------+
| Dump_link                                                        |
+------------------------------------------------------------------+
| replayer_JOGvpu4t7dssySqJfTtS4A==_1635750890568691080.zip |
+------------------------------------------------------------------+
1 row in set (0.015 sec)

あるいは、セッション変数tidb_last_plan_replayer_tokenを使用して、最後のPLAN REPLAYER DUMP回の実行結果を取得することもできます。

SELECT @@tidb_last_plan_replayer_token;

+-----------------------------------------------------------+
| @@tidb_last_plan_replayer_token                           |
+-----------------------------------------------------------+
| replayer_Fdamsm3C7ZiPJ-LQqgVjkA==_1663304195885090000.zip |
+-----------------------------------------------------------+
1 row in set (0.00 sec)

SQL文が複数ある場合、 PLAN REPLAYER DUMPの実行結果をファイルで取得できます。このファイルでは、複数の SQL ステートメントの結果が;で区切られています。

plan replayer dump explain 'sqls.txt';

Query OK, 0 rows affected (0.03 sec)

SELECT @@tidb_last_plan_replayer_token;

+-----------------------------------------------------------+
| @@tidb_last_plan_replayer_token                           |
+-----------------------------------------------------------+
| replayer_LEDKg8sb-K0u24QesiH8ig==_1663226556509182000.zip |
+-----------------------------------------------------------+
1 row in set (0.00 sec)

ファイルは MySQL クライアントではダウンロードできないため、ファイルをダウンロードするには TiDB HTTP インターフェイスとファイル識別子を使用する必要があります。

http://${tidb-server-ip}:${tidb-server-status-port}/plan_replayer/dump/${file_token}

${tidb-server-ip}:${tidb-server-status-port}は、クラスター内の任意の TiDBサーバーのアドレスです。例えば：

curl http://127.0.0.1:10080/plan_replayer/dump/replayer_JOGvpu4t7dssySqJfTtS4A==_1635750890568691080.zip > plan_replayer.zip

PLAN REPLAYER使用してクラスター情報をインポートする

PLAN REPLAYERを使用してエクスポートされた既存のZIPファイルでは、 PLAN REPLAYERインポート インターフェイスを使用して、クラスターのオンサイト情報を他の TiDB クラスターに復元できます。構文は次のとおりです。

PLAN REPLAYER LOAD 'file_name';

上記のステートメントでは、 file_nameはエクスポートされるZIPファイルの名前です。

例えば：

PLAN REPLAYER LOAD 'plan_replayer.zip';

クラスター情報がインポートされると、必要なテーブル スキーマ、統計、および実行計画の構築に影響を与えるその他の情報が TiDB クラスターにロードされます。次の方法で実行計画を表示し、統計を確認できます。

mysql> desc t;
+-------+---------+------+------+---------+-------+
| Field | Type    | Null | Key  | Default | Extra |
+-------+---------+------+------+---------+-------+
| a     | int(11) | YES  |      | NULL    |       |
| b     | int(11) | YES  |      | NULL    |       |
+-------+---------+------+------+---------+-------+
2 rows in set (0.01 sec)

mysql> explain select * from t where a = 1 or b =1;
+-------------------------+---------+-----------+---------------+--------------------------------------+
| id                      | estRows | task      | access object | operator info                        |
+-------------------------+---------+-----------+---------------+--------------------------------------+
| TableReader_7           | 0.01    | root      |               | data:Selection_6                     |
| └─Selection_6           | 0.01    | cop[tikv] |               | or(eq(test.t.a, 1), eq(test.t.b, 1)) |
|   └─TableFullScan_5     | 6.00    | cop[tikv] | table:t       | keep order:false, stats:pseudo       |
+-------------------------+---------+-----------+---------------+--------------------------------------+
3 rows in set (0.00 sec)

mysql> show stats_meta;
+---------+------------+----------------+---------------------+--------------+-----------+
| Db_name | Table_name | Partition_name | Update_time         | Modify_count | Row_count |
+---------+------------+----------------+---------------------+--------------+-----------+
| test    | t          |                | 2022-08-26 15:52:07 |            3 |         6 |
+---------+------------+----------------+---------------------+--------------+-----------+
1 row in set (0.04 sec)

シーンがロードされて復元された後、クラスターの実行計画を診断して改善できます。

PLAN REPLAYER CAPTURE使用してターゲット プランをキャプチャする

一部のシナリオで TiDB の実行プランを見つける場合、ターゲット SQL ステートメントとターゲット実行プランはクエリにたまにしか表示されないため、 PLAN REPLAYER使用してステートメントとプランを直接キャプチャすることはできません。このような場合、 PLAN REPLAYER CAPTUREを使用すると、ターゲット SQL ステートメントとターゲット プランのオプティマイザー情報を取得しやすくなります。

PLAN REPLAYER CAPTUREには次の主な機能があります。

• 対象のSQL文と対象の実行プランのダイジェストを事前にTiDBクラスターに登録し、対象のクエリとのマッチングを開始します。
• ターゲット クエリが正常に一致すると、オプティマイザ関連の情報を直接取得し、ZIP ファイルとしてエクスポートします。
• 一致した SQL および実行プランごとに、情報は 1 回だけ取得されます。
• システム テーブルを通じて、進行中の一致タスクと生成されたファイルを表示します。
• 履歴ファイルを定期的にクリーンアップします。

PLAN REPLAYER CAPTUREを有効にする

PLAN REPLAYER CAPTUREはシステム変数tidb_enable_plan_replayer_captureによって制御されます。 PLAN REPLAYER CAPTUREを有効にするには、システム変数の値をONに設定します。

PLAN REPLAYER CAPTUREを使用する

次のステートメントを使用して、ターゲット SQL ステートメントのダイジェストと実行プランを TiDB クラスターに登録できます。

PLAN REPLAYER CAPTURE 'sql_digest' 'plan_digest';

ターゲット SQL ステートメントに複数の実行プランがあり、すべての実行プランをキャプチャしたい場合は、次のステートメントを使用してすべての実行プランを一度に登録できます。

PLAN REPLAYER CAPTURE 'sql_digest' '*';

キャプチャタスクをビュー

次のステートメントを使用して、TiDB クラスター内のPLAN REPLAYER CAPTURE進行中のキャプチャ タスクを表示できます。

mysql> PLAN PLAYER CAPTURE 'example_sql' 'example_plan';
Query OK, 1 row affected (0.01 sec)

mysql> SELECT * FROM mysql.plan_replayer_task;
+-------------+--------------+---------------------+
| sql_digest  | plan_digest  | update_time         |
+-------------+--------------+---------------------+
| example_sql | example_plan | 2023-01-28 11:58:22 |
+-------------+--------------+---------------------+
1 row in set (0.01 sec)

キャプチャ結果をビュー

PLAN REPLAYER CAPTUREが結果を正常に取得したら、次の SQL ステートメントを使用して、ファイルのダウンロードに使用されたトークンを表示できます。

mysql> SELECT * FROM mysql.plan_replayer_status;
+------------------------------------------------------------------+------------------------------------------------------------------+------------+-----------------------------------------------------------+---------------------+-------------+-----------------+
| sql_digest                                                       | plan_digest                                                      | origin_sql | token                                                     | update_time         | fail_reason | instance        |
+------------------------------------------------------------------+------------------------------------------------------------------+------------+-----------------------------------------------------------+---------------------+-------------+-----------------+
| 086e3fbd2732f7671c17f299d4320689deeeb87ba031240e1e598a0ca14f808c | 042de2a6652a6d20afc629ff90b8507b7587a1c7e1eb122c3e0b808b1d80cc02 |            | replayer_Utah4nkz2sIEzkks7tIRog==_1668746293523179156.zip | 2022-11-18 12:38:13 | NULL        | 172.16.4.4:4022 |
| b5b38322b7be560edb04f33f15b15a885e7c6209a22b56b0804622e397199b54 | 1770efeb3f91936e095f0344b629562bf1b204f6e46439b7d8f842319297c3b5 |            | replayer_Z2mUXNHDjU_WBmGdWQqifw==_1668746293560115314.zip | 2022-11-18 12:38:13 | NULL        | 172.16.4.4:4022 |
| 96d00c0b3f08795fe94e2d712fa1078ab7809faf4e81d198f276c0dede818cf9 | 8892f74ac2a42c2c6b6152352bc491b5c07c73ac3ed66487b2c990909bae83e8 |            | replayer_RZcRHJB7BaCccxFfOIAhWg==_1668746293578282450.zip | 2022-11-18 12:38:13 | NULL        | 172.16.4.4:4022 |
+------------------------------------------------------------------+------------------------------------------------------------------+------------+-----------------------------------------------------------+---------------------+-------------+-----------------+
3 rows in set (0.00 sec)

PLAN REPLAYER CAPTUREのファイルのダウンロード方法はPLAN REPLAYERと同様です。詳細はクラスタ情報のエクスポート例を参照してください。

ノート：

PLAN REPLAYER CAPTUREの結果ファイルは、TiDB クラスターに最大 1 週間保持されます。 1 週間後、TiDB はファイルを削除します。

PLAN REPLAYER CONTINUOUS CAPTUREを使用する

PLAN REPLAYER CONTINUOUS CAPTUREを有効にすると、TiDB はSQL DIGESTとPLAN DIGESTに従ってPLAN REPLAYERメソッドを使用してアプリケーションの SQL ステートメントを非同期的に記録します。同じ DIGEST を共有する SQL ステートメントと実行プランについては、 PLAN REPLAYER CONTINUOUS CAPTUREそれらを繰り返し記録しません。

PLAN REPLAYER CONTINUOUS CAPTUREを有効にする

PLAN REPLAYER CONTINUOUS CAPTUREはシステム変数tidb_enable_plan_replayer_continuous_captureによって制御されます。 PLAN REPLAYER CONTINUOUS CAPTUREを有効にするには、システム変数の値をONに設定します。

キャプチャ結果をビュー

PLAN REPLAYER CONTINUOUS CAPTUREの攻略結果の見方はPLAN REPLAYER CAPTUREのキャプチャ結果の確認と同様です。