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を実行して、対応する構成項目を変更する必要もあります。そうしないと、 upgradereloadなどの操作によって変更が上書きされます。設定項目の変更については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 インスタンスにアクセスできない場合は、それらのインスタンスが回復した後にこれらのインスタンスを変更します。

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

次の TiKV 構成アイテムは、オンラインで変更できます。

Configuration / コンフィグレーション項目説明
ログレベルログレベル。
raftstore.raft-max-inflight-msgs確認するRaftログの数。この数を超えると、 Raftステート マシンはログの送信を遅くします。
raftstore.raft-log-gc-tick-intervalRaftログを削除するポーリング タスクがスケジュールされている時間間隔
raftstore.raft-log-gc-threshold残りのRaftログの最大許容数のソフト リミット
raftstore.raft-log-gc-count-limit残りのRaftログの許容数のハード リミット
raftstore.raft-log-gc-size-limit残りのRaftログの許容サイズのハード リミット
raftstore.raft-max-size-per-msg生成できる単一メッセージ パケットのサイズのソフト リミット
raftstore.raft-entry-max-size1 つのRaftログの最大サイズのハード リミット
raftstore.raft-entry-cache-life-timeメモリ内のログ キャッシュに許可される最大残り時間
raftstore.split-region-check-tick-intervalリージョン分割が必要かどうかを確認する時間間隔
raftstore.region-split-check-diffリージョン分割前にリージョンデータが超えることのできる最大値
raftstore.region-compact-check-intervalRocksDB 圧縮を手動でトリガーする必要があるかどうかを確認する時間間隔
raftstore.region-compact-check-step手動圧縮の各ラウンドで一度にチェックされるリージョンの数
raftstore.region-compact-min-tombstonesRocksDB 圧縮をトリガーするために必要なトゥームストーンの数
raftstore.region-compact-tombstones-percentRocksDB 圧縮をトリガーするために必要なトゥームストーンの割合
raftstore.pd-heartbeat-tick-intervalPD へのリージョンのハートビートがトリガーされる時間間隔
raftstore.pd-store-heartbeat-tick-intervalPD へのストアのハートビートがトリガーされる時間間隔
raftstore.snap-mgr-gc-tick-interval期限切れのスナップショット ファイルのリサイクルがトリガーされる時間間隔
raftstore.snap-gc-timeoutスナップショット ファイルが保存される最長時間
raftstore.lock-cf-compact-intervalTiKV が Lock カラム Family の手動圧縮をトリガーする時間間隔
raftstore.lock-cf-compact-bytes-thresholdTiKV が Lock カラム Family の手動圧縮をトリガーするサイズ
raftstore.messages-per-tickバッチごとに処理されるメッセージの最大数
raftstore.max-peer-down-durationピアに許可される最長の非アクティブ期間
raftstore.max-leader-missing-durationリーダーなしでピアに許可される最長期間。この値を超えると、ピアは削除されたかどうかを PD で確認します。
raftstore.abnormal-leader-missing-durationピアがリーダーなしで存在できる通常の期間。この値を超えると、ピアは異常と見なされ、メトリックとログでマークされます。
raftstore.peer-stale-state-check-intervalピアにリーダーがいないかどうかを確認する時間間隔
raftstore.consistency-check-interval一貫性をチェックする時間間隔 (TiDB のガベージ コレクションと互換性がないため、推奨されません)
raftstore.raft-store-max-leader-leaseRaftリーダーの最長信頼期間
raftstore.merge-check-tick-interval合流チェックの時間間隔
raftstore.cleanup-import-sst-interval期限切れの SST ファイルをチェックする時間間隔
raftstore.local-read-batch-size1 回のバッチで処理される読み取り要求の最大数
raftstore.hibernate-timeout起動時に休止状態に入るまでの最短待機時間。この期間中、TiKV は休止状態になりません (解放されません)。
raftstore.apply-pool-sizeデータをディスクにフラッシュするプール内のスレッドの数。これは、適用スレッド プールのサイズです。
raftstore.store-pool-sizeRaftを処理するプール内のスレッド数 (Raftstore スレッド プールのサイズ)
raftstore.apply-max-batch-sizeRaftステート マシンは、BatchSystem によってバッチでデータ書き込み要求を処理します。この設定項目は、1 つのバッチでリクエストを実行できるRaftステート マシンの最大数を指定します。
raftstore.store-max-batch-sizeRaftステート マシンは、BatchSystem によってバッチでログをディスクにフラッシュするための要求を処理します。この設定項目は、1 つのバッチでリクエストを処理できるRaftステート マシンの最大数を指定します。
readpool.unified.max-thread-countUnifyReadPool スレッド プールのサイズである、読み取り要求を均一に処理するスレッド プール内のスレッドの最大数
coprocessor.split-region-on-tableテーブルごとにリージョンを分割できます
coprocessor.batch-split-limit一括でのリージョン分割の閾値
coprocessor.region-max-sizeリージョンの最大サイズ
coprocessor.region-split-size新しく分割されたリージョンのサイズ
coprocessor.region-max-keysリージョンで許可されるキーの最大数
coprocessor.region-split-keys新しく分割されたリージョンのキーの数
pessimistic-txn.wait-for-lock-timeout悲観的トランザクションがロックを待機する最長期間
pessimistic-txn.wake-up-delay-duration悲観的なトランザクションが起動されるまでの期間
pessimistic-txn.pipelinedパイプライン化されたペシミスティック ロック プロセスを有効にするかどうかを決定します。
pessimistic-txn.in-memoryインメモリ悲観的ロックを有効にするかどうかを決定します
quota.foreground-cpu-timeTiKV フォアグラウンドが読み取りおよび書き込み要求を処理するために使用する CPU リソースのソフト制限
quota.foreground-write-bandwidthフォアグラウンド トランザクションがデータを書き込む帯域幅のソフト リミット
quota.foreground-read-bandwidthフォアグラウンド トランザクションとコプロセッサがデータを読み取る帯域幅のソフト リミット
quota.background-cpu-timeTiKV バックグラウンドが読み取りおよび書き込み要求を処理するために使用する CPU リソースのソフト制限
quota.background-write-bandwidthバックグラウンド トランザクションがデータを書き込む帯域幅のソフト リミット (まだ有効ではありません)
quota.background-read-bandwidthバックグラウンド トランザクションとコプロセッサがデータを読み取る帯域幅のソフト リミット (まだ有効ではありません)
quota.enable-auto-tuneクォータの自動調整を有効にするかどうか。この構成項目が有効になっている場合、TiKV は、TiKV インスタンスの負荷に基づいて、バックグラウンド リクエストのクォータを動的に調整します。
quota.max-delay-duration単一の読み取りまたは書き込み要求がフォアグラウンドで処理されるまで強制的に待機される最大時間
gc.ratio-thresholdリージョンGC がスキップされるしきい値 (GC バージョンの数/キーの数)
gc.batch-keys1 回のバッチで処理されるキーの数
gc.max-write-bytes-per-sec1 秒あたりに RocksDB に書き込むことができる最大バイト数
gc.enable-compaction-filter圧縮フィルターを有効にするかどうか
gc.compaction-filter-skip-version-checkコンパクション フィルタのクラスタ バージョン チェックをスキップするかどうか (未公開)
{db-name}.max-total-wal-size合計 WAL の最大サイズ
{db-name}.max-background-jobsRocksDB のバックグラウンド スレッドの数
{db-name}.max-background-flushesRocksDB のフラッシュ スレッドの最大数
{db-name}.max-open-filesRocksDB が開くことができるファイルの総数
{db-name}.compaction-readahead-size圧縮時のサイズreadahead
{db-name}.bytes-per-syncこれらのファイルが非同期的に書き込まれている間に、OS がファイルをディスクに増分的に同期する速度
{db-name}.wal-bytes-per-syncWALファイルの書き込み中に、OSがWALファイルをディスクに段階的に同期する速度
{db-name}.writable-file-max-buffer-sizeWritableFileWrite で使用される最大バッファ サイズ
{db-name}.{cf-name}.block-cache-sizeブロックのキャッシュサイズ
{db-name}.{cf-name}.write-buffer-sizememtable のサイズ
{db-name}.{cf-name}.max-write-buffer-numbermemtable の最大数
{db-name}.{cf-name}.max-bytes-for-level-baseベースレベル (L1) の最大バイト数
{db-name}.{cf-name}.target-file-size-baseベース レベルでのターゲット ファイルのサイズ
{db-name}.{cf-name}.level0-file-num-compaction-trigger圧縮をトリガーする L0 のファイルの最大数
{db-name}.{cf-name}.level0-slowdown-writes-trigger書き込みストールをトリガーする L0 のファイルの最大数
{db-name}.{cf-name}.level0-stop-writes-trigger書き込みを完全にブロックする L0 のファイルの最大数
{db-name}.{cf-name}.max-compaction-bytes圧縮ごとにディスクに書き込まれる最大バイト数
{db-name}.{cf-name}.max-bytes-for-level-multiplier各レイヤーのデフォルトの増幅倍数
{db-name}.{cf-name}.disable-auto-compactions自動圧縮を有効または無効にします
{db-name}.{cf-name}.soft-pending-compaction-bytes-limit保留中の圧縮バイトのソフト制限
{db-name}.{cf-name}.hard-pending-compaction-bytes-limit保留中の圧縮バイトのハード制限
{db-name}.{cf-name}.titan.blob-run-modeBLOB ファイルの処理モード
server.grpc-memory-pool-quotagRPC で使用できるメモリ サイズを制限します
server.max-grpc-send-msg-len送信できる gRPC メッセージの最大長を設定します
server.raft-msg-max-batch-size単一の gRPC メッセージに含まれるRaftメッセージの最大数を設定します
server.simplify-metricsサンプリング モニタリング メトリックを単純化するかどうかを制御します
storage.block-cache.capacity共有ブロック キャッシュのサイズ (v4.0.3 以降でサポート)
storage.scheduler-worker-pool-sizeスケジューラ スレッド プール内のスレッド数
backup.num-threadsバックアップ スレッドの数 (v4.0.3 以降でサポート)
split.qps-thresholdリージョンでload-base-splitを実行するためのしきい値。リージョンの読み取りリクエストの QPS が 10 秒間連続してqps-thresholdを超える場合、このリージョンは分割する必要があります。
split.byte-thresholdリージョンでload-base-splitを実行するためのしきい値。リージョンの読み取りリクエストのトラフィックが 10 秒間連続してbyte-thresholdを超えた場合、このリージョンを分割する必要があります。
split.region-cpu-overload-threshold-ratioリージョンでload-base-splitを実行するためのしきい値。リージョンの統合読み取りプールの CPU 使用率が 10 秒間連続してregion-cpu-overload-threshold-ratioを超えた場合、このリージョンを分割する必要があります。 (v6.2.0 以降でサポート)
split.split-balance-score2 つの分割されたリージョンの負荷が可能な限りバランスが取れていることを保証するload-base-splitのパラメーター。値が小さいほど負荷が分散されます。ただし、小さすぎると分割に失敗する場合があります。
split.split-contained-scoreload-base-splitのパラメーター。値が小さいほど、リージョン分割後のリージョン間の訪問が少なくなります。
cdc.min-ts-interval解決済み TS が転送される時間間隔
cdc.old-value-cache-memory-quotaTiCDC Old Value エントリが占有するメモリの上限
cdc.sink-memory-quotaTiCDC データ変更イベントが占有するメモリの上限
cdc.incremental-scan-speed-limit履歴データのインクリメンタル スキャンの速度の上限
cdc.incremental-scan-concurrency履歴データの同時増分スキャン タスクの最大数

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

  • db-namerocksdbの場合、オプションのcf-nameの値はdefaultcfwritecf lockcf raftcf
  • db-nameraftdbの場合、 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 構成アイテムは、オンラインで変更できます。

Configuration / コンフィグレーション項目説明
log.levelログレベル
cluster-versionクラスターのバージョン
schedule.max-merge-region-sizeRegion Mergeのサイズ制限を制御します (MiB 単位)
schedule.max-merge-region-keysRegion Mergeキーの最大数を指定します
schedule.patrol-region-intervalリージョンのヘルス状態をチェックする頻度を決定しreplicaChecker
schedule.split-merge-interval同じリージョンで分割およびマージ操作を実行する時間間隔を決定します
schedule.max-snapshot-count1 つのストアが同時に送受信できるスナップショットの最大数を決定します
schedule.max-pending-peer-count1 つのストア内の保留中のピアの最大数を決定します
schedule.max-store-down-time切断されたストアを復旧できないと PD が判断するまでのダウンタイム
schedule.leader-schedule-policyリーダーのスケジューリングのポリシーを決定します
schedule.leader-schedule-limit同時に実行されるリーダー スケジューリング タスクの数
schedule.region-schedule-limit同時に実行されるリージョンスケジューリング タスクの数
schedule.replica-schedule-limit同時に実行されるレプリカ スケジューリング タスクの数
schedule.merge-schedule-limit同時に実行されるRegion Mergeのスケジューリング タスクの数
schedule.hot-region-schedule-limit同時に実行されるホットリージョンスケジューリング タスクの数
schedule.hot-region-cache-hits-thresholdリージョンがホット スポットと見なされるしきい値を決定します
schedule.high-space-ratio店舗のキャパシティが十分である閾値比率
schedule.low-space-ratioそれを超えると店舗のキャパシティが不足するしきい値比率
schedule.tolerant-size-ratiobalanceバッファ サイズを制御します
schedule.enable-remove-down-replicaDownReplicaを自動的に削除する機能を有効にするかどうかを決定します
schedule.enable-replace-offline-replica移行する機能を有効にするかどうかを決定しますOfflineReplica
schedule.enable-make-up-replicaレプリカを自動的に補完する機能を有効にするかどうかを決定します
schedule.enable-remove-extra-replica余分なレプリカを削除する機能を有効にするかどうかを決定します
schedule.enable-location-replacement分離レベルのチェックを有効にするかどうかを決定します
schedule.enable-cross-table-mergeクロステーブル マージを有効にするかどうかを決定します
schedule.enable-one-way-merge次の隣接するリージョンとのマージのみを許可する、一方向のマージを有効にします
replication.max-replicasレプリカの最大数を設定します
replication.location-labelsTiKV クラスターのトポロジー情報
replication.enable-placement-rules配置ルールを有効にします
replication.strictly-match-labelラベル チェックを有効にします
pd-server.use-region-storage独立したリージョンストレージを有効にします
pd-server.max-gap-reset-tsタイムスタンプ (BR) をリセットする最大間隔を設定します。
pd-server.key-typeクラスタ キーのタイプを設定します
pd-server.metric-storageクラスタ メトリックのストレージ アドレスを設定します
pd-server.dashboard-addressダッシュボードのアドレスを設定します
replication-mode.replication-modeバックアップモードを設定します

詳細なパラメーターの説明については、 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)
エコシステム
TiDB
TiKV
TiSpark
Chaos Mesh
© 2022 PingCAP. All Rights Reserved.