Configuration / コンフィグレーションをオンラインで変更する

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

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

共通操作

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

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

クラスター内のすべてのインスタンスの構成を表示するには、 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になります。

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

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 構成アイテムは、オンラインで変更できます。

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

TiDB 構成をオンラインで変更する

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

次の例は、 tidb_slow_log_threshold変数を使用してslow-thresholdをオンラインで変更する方法を示しています。

デフォルト値のslow-thresholdは 300 ミリ秒です。 tidb_slow_log_thresholdを使用して 200 ms に設定できます。

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 構成項目は、オンラインで変更できます。

| |Configuration / コンフィグレーション項目 | SQL 変数 |説明 | | | :--- | :--- | | | log.enable-slow-log | tidb_enable_slow_log |スローログを有効にするかどうか | | | log.slow-threshold | tidb_slow_log_threshold |遅いログのしきい値 | | | log.expensive-threshold | tidb_expensive_query_time_threshold |高価なクエリのしきい値 |

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)