コンフィグレーションを動的に変更する

このドキュメントでは、クラスター構成を動的に変更する方法について説明します。

クラスター コンポーネントを再起動せずに、SQL ステートメントを使用してコンポーネント (TiDB、TiKV、PD を含む) の構成を動的に更新できます。現在、TiDB インスタンス構成を変更する方法は、他のコンポーネント (TiKV や PD など) の構成を変更する方法とは異なります。

注記：

この機能は TiDB Self-Hosted にのみ適用され、 TiDB Cloudでは使用できません。 TiDB Cloudの場合、設定を変更するにはTiDB Cloudサポートに連絡する必要があります。

共通操作

このセクションでは、構成を動的に変更する一般的な操作について説明します。

インスタンス構成のビュー

クラスター内のすべてのインスタンスの構成を表示するには、 show configステートメントを使用します。結果は次のようになります。

show config;

+------+-----------------+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Type | Instance        | Name                                                      | Value                                                                                                                                                                                                                                                                            |
+------+-----------------+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tidb | 127.0.0.1:4001  | advertise-address                                         | 127.0.0.1                                                                                                                                                                                                                                                                        |
| tidb | 127.0.0.1:4001  | binlog.binlog-socket                                      |                                                                                                                                                                                                                                                                                  |
| tidb | 127.0.0.1:4001  | binlog.enable                                             | false                                                                                                                                                                                                                                                                            |
| tidb | 127.0.0.1:4001  | binlog.ignore-error                                       | false                                                                                                                                                                                                                                                                            |
| tidb | 127.0.0.1:4001  | binlog.strategy                                           | range                                                                                                                                                                                                                                                                            |
| tidb | 127.0.0.1:4001  | binlog.write-timeout                                      | 15s                                                                                                                                                                                                                                                                              |
| tidb | 127.0.0.1:4001  | check-mb4-value-in-utf8                                   | true                                                                                                                                                                                                                                                                             |

...

結果をフィールド別にフィルタリングできます。例:

show config where type='tidb'
show config where instance in (...)
show config where name like '%log%'
show config where type='tikv' and name='log.level'

TiKV 構成を動的に変更する

注記：

• TiKV 設定項目を動的に変更すると、TiKV 設定ファイルが自動的に更新されます。ただし、 tiup edit-config実行して対応する設定項目も変更する必要があります。そうしないと、 upgradeやreloadなどの操作によって変更が上書きされます。設定項目の変更の詳細については、 TiUPを使用して構成を変更するを参照してください。
• tiup edit-configを実行した後、 tiup reload実行する必要はありません。

set configステートメントを使用すると、インスタンス アドレスまたはコンポーネントタイプに応じて、単一のインスタンスまたはすべてのインスタンスの構成を変更できます。

• すべての TiKV インスタンスの構成を変更します。

注記：

変数名はバッククォートで囲むことをお勧めします。

set config tikv `split.qps-threshold`=1000;

• 単一の TiKV インスタンスの構成を変更します。

  set config "127.0.0.1:20180" `split.qps-threshold`=1000;
  

変更が成功した場合はQuery OKが返されます。

Query OK, 0 rows affected (0.01 sec)

バッチ変更中にエラーが発生した場合は、警告が返されます。

set config tikv `log-level`='warn';

Query OK, 0 rows affected, 1 warning (0.04 sec)

show warnings;

+---------+------+---------------------------------------------------------------------------------------------------------------+
| Level   | Code | Message                                                                                                       |
+---------+------+---------------------------------------------------------------------------------------------------------------+
| Warning | 1105 | bad request to http://127.0.0.1:20180/config: fail to update, error: "config log-level can not be changed" |
+---------+------+---------------------------------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

バッチ変更ではアトミック性が保証されません。変更は一部のインスタンスでは成功しますが、他のインスタンスでは失敗する可能性があります。 set tikv key=val使用して TiKV クラスター全体の構成を変更すると、一部のインスタンスで変更が失敗する可能性があります。 show warningsを使用して結果を確認できます。

一部の変更が失敗した場合は、対応するステートメントを再実行するか、失敗した各インスタンスを変更する必要があります。ネットワークの問題またはマシン障害のために一部の TiKV インスタンスにアクセスできない場合は、回復後にこれらのインスタンスを変更します。

構成項目が正常に変更された場合、その結果は構成ファイルに保存され、後続の操作で優先されます。一部の構成項目の名前は、 limitやkeyなど、TiDB の予約語と競合する場合があります。これらの構成項目については、バックティック`を使用して囲みます。たとえば、 `raftstore.raft-log-gc-size-limit` 。

次の TiKV 構成項目は動的に変更できます。

上記の表で、プレフィックスが{db-name}または{db-name}.{cf-name}のパラメータは、RocksDB に関連する設定です。 db-nameのオプションの値はrocksdbとraftdbです。

• db-nameがrocksdbの場合、 cf-nameのオプションの値はdefaultcf 、 writecf 、 lockcf 、およびraftcfです。
• db-nameがraftdbの場合、 cf-nameの値はdefaultcfになります。

詳細なパラメータの説明についてはTiKVコンフィグレーションファイルを参照してください。

PD構成を動的に変更する

現在、PD はインスタンスごとに個別の構成をサポートしていません。すべての PD インスタンスは同じ構成を共有します。

次のステートメントを使用して PD 構成を変更できます。

set config pd `log.level`='info';

変更が成功した場合はQuery OKが返されます。

Query OK, 0 rows affected (0.01 sec)

構成項目が正常に変更された場合、その結果は構成ファイルではなく etcd に保存されます。後続の操作では、etcd の構成が優先されます。一部の構成項目の名前は、TiDB の予約語と競合する場合があります。これらの構成項目については、バックティック`を使用して囲みます。たとえば、 `schedule.leader-schedule-limit` 。

次の PD 構成項目は動的に変更できます。

詳細なパラメータの説明についてはPDコンフィグレーションファイルを参照してください。

TiDB構成を動的に変更する

現在、TiDB 構成の変更方法は、TiKV および PD 構成の変更方法とは異なります。 システム変数を使用して TiDB 構成を変更できます。

次の例は、 tidb_slow_log_threshold変数を使用してslow-threshold動的に変更する方法を示しています。

デフォルト値slow-thresholdは 300 ミリ秒です。 tidb_slow_log_threshold使用すると 200 ミリ秒に設定できます。

set tidb_slow_log_threshold = 200;

Query OK, 0 rows affected (0.00 sec)

select @@tidb_slow_log_threshold;

+---------------------------+
| @@tidb_slow_log_threshold |
+---------------------------+
| 200                       |
+---------------------------+
1 row in set (0.00 sec)

次の TiDB 構成項目は動的に変更できます。

TiFlash構成を動的に変更する

現在、システム変数tidb_max_tiflash_threadsを使用してTiFlash構成max_threadsを変更できます。この変数は、 TiFlash が要求を実行するための最大同時実行性を指​​定します。

tidb_max_tiflash_threadsのデフォルト値は-1で、このシステム変数は無効であり、 TiFlash構成ファイルの設定に依存することを示します。 tidb_max_tiflash_threadsを使用してmax_threadsから 10 に設定できます。

set tidb_max_tiflash_threads = 10;

Query OK, 0 rows affected (0.00 sec)

select @@tidb_max_tiflash_threads;

+----------------------------+
| @@tidb_max_tiflash_threads |
+----------------------------+
| 10                         |
+----------------------------+
1 row in set (0.00 sec)