Skip to content

Conversation

@wildpcww
Copy link
Collaborator

@wildpcww wildpcww commented Nov 12, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

Added Log redaction page for Premium

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

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

  • This PR is translated from:
  • Other reference 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

@ti-chi-bot ti-chi-bot bot added the contribution This PR is from a community contributor. label Nov 12, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @wildpcww, 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 introduces new documentation for TiDB Cloud Premium users, detailing the process of managing user-controlled log redaction. The primary purpose is to provide clear guidance on how to enable or disable this feature, allowing users to control the visibility of sensitive data in their instance logs. This is crucial for balancing data privacy with the need for detailed logging during diagnostic or maintenance tasks, ensuring users can secure their data while maintaining operational flexibility.

Highlights

  • New Documentation Page: A new documentation page, tidb-cloud-log-redaction-premium.md, has been added to the tidb-cloud/premium directory.
  • User-Controlled Log Redaction: The new page provides comprehensive instructions on how to manage user-controlled log redaction for TiDB Cloud Premium instances, covering both disabling and enabling the feature.
  • Security and Debugging: The documentation emphasizes the balance between data security (log redaction enabled by default) and operational needs (disabling for detailed logging during maintenance or SQL tuning).
  • Prerequisites and Verification: It outlines the necessary prerequisites (Organization Owner role) and steps to verify that log redaction changes have taken effect.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

@ti-chi-bot ti-chi-bot 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 Nov 12, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @wildpcww, 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 introduces a crucial new documentation page for TiDB Cloud Premium users, focusing on user-controlled log redaction. The purpose of this documentation is to empower users to balance data security with operational needs by providing clear steps on how to manage sensitive information visibility within their instance logs, thereby enhancing control over their data environment.

Highlights

  • New Documentation Page: A new documentation page, 'User-Controlled Log Redaction', has been added for TiDB Cloud Premium instances.
  • Log Redaction Management: The new page provides detailed instructions on how to enable and disable user-controlled log redaction, allowing users to manage the visibility of sensitive data in their TiDB Cloud logs.
  • Prerequisites and Warnings: The documentation outlines prerequisites for managing log redaction (Organization Owner role) and includes warnings about the risks associated with disabling the feature.
  • Version Applicability: The changes introduced in this pull request are specifically applicable to TiDB 8.5 versions.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a new documentation page for user-controlled log redaction for TiDB Cloud Premium instances. The content is well-structured and clear. I've provided a few minor suggestions to improve consistency, conciseness, and clarity, mainly related to spacing, UI element naming, and instructions.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a new documentation page for the User-Controlled Log Redaction feature for Premium instances. The document is well-written and easy to follow. I've provided a few suggestions to improve clarity, conciseness, and consistency, following the repository's style guide. The suggestions include fixing minor spacing issues, making instructions more specific, and ensuring consistent structure between sections.

@Oreoxmt Oreoxmt self-assigned this Nov 12, 2025
@Oreoxmt Oreoxmt self-requested a review November 12, 2025 08:07
@Oreoxmt Oreoxmt added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. labels Nov 12, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Nov 12, 2025
@Oreoxmt Oreoxmt changed the title Create tidb-cloud-log-redaction-premium.md cloud: add User-controlled log redaction Nov 12, 2025
@Oreoxmt Oreoxmt changed the title cloud: add User-controlled log redaction premium: add user-controlled log redaction Nov 12, 2025
@ti-chi-bot ti-chi-bot bot added needs-1-more-lgtm Indicates a PR needs 1 more LGTM. 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 Nov 12, 2025
@ti-chi-bot ti-chi-bot bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 12, 2025
github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Nov 12, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 12, 2025

@Oreoxmt: Your lgtm message is repeated, so it is ignored.

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 kubernetes-sigs/prow repository.

@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Nov 12, 2025

/cc @lilin90

@ti-chi-bot ti-chi-bot bot requested a review from lilin90 November 12, 2025 09:08
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Nov 12, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 12, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-11-12 08:31:41.120704153 +0000 UTC m=+863750.563734022: ☑️ agreed by Oreoxmt.
  • 2025-11-12 09:12:47.393863928 +0000 UTC m=+866216.836893807: ☑️ agreed by lilin90.

@wildpcww
Copy link
Collaborator Author

/cc @zhangpeijin-milo

@ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 12, 2025

@wildpcww: GitHub didn't allow me to request PR reviews from the following users: zhangpeijin-milo.

Note that only pingcap members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @zhangpeijin-milo

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 kubernetes-sigs/prow repository.

@ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 12, 2025

@zhangpeijin-milo: adding LGTM is restricted to approvers and reviewers in OWNERS files.

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 kubernetes-sigs/prow repository.

@lilin90
Copy link
Member

lilin90 commented Nov 13, 2025

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 13, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added the approved label Nov 13, 2025
@ti-chi-bot ti-chi-bot bot merged commit 63b8d87 into pingcap:release-8.5 Nov 13, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/tidb-cloud This PR relates to the area of TiDB Cloud. contribution This PR is from a community contributor. for-cloud-release This PR is related to TiDB Cloud release. lgtm size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants