v8.5.3: update telemetry related doc files (#21404) #21603
Conversation
ti-chi-bot
added
lgtm
needs-1-more-lgtm
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
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!
This pull request, an automated cherry-pick, updates various documentation files related to the telemetry feature across different TiDB versions. The core change reflects the reintroduction of the telemetry feature in TiDB starting from version 8.5.3, with a significant modification: it will now only log telemetry-related information locally and will no longer send data to PingCAP over the network.
Highlights
- Telemetry Feature Reintroduction: The telemetry feature, previously removed in TiDB versions 8.1.0 through 8.5.1, is now reintroduced starting from v8.5.3.
- Local-Only Telemetry Data: The re-enabled telemetry feature in v8.5.3 and later will only log data locally and will not transmit any information to PingCAP.
- Updated Default Value for tidb_enable_telemetry: The default value for the tidb_enable_telemetry system variable has been changed from OFF to ON for versions 8.5.3 and later, aligning with the reintroduction of the local-only telemetry.
- Documentation Link Simplification: References to telemetry-related system variables and configuration items across various release notes and documentation files have been updated by removing the "and deprecated in v8.1.0" suffix from their internal links.
- Clarified Telemetry Lifecycle: The documentation now provides a comprehensive overview of the telemetry feature's status across different TiDB versions, detailing its behavior before v8.1.0, its removal from v8.1.0 to v8.5.1, and its reintroduction with local-only logging from v8.5.3 onwards.
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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 updates documentation files related to the telemetry feature, reflecting its reintroduction in v8.5.3. The changes are mostly consistent and accurate. I've provided a few minor suggestions to improve grammar and adhere to the style guide by using past tense for historical descriptions and preferring active voice.
| > | ||
| > Starting from v8.1.0, the telemetry feature in TiDB is removed, and this variable is no longer functional. It is retained solely for compatibility with earlier versions. | ||
| > - For versions earlier than v8.1.0, TiDB periodically reports telemetry data to PingCAP. | ||
| > - For versions from v8.1.0 to v8.5.1, TiDB removes the telemetry feature and the `tidb_enable_telemetry` variable no longer takes effect. It is retained solely for compatibility with earlier versions. |
There was a problem hiding this comment.
To improve grammatical correctness, it's better to use the past tense for this historical event. Also, adding a comma improves readability. 1
| > - For versions from v8.1.0 to v8.5.1, TiDB removes the telemetry feature and the `tidb_enable_telemetry` variable no longer takes effect. It is retained solely for compatibility with earlier versions. | |
| > - For versions from v8.1.0 to v8.5.1, TiDB removed the telemetry feature, and the `tidb_enable_telemetry` variable no longer takes effect. It is retained solely for compatibility with earlier versions. |
Style Guide References
Footnotes
| > - Starting from TiUP v1.11.3, the telemetry feature in TiUP is disabled by default, which means TiUP usage information is not collected by default. If you upgrade from a TiUP version earlier than v1.11.3 to v1.11.3 or a later version, the telemetry feature keeps the same status as before the upgrade. | ||
| > - Starting from TiSpark v3.0.3, the telemetry feature in TiSpark is disabled by default, which means TiSpark usage information is not collected by default. | ||
| > - Starting from v8.1.0, the telemetry feature in TiDB and TiDB Dashboard is removed. | ||
| > - For versions from v8.1.0 to v8.5.1, the telemetry feature in TiDB and TiDB Dashboard is removed. |
There was a problem hiding this comment.
To adhere to the style guide's preference for active voice, this sentence can be rephrased. 1
| > - For versions from v8.1.0 to v8.5.1, the telemetry feature in TiDB and TiDB Dashboard is removed. | |
| > - For versions from v8.1.0 to v8.5.1, TiDB removed the telemetry feature from TiDB and TiDB Dashboard. |
Style Guide References
Footnotes
| > **Warning:** | ||
| > | ||
| > Starting from v8.1.0, the telemetry feature in TiDB is removed, and this configuration item is no longer functional. It is retained solely for compatibility with earlier versions. | ||
| > - For versions from v8.1.0 to v8.5.1, TiDB removes the telemetry feature and this configuration item no longer takes effect. It is retained solely for compatibility with earlier versions. |
There was a problem hiding this comment.
To improve grammatical correctness, it's better to use the past tense for this historical event. Also, adding a comma improves readability. 1
| > - For versions from v8.1.0 to v8.5.1, TiDB removes the telemetry feature and this configuration item no longer takes effect. It is retained solely for compatibility with earlier versions. | |
| > - For versions from v8.1.0 to v8.5.1, TiDB removed the telemetry feature, and this configuration item no longer takes effect. It is retained solely for compatibility with earlier versions. |
Style Guide References
Footnotes
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt 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 |
…auto-embed * commit 'b570cc86270ba2e2b2b71d6eab8d717c2c8a1c56': (48 commits) *: remove TiDB roadmap from TOC, home, index, add warning (#21628) (#21637) Update the scope of system-variable ”tidb_redact_log“ (#21513) (#21634) *: add custom Japanese localization for cloud docs (#21612) Modify the introduction of `cop_pool_size` (#21462) (#21627) tiflash: Update tiflash upgrade guide (#21619) (#21625) Update tidb-performance-tuning-config.md (#21621) (#21624) Update tidb-cloud-poc.md (#21336) (#21411) cloud: update the pricing link for starter (#21620) ticdc: clarify descriptions of `index-value` and `columns` (#21616) (#21617) release-8.5: remove 'v' prefix from tidb-version variable (#21614) release-8.5: update version to 8.5.3 (#21613) cloud: fix note annotation syntax for proper rendering (#21611) ticdc: add key word for redo log (#21564) (#21607) ticdc: correct the tiup cluster command (#21135) (#21608) bump TiDB from v8.5.2 to v8.5.3 (#21578) v8.5.3: add release notes (#21399) (#21606) v8.5.3: log backup: update metafile format (#21412) (#21577) v8.5.3: update telemetry related doc files (#21404) (#21603) system-variables: add optimizer cost factors (#20748) (#21602) Add more description about SHARD_ROW_ID_BITS (#21467) (#21600) ...
2 participants
This is an automated cherry-pick of #21404
What is changed, added or deleted? (Required)
Modified telemetry related doc files. Ref link pingcap/tidb#61753
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?