From 479dc41ce36deacb88bdc127c470237dfbdd65ef Mon Sep 17 00:00:00 2001 From: ekexium Date: Fri, 13 Aug 2021 16:19:36 +0800 Subject: [PATCH 1/7] update doc on wal-recovery-mode and use-direct-io-for-flush-and-compaction Signed-off-by: ekexium --- tikv-configuration-file.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index ad34ce379ffd1..9b1e14edd0684 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -718,6 +718,10 @@ Configuration items related to RocksDB + WAL recovery mode + Optional values: `0` (`TolerateCorruptedTailRecords`), `1` (`AbsoluteConsistency`), `2` (`PointInTimeRecovery`), `3` (`SkipAnyCorruptedRecords`) ++ `0` (`TolerateCorruptedTailRecords`): tolerate incomplete record in trailing data on all logs ++ `1` (`AbsoluteConsistency`): we don't expect to find any corruption in the WAL ++ `2` (`PointInTimeRecovery`): recover to point-in-time consistency ++ `3` (`SkipAnyCorruptedRecords`): recovery after a disaster + Default value: `2` + Minimum value: `0` + Maximum value: `3` @@ -767,7 +771,8 @@ Configuration items related to RocksDB ### `use-direct-io-for-flush-and-compaction` -+ Determines whether to use `O_DIRECT` for both reads and writes in background flush and compactions ++ Determines whether to use `O_DIRECT` for both reads and writes in background flush and compactions. ++ In general enabling it can degrade performance. + Default value: `false` ### `rate-bytes-per-sec` From 67a765270ae61639019ff006dad1e67983d02c4d Mon Sep 17 00:00:00 2001 From: ekexium Date: Mon, 30 Aug 2021 19:50:39 +0800 Subject: [PATCH 2/7] update doc on wal-recovery-mode Signed-off-by: ekexium --- tikv-configuration-file.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 9b1e14edd0684..1ad88ef5426cc 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -718,10 +718,10 @@ Configuration items related to RocksDB + WAL recovery mode + Optional values: `0` (`TolerateCorruptedTailRecords`), `1` (`AbsoluteConsistency`), `2` (`PointInTimeRecovery`), `3` (`SkipAnyCorruptedRecords`) -+ `0` (`TolerateCorruptedTailRecords`): tolerate incomplete record in trailing data on all logs -+ `1` (`AbsoluteConsistency`): we don't expect to find any corruption in the WAL -+ `2` (`PointInTimeRecovery`): recover to point-in-time consistency -+ `3` (`SkipAnyCorruptedRecords`): recovery after a disaster ++ `0` (`TolerateCorruptedTailRecords`): tolerate and discard incomplete record in trailing data on all logs ++ `1` (`AbsoluteConsistency`): abandon the recovery when corrupted logs are found ++ `2` (`PointInTimeRecovery`): recover sequentially until the first corrupted log is encoutered ++ `3` (`SkipAnyCorruptedRecords`): recovery after a disaster. Corrupted records are skipped + Default value: `2` + Minimum value: `0` + Maximum value: `3` @@ -771,8 +771,7 @@ Configuration items related to RocksDB ### `use-direct-io-for-flush-and-compaction` -+ Determines whether to use `O_DIRECT` for both reads and writes in background flush and compactions. -+ In general enabling it can degrade performance. ++ Determines whether to use `O_DIRECT` for both reads and writes in background flush and compactions. The performance impact of this option: turning on O_DIRECT bypasses and prevents contamination of the OS buffer cache, but subsequent file reads require re-reading the contents to the buffer cache. + Default value: `false` ### `rate-bytes-per-sec` From cc3c6cb2aa049f00edcf0ea5cec15476403d00e3 Mon Sep 17 00:00:00 2001 From: Ziqian Qin Date: Tue, 31 Aug 2021 13:53:45 +0800 Subject: [PATCH 3/7] Update tikv-configuration-file.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- tikv-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 1ad88ef5426cc..531a3c0cc6c79 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -717,7 +717,7 @@ Configuration items related to RocksDB ### `wal-recovery-mode` + WAL recovery mode -+ Optional values: `0` (`TolerateCorruptedTailRecords`), `1` (`AbsoluteConsistency`), `2` (`PointInTimeRecovery`), `3` (`SkipAnyCorruptedRecords`) ++ Value options: `0`, `1`, `2`, `3` + `0` (`TolerateCorruptedTailRecords`): tolerate and discard incomplete record in trailing data on all logs + `1` (`AbsoluteConsistency`): abandon the recovery when corrupted logs are found + `2` (`PointInTimeRecovery`): recover sequentially until the first corrupted log is encoutered From e2468c8cea24a0b3cbe3838a8cc8ce9b351ecbfa Mon Sep 17 00:00:00 2001 From: Ziqian Qin Date: Tue, 31 Aug 2021 13:53:57 +0800 Subject: [PATCH 4/7] Update tikv-configuration-file.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- tikv-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 531a3c0cc6c79..6afa8e960cf05 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -718,7 +718,7 @@ Configuration items related to RocksDB + WAL recovery mode + Value options: `0`, `1`, `2`, `3` -+ `0` (`TolerateCorruptedTailRecords`): tolerate and discard incomplete record in trailing data on all logs ++ `0` (`TolerateCorruptedTailRecords`): tolerates and discards the records that have incomplete trailing data on all logs. + `1` (`AbsoluteConsistency`): abandon the recovery when corrupted logs are found + `2` (`PointInTimeRecovery`): recover sequentially until the first corrupted log is encoutered + `3` (`SkipAnyCorruptedRecords`): recovery after a disaster. Corrupted records are skipped From 4c1d67c4471a609af2c098f074d50fbe214ff459 Mon Sep 17 00:00:00 2001 From: Ziqian Qin Date: Tue, 31 Aug 2021 13:54:07 +0800 Subject: [PATCH 5/7] Update tikv-configuration-file.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- tikv-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 6afa8e960cf05..e504d143f5cf0 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -719,7 +719,7 @@ Configuration items related to RocksDB + WAL recovery mode + Value options: `0`, `1`, `2`, `3` + `0` (`TolerateCorruptedTailRecords`): tolerates and discards the records that have incomplete trailing data on all logs. -+ `1` (`AbsoluteConsistency`): abandon the recovery when corrupted logs are found ++ `1` (`AbsoluteConsistency`): abandons recovery when corrupted logs are found. + `2` (`PointInTimeRecovery`): recover sequentially until the first corrupted log is encoutered + `3` (`SkipAnyCorruptedRecords`): recovery after a disaster. Corrupted records are skipped + Default value: `2` From 0e6f07b2cce447aea9278e8a3ebcc13363e48842 Mon Sep 17 00:00:00 2001 From: Ziqian Qin Date: Tue, 31 Aug 2021 13:54:18 +0800 Subject: [PATCH 6/7] Update tikv-configuration-file.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- tikv-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index e504d143f5cf0..215b5c1e8113a 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -720,7 +720,7 @@ Configuration items related to RocksDB + Value options: `0`, `1`, `2`, `3` + `0` (`TolerateCorruptedTailRecords`): tolerates and discards the records that have incomplete trailing data on all logs. + `1` (`AbsoluteConsistency`): abandons recovery when corrupted logs are found. -+ `2` (`PointInTimeRecovery`): recover sequentially until the first corrupted log is encoutered ++ `2` (`PointInTimeRecovery`): recovers log sequentially until the first corrupted log is encountered. + `3` (`SkipAnyCorruptedRecords`): recovery after a disaster. Corrupted records are skipped + Default value: `2` + Minimum value: `0` From c68a28c622e2567702a8968a5e5e1b186a6cac25 Mon Sep 17 00:00:00 2001 From: Ziqian Qin Date: Tue, 31 Aug 2021 13:54:27 +0800 Subject: [PATCH 7/7] Update tikv-configuration-file.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- tikv-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 215b5c1e8113a..c5184056539b0 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -771,7 +771,7 @@ Configuration items related to RocksDB ### `use-direct-io-for-flush-and-compaction` -+ Determines whether to use `O_DIRECT` for both reads and writes in background flush and compactions. The performance impact of this option: turning on O_DIRECT bypasses and prevents contamination of the OS buffer cache, but subsequent file reads require re-reading the contents to the buffer cache. ++ Determines whether to use `O_DIRECT` for both reads and writes in the background flush and compactions. The performance impact of this option: enabling `O_DIRECT` bypasses and prevents contamination of the OS buffer cache, but the subsequent file reads require re-reading the contents to the buffer cache. + Default value: `false` ### `rate-bytes-per-sec`