重要

このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

TiKV Controlユーザーガイド

TiKV Control ( tikv-ctl )は、クラスターの管理に使用されるTiKVのコマンドラインツールです。インストールディレクトリは次のとおりです。

クラスターがTiUPを使用してデプロイされている場合、 tikv-ctlディレクトリが~/.tiup/components/ctl/{VERSION}/ディレクトリ内にあります。

TiUPでTiKV Controlを使用する

注記：
使用する制御ツールのバージョンは、クラスターのバージョンと一致させることをお勧めします。

tikv-ctlはtiupコマンドにも統合tikv-ctlれています。4 ツールを呼び出すには、次のコマンドを実行します。

tiup ctl:v<CLUSTER_VERSION> tikv

Starting component `ctl`: /home/tidb/.tiup/components/ctl/v4.0.8/ctl tikv
TiKV Control (tikv-ctl)
Release Version:   4.0.8
Edition:           Community
Git Commit Hash:   83091173e960e5a0f5f417e921a0801d2f6635ae
Git Commit Branch: heads/refs/tags/v4.0.8
UTC Build Time:    2020-10-30 08:40:33
Rust Version:      rustc 1.42.0-nightly (0de96d37f 2019-12-19)
Enable Features:   jemalloc mem-profiling portable sse protobuf-codec
Profile:           dist_release

A tool for interacting with TiKV deployments.
USAGE:
    TiKV Control (tikv-ctl) [FLAGS] [OPTIONS] [SUBCOMMAND]
FLAGS:
    -h, --help                    Prints help information
        --skip-paranoid-checks    Skip paranoid checks when open rocksdb
    -V, --version                 Prints version information
OPTIONS:
        --ca-path <ca-path>              Set the CA certificate path
        --cert-path <cert-path>          Set the certificate path
        --config <config>                TiKV config path, by default it's <deploy-dir>/conf/tikv.toml
        --data-dir <data-dir>            TiKV data directory path, check <deploy-dir>/scripts/run.sh to get it
        --decode <decode>                Decode a key in escaped format
        --encode <encode>                Encode a key in escaped format
        --to-hex <escaped-to-hex>        Convert an escaped key to hex key
        --to-escaped <hex-to-escaped>    Convert a hex key to escaped key
        --host <host>                    Set the remote host
        --key-path <key-path>            Set the private key path
        --log-level <log-level>          Set the log level [default: warn]
        --pd <pd>                        Set the address of pd
SUBCOMMANDS:
    bad-regions           Get all regions with corrupt raft
    cluster               Print the cluster id
    compact               Compact a column family in a specified range
    compact-cluster       Compact the whole cluster in a specified range in one or more column families
    consistency-check     Force a consistency-check for a specified region
    decrypt-file          Decrypt an encrypted file
    diff                  Calculate difference of region keys from different dbs
    dump-snap-meta        Dump snapshot meta file
    encryption-meta       Dump encryption metadata
    fail                  Inject failures to TiKV and recovery
    help                  Prints this message or the help of the given subcommand(s)
    metrics               Print the metrics
    modify-tikv-config    Modify tikv config, eg. tikv-ctl --host ip:port modify-tikv-config -n
                          rocksdb.defaultcf.disable-auto-compactions -v true
    mvcc                  Print the mvcc value
    print                 Print the raw value
    raft                  Print a raft log entry
    raw-scan              Print all raw keys in the range
    recover-mvcc          Recover mvcc data on one node by deleting corrupted keys
    recreate-region       Recreate a region with given metadata, but alloc new id for it
    region-properties     Show region properties
    scan                  Print the range db range
    size                  Print region size
    split-region          Split the region
    store                 Print the store id
    tombstone             Set some regions on the node to tombstone by manual
    unsafe-recover        Unsafely recover the cluster when the majority replicas are failed

tiup ctl:v<CLUSTER_VERSION> tikv後に対応するパラメータとサブコマンドを追加できます。

一般的なオプション

tikv-ctlは 2 つの動作モードがあります。

リモートモード: --hostオプションを使用して、TiKVのサービスアドレスを引数として受け入れます
このモードでは、TiKV で SSL が有効になっている場合、関連する証明書ファイルも指定する必要がtikv-ctlます。例:
```
tikv-ctl --ca-path ca.pem --cert-path client.pem --key-path client-key.pem --host 127.0.0.1:20160 <subcommands>
```
ただし、 tikv-ctl TiKV ではなく PD と通信する場合があります。この場合、 --hostではなく--pdオプションを使用する必要があります。次に例を示します。
```
tikv-ctl --pd 127.0.0.1:2379 compact-cluster
```
```
store:"127.0.0.1:20160" compact db:KV cf:default range:([], []) success!
```
ローカルモード:
- ローカル TiKV データディレクトリパスを指定するには、 --data-dirオプションを使用します。
- ローカル TiKV 構成ファイルパスを指定するには、 --configオプションを使用します。
このモードでは、実行中の TiKV インスタンスを停止する必要があります。

特に明記されていない限り、すべてのコマンドはリモートモードとローカルモードの両方をサポートします。

さらに、 tikv-ctlは--to-hexと--to-escaped 2 つの簡単なコマンドがあり、これらを使用してキーの形式に簡単な変更を加えることができます。

通常は、キーのescaped形式を使用します。例:

tikv-ctl --to-escaped 0xaaff
\252\377
tikv-ctl --to-hex "\252\377"
AAFF

注記：
コマンドラインでキーのescaped形式を指定する場合は、二重引用符で囲む必要があります。そうしないと、bash がバックスラッシュを解釈してしまい、間違った結果が返されます。

サブコマンド、いくつかのオプションとフラグ

このセクションでは、 tikv-ctlサポートするサブコマンドについて詳しく説明します。一部のサブコマンドは多くのオプションをサポートします。すべての詳細については、 tikv-ctl --help <subcommand>実行してください。

Raftステートマシンの情報をビュー

特定の瞬間のRaftステートマシンのステータスを表示するには、 raftサブコマンドを使用します。ステータス情報には、3 つの構造体 ( RegionLocalState 、 RaftLocalState 、およびRegionApplyState ) と、特定のログの対応するエントリの 2 つの部分が含まれます。

上記の情報を取得するには、それぞれサブコマンドregionとlog使用します。 2 つのサブコマンドは、リモートモードとローカルモードを同時にサポートします。

regionサブコマンドの場合:

表示する地域を指定するには、 -rオプションを使用します。複数の地域を指定する場合は,で区切ります。 --all-regionsオプションを使用してすべての地域を表示することもできます。 -rと--all-regions同時に使用できないことに注意してください。
印刷する領域の数を制限するには、 --limitオプションを使用します (デフォルト: 16 )。
特定のキー範囲に含まれるリージョンを照会するには、 --startおよび--endオプションを使用します (デフォルト: 範囲制限なし、16 進形式)。

たとえば、ID 1239のリージョンを印刷するには、次のコマンドを使用します。

tikv-ctl --host 127.0.0.1:20160 raft region -r 1239

出力は次のようになります。

"region id": 1239
"region state": {
    id: 1239,
    start_key: 7480000000000000FF4E5F728000000000FF1443770000000000FA,
    end_key: 7480000000000000FF4E5F728000000000FF21C4420000000000FA,
    region_epoch: {conf_ver: 1 version: 43},
    peers: [ {id: 1240 store_id: 1 role: Voter} ]
}
"raft state": {
    hard_state {term: 8 vote: 5 commit: 7}
    last_index: 8)
}
"apply state": {
    applied_index: 8 commit_index: 8 commit_term: 8
    truncated_state {index: 5 term: 5}
}

特定のキー範囲に含まれるリージョンを照会するには、次のコマンドを使用します。

キー範囲がリージョン範囲内にある場合は、リージョン情報が出力されます。
キー範囲がリージョン範囲と同じ場合、たとえば、指定されたキー範囲がリージョン1239と同じ場合、リージョン範囲は左閉じ右開きの間隔であり、リージョン1009リージョン1239のend_keyをstart_keyとして取得するため、リージョン1009情報も出力されます。

tikv-ctl --host 127.0.0.1:20160 raft region --start 7480000000000000FF4E5F728000000000FF1443770000000000FA --end 7480000000000000FF4E5F728000000000FF21C4420000000000FA

出力は次のようになります。

"region state": {
    id: 1009
    start_key: 7480000000000000FF4E5F728000000000FF21C4420000000000FA,
    end_key: 7480000000000000FF5000000000000000F8,
    ...
}
"region state": {
    id: 1239
    start_key: 7480000000000000FF4E5F728000000000FF06C6D60000000000FA,
    end_key: 7480000000000000FF4E5F728000000000FF1443770000000000FA,
    ...
}

リージョンサイズをビュー

リージョンのサイズを表示するには、 sizeコマンドを使用します。

tikv-ctl --data-dir /path/to/tikv size -r 2

出力は次のようになります。

region id: 2
cf default region size: 799.703 MB
cf write region size: 41.250 MB
cf lock region size: 27616

スキャンして特定の範囲のMVCCを表示する

scanコマンドの--fromおよび--toオプションは、2 つのエスケープ形式の生のキーを受け入れ、 --show-cfフラグを使用して、表示する必要がある列ファミリを指定します。

tikv-ctl --data-dir /path/to/tikv scan --from 'zm' --limit 2 --show-cf lock,default,write

key: zmBootstr\377a\377pKey\000\000\377\000\000\373\000\000\000\000\000\377\000\000s\000\000\000\000\000\372
         write cf value: start_ts: 399650102814441473 commit_ts: 399650102814441475 short_value: "20"
key: zmDB:29\000\000\377\000\374\000\000\000\000\000\000\377\000H\000\000\000\000\000\000\371
         write cf value: start_ts: 399650105239273474 commit_ts: 399650105239273475 short_value: "\000\000\000\000\000\000\000\002"
         write cf value: start_ts: 399650105199951882 commit_ts: 399650105213059076 short_value: "\000\000\000\000\000\000\000\001"

指定されたキーのMVCCをビュー

scanコマンドと同様に、 mvccコマンドを使用して、特定のキーの MVCC を表示できます。

tikv-ctl --data-dir /path/to/tikv mvcc -k "zmDB:29\000\000\377\000\374\000\000\000\000\000\000\377\000H\000\000\000\000\000\000\371" --show-cf=lock,write,default

key: zmDB:29\000\000\377\000\374\000\000\000\000\000\000\377\000H\000\000\000\000\000\000\371
         write cf value: start_ts: 399650105239273474 commit_ts: 399650105239273475 short_value: "\000\000\000\000\000\000\000\002"
         write cf value: start_ts: 399650105199951882 commit_ts: 399650105213059076 short_value: "\000\000\000\000\000\000\000\001"

このコマンドでは、キーは生のキーのエスケープされた形式でもあります。

生のキーをスキャンする

raw-scanコマンドは RocksDB から直接スキャンします。データキーをスキャンするには、キーに'z'プレフィックスを追加する必要があることに注意してください。

スキャンする範囲を指定するには、 --fromと--toオプションを使用します (デフォルトでは無制限)。出力するキーの最大数を制限したい場合は、 --limit使用します (デフォルトでは 30 個)。スキャンする cf を指定するには、 --cf使用します ( default 、 write 、またはlockを指定できます)。

tikv-ctl --data-dir /var/lib/tikv raw-scan --from 'zt' --limit 2 --cf default

key: "zt\200\000\000\000\000\000\000\377\005_r\200\000\000\000\000\377\000\000\001\000\000\000\000\000\372\372b2,^\033\377\364", value: "\010\002\002\002%\010\004\002\010root\010\006\002\000\010\010\t\002\010\n\t\002\010\014\t\002\010\016\t\002\010\020\t\002\010\022\t\002\010\024\t\002\010\026\t\002\010\030\t\002\010\032\t\002\010\034\t\002\010\036\t\002\010 \t\002\010\"\t\002\010s\t\002\010&\t\002\010(\t\002\010*\t\002\010,\t\002\010.\t\002\0100\t\002\0102\t\002\0104\t\002"
key: "zt\200\000\000\000\000\000\000\377\025_r\200\000\000\000\000\377\000\000\023\000\000\000\000\000\372\372b2,^\033\377\364", value: "\010\002\002&slow_query_log_file\010\004\002P/usr/local/mysql/data/localhost-slow.log"

Total scanned keys: 2

特定のキー値を印刷する

キーの値を印刷するには、 printコマンドを使用します。

リージョンに関するいくつかのプロパティを印刷する

リージョンの状態の詳細を記録するために、TiKV はリージョンの SST ファイルにいくつかの統計情報を書き込みます。これらのプロパティを表示するには、サブコマンドregion-propertiesでtikv-ctl実行します。

tikv-ctl --host localhost:20160 region-properties -r 2

num_files: 0
num_entries: 0
num_deletes: 0
mvcc.min_ts: 18446744073709551615
mvcc.max_ts: 0
mvcc.num_rows: 0
mvcc.num_puts: 0
mvcc.num_versions: 0
mvcc.max_row_versions: 0
middle_key_by_approximate_size:

プロパティを使用して、リージョンが正常かどうかを確認できます。正常でない場合は、それらを使用してリージョンを修正できます。たとえば、リージョンを手動でmiddle_key_approximate_sizeに分割します。

各TiKVのデータを手動で圧縮する

compactコマンドを使用して、各 TiKV のデータを手動で圧縮します。

--fromと--toオプションを使用して、エスケープされた生のキーの形式で圧縮範囲を指定します。設定されていない場合は、範囲全体が圧縮されます。
特定の領域の範囲を圧縮するには、 --regionオプションを使用します。設定されている場合、 --fromと--to無視されます。
カラムファミリー名を指定するには、 -cオプションを使用します。デフォルト値はdefaultです。オプションの値はdefault 、 lock 、およびwriteです。
-dオプションを使用して、圧縮を実行する RocksDB を指定します。デフォルト値はkvです。オプションの値はkvとraftです。
--threadsオプションを使用すると、TiKV 圧縮の同時実行性を指定できます。デフォルト値は8です。通常、同時実行性が高いほど圧縮速度が速くなりますが、サービスに影響する可能性があります。シナリオに基づいて適切な同時実行数を選択する必要があります。
--bottommostオプションを使用すると、TiKV が圧縮を実行するときに最下位のファイルを含めるか除外するかを指定できます。値のオプションはdefault 、 skip 、 forceです。デフォルト値はdefaultです。
- default圧縮フィルター機能が有効な場合にのみ最下位のファイルが含まれることを意味します。
- skip TiKV が圧縮を実行するときに最下位のファイルが除外されることを意味します。
- force TiKV が圧縮を実行するときに最下位のファイルが常に含まれることを意味します。
ローカルモードでデータを圧縮するには、次のコマンドを使用します。
```
tikv-ctl --data-dir /path/to/tikv compact -d kv
```
リモートモードでデータを圧縮するには、次のコマンドを使用します。
```
tikv-ctl --host ip:port compact -d kv
```

TiKVクラスタ全体のデータを手動で圧縮する

compact-clusterコマンドを使用して、TiKV クラスター全体のデータを手動で圧縮します。このコマンドのフラグは、 compactコマンドと同じ意味と使用法を持ちます。唯一の違いは次のとおりです。

compact-clusterコマンドでは、 --pd使用して PD のアドレスを指定します。これにより、 tikv-ctlクラスター内のすべての TiKV ノードをコンパクトターゲットとして見つけることができます。
compactコマンドの場合、 --data-dirまたは--host使用して、単一の TiKV をコンパクトターゲットとして指定します。

リージョンを墓石に設定する

tombstoneコマンドは通常、sync-log が有効になっていない状況で使用され、 Raftステートマシンに書き込まれたデータの一部が電源オフによって失われます。

TiKV インスタンスでは、このコマンドを使用して、一部のリージョンのステータスをトゥームストーンに設定できます。その後、インスタンスを再起動すると、それらのリージョンはスキップされ、それらのリージョンのRaftステートマシンの破損による再起動の失敗を回避します。それらのリージョンには、 Raftメカニズムを介して読み取りと書き込みを続行できるように、他の TiKV インスタンスに十分な正常なレプリカが必要です。

一般的なケースでは、 remove-peerコマンドを使用してこのリージョンの対応するピアを削除できます。

pd-ctl operator add remove-peer <region_id> <store_id>

次に、 tikv-ctlツールを使用して、対応する TiKV インスタンスのリージョンをトゥームストーンに設定し、起動時にこのリージョンのヘルスチェックをスキップします。

tikv-ctl --data-dir /path/to/tikv tombstone -p 127.0.0.1:2379 -r <region_id>

success!

ただし、場合によっては、このリージョンのこのピアを PD から簡単に削除できないため、 tikv-ctlの--forceのオプションを指定して、ピアを強制的にトゥームストーンに設定できます。

tikv-ctl --data-dir /path/to/tikv tombstone -p 127.0.0.1:2379 -r <region_id>,<region_id> --force

success!

注記：
tombstoneコマンドはローカルモードのみをサポートします。
-pオプションの引数は、 httpプレフィックスなしで PD エンドポイントを指定します。PD エンドポイントを指定するのは、PD が Tombstone に安全に切り替えることができるかどうかを照会するためです。

TiKVに`consistency-check`リクエストを送信する

consistency-checkコマンドを使用して、特定のリージョンの対応するRaft内のレプリカ間の整合性チェックを実行します。チェックが失敗すると、TiKV 自体がパニック--hostなります。3 で指定された TiKV インスタンスがリージョンリーダーでない場合は、エラーが報告されます。

tikv-ctl --host 127.0.0.1:20160 consistency-check -r 2
success!
tikv-ctl --host 127.0.0.1:20161 consistency-check -r 2
DebugClient::check_region_consistency: RpcFailure(RpcStatus { status: Unknown, details: Some("StringError(\"Leader is on store 1\")") })

注記：
consistency-checkコマンドは TiDB のガベージコレクションと互換性がなく、誤ってエラーを報告する可能性があるため、使用はお勧めしません。
このコマンドはリモートモードのみをサポートします。
このコマンドがsuccess!返した場合でも、TiKV がパニックを起こすかどうかを確認する必要があります。これは、このコマンドがリーダーに対して一貫性チェックを要求する提案に過ぎず、チェックプロセス全体が成功したかどうかをクライアントから知ることができないためです。

スナップショットのメタをダンプする

このサブコマンドは、指定されたパスのスナップショットメタファイルを解析し、結果を印刷するために使用されます。

Raftステートマシンが破損した領域を印刷する

TiKV の起動中に領域をチェックしないようにするには、 tombstoneコマンドを使用して、 Raftステートマシンが Tombstone にエラーを報告する領域を設定できます。このコマンドを実行する前に、 bad-regionsコマンドを使用してエラーのある領域を見つけ、複数のツールを組み合わせて自動処理できるようにします。

tikv-ctl --data-dir /path/to/tikv bad-regions

all regions are healthy

コマンドが正常に実行されると、上記の情報が出力。コマンドが失敗すると、不良領域のリストが出力。現在、検出できるエラーには、 last index 、 commit index 、 apply indexの不一致と、 Raftログの損失が含まれます。スナップショットファイルの破損などの他の条件については、さらにサポートが必要です。

リージョンのプロパティをビュー

/path/to/tikvにデプロイされている TiKV インスタンスのリージョン2 のプロパティをローカルで表示するには:
```
tikv-ctl --data-dir /path/to/tikv/data region-properties -r 2
```
127.0.0.1:20160で実行されている TiKV インスタンスのリージョン2 のプロパティをオンラインで表示するには:
```
tikv-ctl --host 127.0.0.1:20160 region-properties -r 2
```

TiKV設定を動的に変更する

modify-tikv-configコマンドを使用して、構成引数を動的に変更できます。現在、動的に変更できる TiKV 構成項目と詳細な変更は、SQL ステートメントを使用した構成の変更と一致しています。詳細については、 TiKV 構成を動的に変更する参照してください。

-n構成項目の完全な名前を指定するために使用されます。動的に変更できる構成項目のリストについては、 TiKV 構成を動的に変更する参照してください。
-v設定値を指定するために使用されます。

shared block cacheのサイズを設定します:

tikv-ctl --host ip:port modify-tikv-config -n storage.block-cache.capacity -v 10GB

success

shared block cacheが無効の場合は、 write CF にblock cache size設定します。

tikv-ctl --host ip:port modify-tikv-config -n rocksdb.writecf.block-cache-size -v 256MB

success

tikv-ctl --host ip:port modify-tikv-config -n raftdb.defaultcf.disable-auto-compactions -v true

success

tikv-ctl --host ip:port modify-tikv-config -n raftstore.sync-log -v false

success

圧縮レート制限によって圧縮保留バイトが蓄積される場合は、 rate-limiter-auto-tunedモードを無効にするか、圧縮フローの制限を高く設定します。

tikv-ctl --host ip:port modify-tikv-config -n rocksdb.rate-limiter-auto-tuned -v false

success

tikv-ctl --host ip:port modify-tikv-config -n rocksdb.rate-bytes-per-sec -v "1GB"

success

複数のレプリカの障害からリージョンにサービスを強制的に回復させる (非推奨)

警告

この機能の使用は推奨されません。代わりに、ワンストップ自動リカバリ機能を提供するpd-ctlの Online Unsafe Recovery を使用できます。サービスの停止などの追加操作は必要ありません。詳細な説明については、オンラインの安全でない回復参照してください。

unsafe-recover remove-fail-storesコマンドを使用すると、リージョンのピアリストから障害が発生したマシンを削除できます。このコマンドを実行する前に、対象の TiKV ストアのサービスを停止してファイルロックを解除する必要があります。

-sオプションは、カンマで区切られた複数のstore_id受け入れ、 -rフラグを使用して関連するリージョンを指定します。特定のストア内のすべてのリージョンに対してこの操作を実行する必要がある場合は、 --all-regions指定するだけです。

警告

誤った操作が行われた場合、クラスターの回復が困難になる可能性があります。潜在的なリスクを認識し、本番環境ではこの機能を使用しないでください。
--all-regionsオプションを使用する場合は、クラスターに接続されている残りのすべてのストアでこのコマンドを実行する必要があります。損傷したストアを回復する前に、これらの正常なストアがサービスの提供を停止していることを確認する必要があります。そうしないと、リージョンレプリカのピアリストが一致していないために、 split-regionまたはremove-peer実行したときにエラーが発生します。これにより、他のメタデータ間の不一致がさらに発生し、最終的にリージョンが使用できなくなります。
remove-fail-stores実行すると、削除したノードを再起動したり、これらのノードをクラスターに追加したりすることはできません。そうしないと、メタデータに不整合が生じ、最終的にリージョンが使用できなくなります。

tikv-ctl --data-dir /path/to/tikv unsafe-recover remove-fail-stores -s 3 -r 1001,1002

success!

tikv-ctl --data-dir /path/to/tikv unsafe-recover remove-fail-stores -s 4,5 --all-regions

その後、TiKV を再起動すると、リージョンは残りの正常なレプリカを使用してサービスを引き続き提供できます。このコマンドは、複数の TiKV ストアが破損または削除された場合によく使用されます。

注記：
指定されたリージョンのピアが配置されているすべてのストアに対してこのコマンドを実行する必要があります。
このコマンドはローカルモードのみをサポートします。正常に実行されるとsuccess!が出力。

MVCCデータ破損からの回復

MVCC データの破損により TiKV が正常に実行できない場合は、 recover-mvccコマンドを使用します。このコマンドは、3 つの CF (「default」、「write」、「lock」) をクロスチェックして、さまざまな種類の不整合から回復します。

-rオプションを使用して、 region_idで関係する領域を指定します。
PD エンドポイントを指定するには、 -pオプションを使用します。

tikv-ctl --data-dir /path/to/tikv recover-mvcc -r 1001,1002 -p 127.0.0.1:2379
success!

注記：
このコマンドはローカルモードのみをサポートします。正常に実行されるとsuccess!が出力。
-pオプションの引数は、 httpプレフィックスなしで PD エンドポイントを指定します。PD エンドポイントを指定すると、指定されたregion_idが検証されているかどうかが照会されます。
指定されたリージョンのピアが配置されているすべてのストアに対してこのコマンドを実行する必要があります。

Ldb コマンド

ldbコマンドラインツールは、複数のデータアクセスコマンドとデータベース管理コマンドを提供します。以下にいくつかの例を示します。詳細については、 tikv-ctl ldb実行時に表示されるヘルプメッセージを参照するか、RocksDB のドキュメントを確認してください。

データアクセスシーケンスの例:

既存の RocksDB を HEX でダンプするには:

tikv-ctl ldb --hex --db=/tmp/db dump

既存の RocksDB のマニフェストをダンプするには:

tikv-ctl ldb --hex manifest_dump --path=/tmp/db/MANIFEST-000001

--column_family=<string>コマンドラインを使用して、クエリの対象となるカラムファミリーを指定できます。

--try_load_optionsデータベースを開くためにデータベースオプションファイルをロードします。データベースの実行中は常にこのオプションをオンにしておくことをお勧めします。デフォルトオプションでデータベースを開くと、LSM ツリーが乱れる可能性があり、自動的に回復することはできません。

暗号化メタデータをダンプする

暗号化メタデータをダンプするには、サブコマンドencryption-metaを使用します。サブコマンドは、データファイルの暗号化情報と、使用されるデータ暗号化キーのリストの 2 種類のメタデータをダンプできます。

データファイルの暗号化情報をダンプするには、 encryption-meta dump-fileサブコマンドを使用します。TiKV デプロイメントにdata-dir指定するには、TiKV 構成ファイルを作成する必要があります。

# conf.toml
[storage]
data-dir = "/path/to/tikv/data"

--pathオプションを使用すると、対象のデータファイルへの絶対パスまたは相対パスを指定できます。データファイルが暗号化されていない場合、コマンドは空の出力を返すことがあります--path指定しないと、すべてのデータファイルの暗号化情報が出力されます。

tikv-ctl --config=./conf.toml encryption-meta dump-file --path=/path/to/tikv/data/db/CURRENT

/path/to/tikv/data/db/CURRENT: key_id: 9291156302549018620 iv: E3C2FDBF63FC03BFC28F265D7E78283F method: Aes128Ctr

データ暗号化キーをダンプするには、 encryption-meta dump-keyサブコマンドを使用します。 data-dirに加えて、設定ファイルで現在使用されているマスターキーも指定する必要があります。マスターキーの設定方法については、保存時の暗号化を参照してください。また、このコマンドでは、 security.encryption.previous-master-key設定は無視され、マスターキーのローテーションはトリガーされません。

# conf.toml
[storage]
data-dir = "/path/to/tikv/data"

[security.encryption.master-key]
type = "kms"
key-id = "0987dcba-09fe-87dc-65ba-ab0987654321"
region = "us-west-2"

マスターキーが AWS KMS キーの場合、 tikv-ctl KMS キーにアクセスできる必要があります。AWS KMS キーへのアクセスは、環境変数、AWS デフォルト設定ファイル、またはIAMロールのいずれか適切なものを介してtikv-ctlに付与できます。使用方法については、AWS ドキュメントを参照してください。

--idsオプションを使用すると、印刷するデータ暗号化キー ID のリストをコンマで区切って指定できます。3 --ids指定しない場合は、最新のアクティブなデータ暗号化キーの ID である現在のキー ID とともに、すべてのデータ暗号化キーが印刷されます。

コマンドを使用すると、アクションによって機密情報が公開されるという警告が表示されます。続行するには、「同意します」と入力してください。

tikv-ctl --config=./conf.toml encryption-meta dump-key

This action will expose encryption key(s) as plaintext. Do not output the result in file on disk.
Type "I consent" to continue, anything else to exit: I consent
current key id: 9291156302549018620
9291156302549018620: key: 8B6B6B8F83D36BE2467ED55D72AE808B method: Aes128Ctr creation_time: 1592938357

tikv-ctl --config=./conf.toml encryption-meta dump-key --ids=9291156302549018620

This action will expose encryption key(s) as plaintext. Do not output the result in file on disk.
Type "I consent" to continue, anything else to exit: I consent
9291156302549018620: key: 8B6B6B8F83D36BE2467ED55D72AE808B method: Aes128Ctr creation_time: 1592938357

注記：
このコマンドは、データ暗号化キーをプレーンテキストとして公開します。本番では、出力をファイルにリダイレクトしないでください。後で出力ファイルを削除しても、ディスクからコンテンツが完全に消去されない可能性があります。

TiKV 内の破損した SST ファイルにより、TiKV プロセスがpanicになる可能性があります。TiDB v6.1.0 より前では、これらのファイルにより TiKV は直ちにpanicになりました。TiDB v6.1.0 以降では、SST ファイルが破損してから 1 時間後に TiKV プロセスがpanic。

破損した SST ファイルをクリーンアップするには、 TiKV Controlでbad-sstsコマンドを実行して必要な情報を表示します。以下はコマンドと出力の例です。

注記：
このコマンドを実行する前に、実行中の TiKV インスタンスを停止してください。

tikv-ctl --data-dir </path/to/tikv> bad-ssts --pd <endpoint>

--------------------------------------------------------
corruption info:
data/tikv-21107/db/000014.sst: Corruption: Bad table magic number: expected 9863518390377041911, found 759105309091689679 in data/tikv-21107/db/000014.sst

sst meta:
14:552997[1 .. 5520]['0101' seq:1, type:1 .. '7A7480000000000000FF0F5F728000000000FF0002160000000000FAFA13AB33020BFFFA' seq:2032, type:1] at level 0 for Column family "default"  (ID 0)
it isn't easy to handle local data, start key:0101

overlap region:
RegionInfo { region: id: 4 end_key: 7480000000000000FF0500000000000000F8 region_epoch { conf_ver: 1 version: 2 } peers { id: 5 store_id: 1 }, leader: Some(id: 5 store_id: 1) }

refer operations:
tikv-ctl ldb --db=/path/to/tikv/db unsafe_remove_sst_file 000014
tikv-ctl --data-dir=/path/to/tikv tombstone -r 4 --pd <endpoint>
--------------------------------------------------------
corruption analysis has completed

上記の出力から、破損した SST ファイルの情報が最初に印刷され、次にメタ情報が印刷されていることがわかります。

sst meta部分では、 14 SST ファイル番号、 552997ファイルサイズを意味し、その後に最小および最大のシーケンス番号とその他のメタ情報が続きます。
overlap region部分は、関連するリージョンの情報を示しています。この情報は PDサーバーから取得されます。
パートsuggested operationsでは、破損した SST ファイルをクリーンアップするための提案が提供されます。提案に従ってファイルをクリーンアップし、TiKV インスタンスを再起動できます。

リージョンの`RegionReadProgress`の状態を取得する

v6.5.4 および v7.3.0 以降、TiKV では、リゾルバの最新の詳細を取得するためのget-region-read-progressサブコマンドとRegionReadProgressが導入されています。リージョンID と TiKV を指定する必要があります。これらは、Grafana ( Min Resolved TS RegionとMin Safe TS Region ) またはDataIsNotReadyログから取得できます。

--log (オプション): 指定すると、TiKV は、この TiKV のリージョンのリゾルバ内のロックのうち最小のstart_tsをレベルINFOでログに記録します。このオプションは、resolved-ts をブロックする可能性のあるロックを事前に識別するのに役立ちます。
--min-start-ts (オプション): 指定すると、TiKV はログでこの値よりstart_ts小さいロックをフィルターします。これを使用して、ログに記録するトランザクションを指定できます。デフォルトは0で、フィルターなしを意味します。

次に例を示します。

./tikv-ctl --host 127.0.0.1:20160 get-region-read-progress -r 14 --log --min-start-ts 0

出力は次のようになります。

Region read progress:
    exist: true,
    safe_ts: 0,
    applied_index: 92,
    pending front item (oldest) ts: 0,
    pending front item (oldest) applied index: 0,
    pending back item (latest) ts: 0,
    pending back item (latest) applied index: 0,
    paused: false,
Resolver:
    exist: true,
    resolved_ts: 0,
    tracked index: 92,
    number of locks: 0,
    number of transactions: 0,
    stopped: false,

このサブコマンドは、ステイル読み取りおよび safe-ts に関連する問題の診断に役立ちます。詳細については、 TiKV のステイル読み取りと safe-ts を理解する参照してください。

TiKV Controlユーザー ガイド

TiUPでTiKV Controlを使用する

一般的なオプション

サブコマンド、いくつかのオプションとフラグ

Raftステートマシンの情報をビュー

リージョンサイズをビュー

スキャンして特定の範囲のMVCCを表示する

指定されたキーのMVCCをビュー

生のキーをスキャンする

特定のキー値を印刷する

リージョンに関するいくつかのプロパティを印刷する

各TiKVのデータを手動で圧縮する

TiKVクラスタ全体のデータを手動で圧縮する

リージョンを墓石に設定する

TiKVにconsistency-checkリクエストを送信する

スナップショットのメタをダンプする

Raftステートマシンが破損した領域を印刷する

リージョンのプロパティをビュー

TiKV設定を動的に変更する

複数のレプリカの障害からリージョンにサービスを強制的に回復させる (非推奨)

MVCCデータ破損からの回復

Ldb コマンド

暗号化メタデータをダンプする

破損したSSTファイルに関連する情報を印刷する

リージョンのRegionReadProgressの状態を取得する

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

TiKV Controlユーザーガイド

TiKVに`consistency-check`リクエストを送信する

リージョンの`RegionReadProgress`の状態を取得する