-
Notifications
You must be signed in to change notification settings - Fork 703
refactor db audit log #21778
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor db audit log #21778
Conversation
[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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @shiyuhang0, 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 significantly refactors the documentation for database audit logging in TiDB Cloud. The primary goal is to streamline the content by focusing solely on "essential" clusters and to provide a more comprehensive guide for managing audit logs. This includes expanding on external storage options and offering dual instructions for both console and CLI operations, making the documentation more user-friendly and complete.
Highlights
- Scope Narrowing: The documentation has been updated to exclusively cover database audit logging for "essential" clusters, removing all references to "starter" clusters.
- Enhanced Storage Options: Detailed instructions and configuration requirements have been added for storing audit logs in various external cloud storage services, including Amazon S3, Google Cloud Storage, Azure Blob Storage, and Alibaba Cloud OSS.
- Improved Management Instructions: The document now provides clear, tabbed instructions for managing audit logging (enabling, configuring, disabling) and filter rules (creating, editing, disabling, deleting) using both the TiDB Cloud Console and the TiDB Cloud CLI.
- Documentation Restructuring: The content has been reorganized to better separate audit logging configurations (data redaction, log file rotation) from the operational steps of enabling/disabling and managing filter rules.
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.
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 is a significant refactoring of the database audit logging documentation for TiDB Cloud Serverless clusters. The changes introduce a much clearer structure, separating instructions for the Console and CLI using tabs, and add comprehensive information about configuration, storage locations, and management of audit logs. My review focuses on improving the structural consistency, technical accuracy of commands, and clarity of the instructions, in line with the documentation style guide. I've provided several suggestions to fix issues with the new tabbed sections, correct a command example, and refine the language for better readability. A key point to address is the 'Audit logging limitations' section at the end of the document, which appears to contain outdated information that contradicts the new content. I recommend updating this section to ensure technical accuracy.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request refactors the database audit logging documentation to focus exclusively on Essential clusters, removing references to Starter clusters throughout the document. The changes include updated configuration options, new storage locations, and expanded console-based management capabilities.
Key changes:
- Remove all references to Starter clusters from titles, content, and descriptions
- Add comprehensive storage location options (S3, GCS, Azure Blob, Alibaba Cloud OSS)
- Introduce console-based management UI alongside existing CLI commands
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
d8f8c5a
to
0d72160
Compare
0d72160
to
9a0f928
Compare
This pr split into
#21788
#21786