Overhauling TiKV RocksDB configuration file by tabokie · Pull Request #5746 · pingcap/docs

tabokie · 2021-06-02T07:09:05Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

writecf and lockcf only listed partial configuration items, and their selections aren't consistent.

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

TomShawn · 2021-06-02T07:12:47Z

@tabokie Could you please involve technical review(s)? Thanks~

tabokie · 2021-06-02T07:15:57Z

This change isn't urgent (not due before next release). @yiwu-arbug can help take a look.

tabokie · 2021-06-02T07:16:35Z

BTW I don't have the permission to request reviews in this repo.

TomShawn · 2021-06-02T07:19:02Z

BTW I don't have the permission to request reviews in this repo.

You can use the /cc @reviewer_id command to request a review.

TomShawn · 2021-06-02T07:19:27Z

/cc @yiwu-arbug

yiwu-arbug · 2021-06-02T18:20:19Z

 ## rocksdb.writecf

-Configuration items related to `rocksdb.writecf`
+Configuration items related to `rocksdb.writecf`, which are identical to `rocksdb.defaultcf`. Those not listed here have the same default value and are recommended to be set the same as `rocksdb.defaultcf`.


"Those not listed here have the same default value and are recommended to be set the same as rocksdb.defaultcf."

This may not be always true.

There are two parts in this statement. I think at least we should make sure the first part stay true. For master branch I've checked and repaired all the violating items.

then how about removing "and are recommended to be set the same as rocksdb.defaultcf."?

yiwu-arbug

rest looking good

ti-chi-bot · 2021-06-03T20:44:32Z

@yiwu-arbug: Thanks for your review. The bot only counts approvals from reviewers and higher roles in list, but you're still welcome to leave your comments.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

TomShawn · 2021-06-04T05:34:45Z

 ## rocksdb.writecf

-Configuration items related to `rocksdb.writecf`
+Configuration items related to `rocksdb.writecf`, which are identical to `rocksdb.defaultcf`. Those not listed here have the same default value as `rocksdb.defaultcf`.


What does it mean by "Those not listed here"? Are there any config items that are not documented here?

Yes, they are the same as rocksdb.defaultcf. Listing all of the duplicates would be cumbersome.

I don't think so. Suppose that you want to see a TiKV config item under rocksdb.writecf but are told to see the config items under rocksdb.defaultcf (another section) because they are duplicated and, therefore, documented only in one place. Both document completeness and user experience are compromised. One possible solution to that is to document all the config items in one place but the title should incorporate both rocksdb.writecf and rocksdb.defaultcf. A note should also be given to explain why they are put together.

Make sense.

TomShawn · 2021-06-04T05:36:53Z

-+ The minimum SST file size when the compaction guard is enabled. This configuration prevents SST files from being too small when the compaction guard is enabled.
-+ Default value: `"8MB"`
-+ Unit: KB|MB|GB
+Configuration items related to `rocksdb.lockcf`, which are identical to `rocksdb.defaultcf`. Those not listed here have the same default value as `rocksdb.defaultcf`.


Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>

ti-chi-bot · 2021-06-28T02:25:58Z

In response to a cherrypick label: new pull request created: #5871.

ti-chi-bot · 2021-06-28T02:26:35Z

In response to a cherrypick label: new pull request created: #5872.

ti-chi-bot · 2021-06-28T02:27:12Z

In response to a cherrypick label: new pull request created: #5873.

Signed-off-by: tabokie <xy.tao@outlook.com>

Overhauling TiKV RocksDB configuration file

cd57f58

ti-chi-bot requested a review from TomShawn June 2, 2021 07:09

ti-chi-bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 2, 2021

TomShawn self-assigned this Jun 2, 2021

TomShawn added needs-cherry-pick-release-2.1 translation/doing This PR's assignee is translating this PR. labels Jun 2, 2021

ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Jun 2, 2021

TomShawn added the requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. label Jun 2, 2021

ti-chi-bot requested a review from yiwu-arbug June 2, 2021 07:19

Fix inconsistency with TiKV master

2d5753c

yiwu-arbug reviewed Jun 2, 2021

View reviewed changes

Comment thread tikv-configuration-file.md Outdated

yiwu-arbug reviewed Jun 2, 2021

View reviewed changes

Address comment

746cc1a

yiwu-arbug approved these changes Jun 3, 2021

View reviewed changes

TomShawn reviewed Jun 4, 2021

View reviewed changes

Address comments

f79b187

ti-chi-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 4, 2021

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Jun 28, 2021

This is an automated cherry-pick of pingcap#5746

68978bb

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>

ti-chi-bot mentioned this pull request Jun 28, 2021

Overhauling TiKV RocksDB configuration file (#5746) #5871

Closed

12 tasks

ti-chi-bot mentioned this pull request Jun 28, 2021

Overhauling TiKV RocksDB configuration file (#5746) #5872

Merged

12 tasks

ti-chi-bot mentioned this pull request Jun 28, 2021

Overhauling TiKV RocksDB configuration file (#5746) #5873

Merged

12 tasks

ti-chi-bot added a commit that referenced this pull request Jun 28, 2021

Overhauling TiKV RocksDB configuration file (#5746) (#5873)

247b380

ti-chi-bot added a commit that referenced this pull request Jun 28, 2021

Overhauling TiKV RocksDB configuration file (#5746) (#5872)

05ae4ef

TomShawn removed the needs-cherry-pick-release-2.1 label Jun 28, 2021

TomShawn mentioned this pull request Jul 8, 2021

TiKV configuration: defaultcf.titan config should not apply to other CFs #5936

Merged

12 tasks

This was referenced Jul 8, 2021

TiKV configuration: defaultcf.titan config should not apply to other CFs (#5936) #5943

Merged

TiKV configuration: defaultcf.titan config should not apply to other CFs (#5936) #5944

Merged

tabokie added a commit to tabokie/docs that referenced this pull request Jul 12, 2021

Overhauling TiKV RocksDB configuration file (pingcap#5746)

3d20b02

Signed-off-by: tabokie <xy.tao@outlook.com>

tabokie added a commit to tabokie/docs that referenced this pull request Jul 12, 2021

Overhauling TiKV RocksDB configuration file (pingcap#5746)

1bf6179

Signed-off-by: tabokie <xy.tao@outlook.com>

tabokie added a commit to tabokie/docs that referenced this pull request Jul 12, 2021

Overhauling TiKV RocksDB configuration file (pingcap#5746)

62f8e60

Signed-off-by: tabokie <xy.tao@outlook.com>

This was referenced Jul 12, 2021

Overhauling TiKV RocksDB configuration file (#5746) #5966

Merged

Overhauling TiKV RocksDB configuration file (#5746) #5967

Merged

Overhauling TiKV RocksDB configuration file (#5746) #5968

Merged

ti-chi-bot pushed a commit that referenced this pull request Jul 12, 2021

Overhauling TiKV RocksDB configuration file (#5746) (#5968)

5028ad1

ti-chi-bot pushed a commit that referenced this pull request Jul 12, 2021

Overhauling TiKV RocksDB configuration file (#5746) (#5966)

2a50991

ti-chi-bot pushed a commit that referenced this pull request Jul 12, 2021

Overhauling TiKV RocksDB configuration file (#5746) (#5967)

56fee56

TomShawn assigned en-jin19 and unassigned TomShawn Jul 27, 2021

en-jin19 mentioned this pull request Aug 5, 2021

TiKV configuration: integrate writecf and lockcf to one part with defaultcf pingcap/docs-cn#6816

Merged

11 tasks

en-jin19 added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Aug 5, 2021

Conversation

tabokie commented Jun 2, 2021 • edited by TomShawn Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Uh oh!

TomShawn commented Jun 2, 2021

Uh oh!

tabokie commented Jun 2, 2021

Uh oh!

tabokie commented Jun 2, 2021

Uh oh!

TomShawn commented Jun 2, 2021

Uh oh!

TomShawn commented Jun 2, 2021

Uh oh!

yiwu-arbug Jun 2, 2021

Choose a reason for hiding this comment

Uh oh!

tabokie Jun 3, 2021

Choose a reason for hiding this comment

Uh oh!

yiwu-arbug Jun 3, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yiwu-arbug left a comment

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot commented Jun 3, 2021

Uh oh!

TomShawn Jun 4, 2021

Choose a reason for hiding this comment

Uh oh!

tabokie Jun 4, 2021

Choose a reason for hiding this comment

Uh oh!

TomShawn Jun 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tabokie Jun 4, 2021

Choose a reason for hiding this comment

Uh oh!

TomShawn Jun 4, 2021

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot commented Jun 28, 2021

Uh oh!

ti-chi-bot commented Jun 28, 2021

Uh oh!

ti-chi-bot commented Jun 28, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tabokie commented Jun 2, 2021 •

edited by TomShawn

Loading

TomShawn Jun 4, 2021 •

edited

Loading