cloud: initial doc user-controlled log redaction #21214
Conversation
ti-chi-bot
bot
added
contribution
|
Welcome @ginkgoch! |
ti-chi-bot
bot
added
the
needs-ok-to-test
|
Hi @ginkgoch. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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
bot
added
missing-translation-status
![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 @ginkgoch, 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 comprehensive documentation for the new user-controlled log redaction feature in TiDB Cloud. The aim is to provide users with clear instructions and important considerations for managing sensitive data visibility within their cluster logs, balancing operational needs with security.
Highlights
- New Documentation Page: I've added a brand new documentation page,
tidb-cloud/tidb-cloud-log-redaction.md, to introduce and explain the 'User-Controlled Log Redaction' feature for TiDB Cloud dedicated clusters. - Feature Explanation: The new document clarifies what user-controlled log redaction is, its purpose in managing sensitive data visibility in logs, and notes that it is enabled by default for security.
- Operational Procedures: I've included step-by-step instructions on how to disable and re-enable log redaction through the TiDB Cloud Console, along with prerequisites and important warnings about data exposure when the feature is disabled.
- Confirmation Steps: The documentation also provides guidance on how to confirm that log redaction has been successfully disabled, specifically by generating and reviewing slow query logs.
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 introduces a new documentation page for the 'User-controlled Log Redaction' feature in TiDB Cloud Dedicated clusters. The document clearly outlines the purpose of the feature, prerequisites, and provides step-by-step guides for disabling, confirming, and re-enabling log redaction. My review includes several suggestions aimed at enhancing clarity, conciseness, and adherence to the documentation style guide. These are primarily minor wording adjustments and formatting tweaks to ensure the document is as user-friendly as possible. Key style guide principles referenced include avoiding unnecessary repetition, ensuring ease of understanding, and using appropriate voice.
hfxsd
added
translation/no-need
|
[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 |
|
@cwen0: 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. |
| * Existing connections are unaffected. You need to reconnect them for the changes to take effect. | ||
| * Logs for new sessions will no longer be redacted. | ||
|
|
||
| ## Confirm that log redaction is disabled |
There was a problem hiding this comment.
Why is this section needed? Clicking "Disable" has already disabled the feature. Perhaps, the purpose of this section is just to guide users on how to quickly check the updated logs after disabling the feature? If so, please update the section title accordingly.
Co-authored-by: Grace Cai <[email protected]>
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
First-time contributors' checklist
What is changed, added or deleted? (Required)
For releasing a feature in tidb dedicated cloud - User-controlled log redaction, I need to push this doc into the website.
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?