📣
TiDB Cloud Essential はパブリックプレビュー中です。このページは自動翻訳されたものです。原文はこちらからご覧ください。
TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

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 [WITH STATS AS OF TIMESTAMP expression] EXPLAIN [ANALYZE] sql-statement;

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

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

履歴統計が有効場合、 PLAN REPLAYER文で時刻を指定することで、対応する時刻の履歴統計を取得できます。時刻と日付を直接指定することも、タイムスタンプを指定することもできます。TiDB は指定された時刻より前の履歴統計を検索し、その中から最新のものをエクスポートします。

指定された時刻より前の履歴統計がない場合、TiDBは最新の統計をエクスポートします。これは、時刻が指定されていない場合の動作と一致しています。さらに、TiDBはエクスポートされたZIPファイル内に、 errors.txtファイル内のエラーメッセージを出力。

注記：

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 with stats as of timestamp '2023-07-17 12:00:00' explain select * from t;
plan replayer dump with stats as of timestamp '442012134592479233' 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';

注記：

auto analyzeを無効にする必要があります。無効にしないと、インポートされた統計情報が分析によって上書きされてしまいます。

tidb_enable_auto_analyzeシステム変数をOFFに設定すると、auto analyzeを無効にすることができます。

set @@global.tidb_enable_auto_analyze = OFF;

クラスタ情報がインポートされると、TiDBクラスタには、必要なテーブルスキーマ、統計情報、および実行プランの構築に影響するその他の情報がロードされます。実行プランを表示し、統計情報を確認するには、以下の手順に従います。

mysql> desc t;
+-------+------+------+------+---------+-------+
| Field | Type | Null | Key  | Default | Extra |
+-------+------+------+------+---------+-------+
| a     | int  | YES  |      | NULL    |       |
| b     | int  | 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)

シーンが読み込まれて復元されたら、クラスターの実行プランを診断して改善できます。

注記：

mysqlコマンドラインクライアントを使用していてERROR 2068 (HY000): LOAD DATA LOCAL INFILE file request rejected due to restrictions on access.遭遇した場合は、接続文字列に--local-infile=true追加できます。

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によって制御されます。4 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 REPLAYER 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 CAPTURE REMOVEステートメントを使用して削除できます。例:

mysql> PLAN REPLAYER CAPTURE '077a87a576e42360c95530ccdac7a1771c4efba17619e26be50a4cfd967204a0' '4838af52c1e07fc8694761ad193d16a689b2128bc5ced9d13beb31ae27b370ce';
Query OK, 0 rows affected (0.01 sec)

mysql> SELECT * FROM mysql.plan_replayer_task;
+------------------------------------------------------------------+------------------------------------------------------------------+---------------------+
| sql_digest                                                       | plan_digest                                                      | update_time         |
+------------------------------------------------------------------+------------------------------------------------------------------+---------------------+
| 077a87a576e42360c95530ccdac7a1771c4efba17619e26be50a4cfd967204a0 | 4838af52c1e07fc8694761ad193d16a689b2128bc5ced9d13beb31ae27b370ce | 2024-05-21 11:26:10 |
+------------------------------------------------------------------+------------------------------------------------------------------+---------------------+
1 row in set (0.01 sec)

mysql> PLAN REPLAYER CAPTURE REMOVE '077a87a576e42360c95530ccdac7a1771c4efba17619e26be50a4cfd967204a0' '4838af52c1e07fc8694761ad193d16a689b2128bc5ced9d13beb31ae27b370ce';
Query OK, 0 rows affected (0.01 sec)

mysql> SELECT * FROM mysql.plan_replayer_task;
Empty set (0.01 sec)

PLAN REPLAYER CONTINUOUS CAPTUREを使用する

PLAN REPLAYER CONTINUOUS CAPTURE有効にすると、TiDB はアプリケーションの SQL 文をSQL DIGESTとPLAN DIGESTに基づいてPLAN REPLAYER方法で非同期的に記録します。同じ DIGEST を共有する SQL 文と実行プランについては、 PLAN REPLAYER CONTINUOUS CAPTUREによって重複して記録されません。

PLAN REPLAYER CONTINUOUS CAPTUREを有効にする

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

キャプチャ結果をビュー

PLAN REPLAYER CONTINUOUS CAPTUREのキャプチャ結果の閲覧方法はPLAN REPLAYER CAPTUREのキャプチャ結果の表示と同様です。

このページは役に立ちましたか？