From 3795fffbc8308ee9cf2f3d2fb57cf6694dae90d2 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 06d4fa2ed57b5..d4b95086be73f 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -758,6 +758,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` @@ -807,7 +811,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 f7588fbd7e84ab00c5dabb936678c09152b2ff66 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 d4b95086be73f..e2512b7083ebd 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -758,10 +758,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` @@ -811,8 +811,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 284f6e70908cb4288d356677e131c28c14ffb8da 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 e2512b7083ebd..3af1dba658199 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -757,7 +757,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 adad847a69846e1bf80330d98b37db2fb54678f0 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 3af1dba658199..ab81d9f7114d1 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -758,7 +758,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 990a39176078742501f46c7e1d79577fe40c04a2 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 ab81d9f7114d1..d8ad71b748c1d 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -759,7 +759,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 a84d65558fa9f75f7215e55b23274f022d1550a1 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 d8ad71b748c1d..a0fe932d8252b 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -760,7 +760,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 ef986d05e1ec5a8885e4e498f94f812d5def88a4 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 a0fe932d8252b..9e928c496fa48 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -811,7 +811,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`