tikv: recorrect the settings of some configs and supplement missing annotations for several configs. (#20871) #20899
Conversation
Co-authored-by: lucasliang <[email protected]> Co-authored-by: Aolin <[email protected]>
ti-chi-bot
added
area/engine
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ti-chi-bot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request focuses on updating the documentation for various TiDB components, specifically concerning configuration settings. The changes involve recorrecting settings for existing configurations, supplementing missing annotations for newly introduced configurations, and renaming some configurations. The updates span multiple TiDB versions, including master, v9.0, v8.5, v8.4, v8.3 and v8.1. The primary file modified is tikv-configuration-file.md, along with updates to release notes for versions 7.6.0, 8.0.0, 8.1.0 and 8.1.2.
Highlights
- TiKV Configuration Updates: Several TiKV configuration parameters have been modified, added, or renamed. This includes changes to
blob-file-compression,rocksdb.defaultcf.titan.min-blob-size,rocksdb.titan.enabled,gc.num-threads,raftstore.periodic-full-compact-start-times,raftstore.periodic-full-compact-start-max-cpu,zstd-dict-size,log-backup.initial-scan-rate-limit,raftstore.store-io-pool-size,rocksdb.defaultcf.titan.blob-cache-size,rocksdb.titan.max-background-gc,security.encryption.master-key.vendor,rocksdb.defaultcf.titan.shared-blob-cache,security.encryption.master-key.gcp.credential-file-path,memory.enable-thread-exclusive-arena,server.snap-min-ingest-size,low-pri-pool-ratio,pd-report-min-resolved-ts-interval,incremental-scan-concurrency-limit. - TiDB Lightning Configuration Updates: Updates to TiDB Lightning configurations, including modifications to
conflict.max-record-rowsandconflict.threshold, and the addition oflogical-import-batch-size. - TiCDC Configuration Updates: Updates to TiCDC configurations, including the addition of
security.client-allowed-user,security.client-user-required,security.mtls,debezium-disable-schema,tls-certificate-file, andtls-key-file-path. - PD Configuration Updates: Updates to PD configurations, including deprecation of
enable-telemetryand addition ofschedule.enable-heartbeat-breakdown-metrics.
Changelog
Click here to see the changelog
- releases/release-7.6.0.md
- Renamed
raftstore.report-min-resolved-ts-intervaltoraftstore.pd-report-min-resolved-ts-interval. - Modified
blob-file-compressionto usezstdas the default compression algorithm. - Modified
rocksdb.defaultcf.titan.min-blob-sizeto32KBfor new clusters. - Modified
rocksdb.titan.enabledtotruefor new clusters. - Added
cdc.incremental-scan-concurrency-limitto set the maximum queue length for incremental scan tasks. - Added
gc.num-threadsto control the number of GC threads whenenable-compaction-filterisfalse. - Added
raftstore.periodic-full-compact-start-timesto set specific times for periodic full compaction. - Added
raftstore.periodic-full-compact-start-max-cputo limit CPU usage for periodic full compaction. - Added
zstd-dict-sizeto specify thezstddictionary compression size.
- Renamed
- releases/release-8.0.0.md
- Modified
log-backup.initial-scan-rate-limitto add a minimum value of1MiB. - Modified
raftstore.store-io-pool-sizeto change the default value from0to1. - Modified
rocksdb.defaultcf.titan.blob-cache-sizeto only take effect whenshared-blob-cacheisfalse. - Modified
rocksdb.titan.max-background-gcto change the default value from4to1. - Modified
security.encryption.master-key.vendorto addgcpas an available type. - Added
storage.block-cache.low-pri-pool-ratioto specify the proportion of block cache used by Titan. - Added
rocksdb.defaultcf.titan.shared-blob-cacheto control the shared cache for Titan blob files and RocksDB block files. - Added
security.encryption.master-key.gcp.credential-file-pathto specify the path to the Google Cloud authentication credentials file. - Added
schedule.enable-heartbeat-breakdown-metricsto control breakdown metrics for Region heartbeats.
- Modified
- releases/release-8.1.0.md
- Deprecated
enable-telemetryfor PD. - Modified
conflict.max-record-rowsfor TiDB Lightning to be automatically assigned the value ofconflict.threshold. - Modified
conflict.thresholdfor TiDB Lightning to change the default value from9223372036854775807to10000. - Added
memory.enable-thread-exclusive-arenafor TiKV to control memory allocation status at the thread level. - Added
security.client-allowed-user,security.client-user-required, andsecurity.mtlsfor TiCDC to control client authentication.
- Deprecated
- releases/release-8.1.2.md
- Added
server.snap-min-ingest-sizefor TiKV, specifying the minimum threshold for using the ingest method when processing snapshots.
- Added
- tikv-configuration-file.md
- Added documentation for
snap-min-ingest-size. - Added documentation for
low-pri-pool-ratio. - Updated documentation for
pd-report-min-resolved-ts-intervaland removed documentation forreport-min-resolved-ts-interval. - Updated documentation for
max-background-gc. - Added documentation for
incremental-scan-concurrency-limit. - Added documentation for
enable-thread-exclusive-arena.
- Added documentation for
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request aims to improve the configuration settings and annotations for various TiKV configurations. The changes seem well-organized and address the issues described in the pull request title and description. However, some minor adjustments can be made to improve clarity and consistency.
Summary of Findings
- Inconsistent terminology: The term 'configuration item' and 'configuration parameter' are used interchangeably. It's better to stick to one term for consistency. I suggest using 'configuration parameter' as it's more descriptive.
- Documentation link updates: Ensure that all documentation links are updated to reflect the correct version and file path, especially after renaming or moving configuration parameters.
- Missing version marks: Some newly added configuration parameters lack the version mark. Ensure that all new parameters are marked with the correct version in which they were introduced.
- Grammar and clarity: Some descriptions can be reworded for better clarity and grammar, particularly in specifying the default values and their implications.
Merge Readiness
The pull request is almost ready for merging. However, the identified issues regarding terminology consistency, documentation links, version marks, and grammar should be addressed to ensure the documentation is clear and accurate. Once these issues are resolved, the pull request will be in good shape to be merged. I am unable to approve this pull request, and it should be reviewed by others before merging.
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/retest |
This is an automated cherry-pick of #20871
First-time contributors' checklist
What is changed, added or deleted? (Required)
As the title mentioned, this PR is used to recorrect the settings for some configurations in TiKV.
Meanwhile, for some newly introduced configurations, it supplements annotations for them.
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?