v8.5.3: update telemetry related doc files #21404
Conversation
Oreoxmt
added
translation/from-docs-cn
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/cc @Defined2014 |
ti-chi-bot
bot
added
the
size/M
![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 @Oreoxmt, 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 focuses on updating the documentation to reflect a significant change in the TiDB telemetry feature. The telemetry functionality, which was previously removed in versions 8.1.0 through 8.5.1, is being re-introduced in version 8.5.3. However, its operation is now strictly limited to local logging, ensuring no data is transmitted externally. The changes clarify the feature's behavior across different TiDB versions and update related system variable and configuration file descriptions.
Highlights
- Telemetry Feature Reintroduction and Behavior Change: The telemetry feature in TiDB is being re-introduced starting from v8.5.3. Crucially, its functionality is now limited to local logging of telemetry-related information, and it will no longer send data to PingCAP over the network. This marks a significant shift from its previous behavior and its removal in intermediate versions.
- Documentation Updates for Telemetry Status: Multiple documentation files, including release notes for v6.1.5, v6.5.1, v6.6.0, and v8.1.0, as well as the
system-variables.md,telemetry.md, andtidb-configuration-file.mdfiles, have been updated. These updates reflect the re-introduction and the new, local-only behavior of the telemetry feature, clarifying its status across different TiDB versions. - Default Value Change for
tidb_enable_telemetry: The default value for thetidb_enable_telemetrysystem variable has been changed fromOFFtoONstarting from v8.5.3. The documentation also clarifies that, from v8.5.3, this variable's effect is contingent on theenable-telemetryconfiguration item of the TiDB instance being set totrue. - Link Updates for Telemetry Parameters: References to
tidb_enable_telemetryandenable-telemetryacross various documentation files have been updated by removing the 'and deprecated in v8.1.0' suffix from their links, reflecting the revised status of these parameters.
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
The pull request updates the documentation for the telemetry feature to reflect its reintroduction in v8.5.3 with local-only logging. The changes are accurate and consistent across the updated files. I've provided a few suggestions to improve clarity and adhere to the documentation style guide, mainly concerning tense consistency for historical descriptions and markdown formatting for code elements.
|
|
||
| > **Warning:** | ||
| > | ||
| > 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. |
There was a problem hiding this comment.
To improve clarity and adhere to the style guide's preference for using past tense for historical behavior1, I suggest rephrasing this sentence. Also, the variable name should be enclosed in backticks for consistency2.
Style Guide References
| > - For versions earlier than v8.1.0, TiDB periodically reports telemetry data to PingCAP. | |
| > - For versions earlier than v8.1.0, TiDB periodically reported telemetry data to PingCAP. |
Footnotes
-
The style guide recommends using present tense unless describing historical behavior. Since these lines describe the behavior of past versions, using the past tense is more appropriate. (link) ↩
-
The style guide requires that code snippets, command names, options, and paths should be enclosed in backticks. (link) ↩
|
|
||
| > **Warning:** | ||
| > | ||
| > 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 clarity and adhere to the style guide's preference for using past tense for historical behavior1, I suggest rephrasing this sentence. Also, the variable name should be enclosed in backticks for consistency2.
Style Guide References
| > - 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 had no effect. It was retained solely for compatibility with earlier versions. |
Footnotes
-
The style guide recommends using present tense unless describing historical behavior. Since these lines describe the behavior of past versions, using the past tense is more appropriate. (link) ↩
-
The style guide requires that code snippets, command names, options, and paths should be enclosed in backticks. (link) ↩
| @@ -173,7 +173,7 @@ Compared with the previous LTS 7.5.0, 8.1.0 includes new features, improvements, | |||
|
|
|||
| | Variable name | Change type | Description | | |||
| |--------|------------------------------|------| | |||
| | [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-new-in-v402-and-deprecated-in-v810) | Deprecated | 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. | | |||
| | [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-new-in-v402) | Deprecated | 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. | | |||
There was a problem hiding this comment.
To improve clarity and adhere to the style guide's preference for using past tense for historical behavior1, I suggest rephrasing this sentence. Also, the variable name should be enclosed in backticks for consistency2.
Style Guide References
| | [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-new-in-v402) | Deprecated | 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. | | |
| | [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-new-in-v402) | Deprecated | Starting from v8.1.0, the telemetry feature in TiDB was removed, and this variable is no longer functional. It is retained solely for compatibility with earlier versions. | |
Footnotes
-
The style guide recommends using present tense unless describing historical behavior. Since these lines describe the behavior of past versions, using the past tense is more appropriate. (link) ↩
-
The style guide requires that code snippets, command names, options, and paths should be enclosed in backticks. (link) ↩
| @@ -182,7 +182,7 @@ | |||
|
|
|||
| | Configuration file | Configuration parameter | Change type | Description | | |||
| | -------- | -------- | -------- | -------- | | |||
| | TiDB| [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-new-in-v402-and-deprecated-in-v810) | Deprecated | 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. | | |||
| | TiDB| [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-new-in-v402) | Deprecated | 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. | | |||
There was a problem hiding this comment.
To improve clarity and adhere to the style guide's preference for using past tense for historical behavior1, I suggest rephrasing this sentence.
Style Guide References
| | TiDB| [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-new-in-v402) | Deprecated | 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. | | |
| | TiDB| [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-new-in-v402) | Deprecated | Starting from v8.1.0, the telemetry feature in TiDB was removed, and this configuration item is no longer functional. It is retained solely for compatibility with earlier versions. | |
Footnotes
| @@ -198,7 +198,7 @@ | |||
|
|
|||
| * Starting from v8.1.0, the telemetry feature in TiDB and TiDB Dashboard is removed: | |||
|
|
|||
| * The system variable [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-new-in-v402-and-deprecated-in-v810), the TiDB configuration item [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-new-in-v402-and-deprecated-in-v810), and the PD configuration item [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry) are deprecated and no longer functional. | |||
| * The system variable [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-new-in-v402), the TiDB configuration item [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-new-in-v402), and the PD configuration item [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry) are deprecated and no longer functional. | |||
There was a problem hiding this comment.
To improve clarity and adhere to the style guide's preference for using past tense for historical behavior1, I suggest rephrasing this sentence.
Style Guide References
| * The system variable [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-new-in-v402), the TiDB configuration item [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-new-in-v402), and the PD configuration item [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry) are deprecated and no longer functional. | |
| * The system variable [`tidb_enable_telemetry`](/system-variables.md#tidb_enable_telemetry-new-in-v402), the TiDB configuration item [`enable-telemetry`](/tidb-configuration-file.md#enable-telemetry-new-in-v402), and the PD configuration item [`enable-telemetry`](/pd-configuration-file.md#enable-telemetry) were deprecated and no longer functional. |
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 clarity and adhere to the style guide's preference for using past tense for historical behavior1, I suggest rephrasing this sentence.
Style Guide References
| > - 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 took effect. It was retained solely for compatibility with earlier versions. |
Footnotes
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?