feat/6747537673-add-doc-audit

[cadem]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @cadem, I'm Gemini Code Assist¹! 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 updates the security documentation to include crucial information regarding the compatibility of audit databases across different software versions. The primary goal is to inform users about potential breaking changes when upgrading from versions prior to 3.4.0.0, ensuring they understand the implications for their existing audit databases and the necessary steps to maintain functionality or migrate their data.

Highlights

• Audit Database Compatibility Documentation: Added a critical note to both English and Chinese security documentation explaining the incompatibility of audit databases created in versions prior to 3.4.0.0 with those in versions after 3.4.0.0. The documentation now clarifies that older audit databases cannot enable the is_audit parameter and lack mandatory requirements for DURATION, WAL_LEVEL, and ENCRYPT_ALGORITHM. It also provides instructions for migration, specifically requiring older audit databases to be dropped and recreated, or for auditUseToken to be set to 0 when using them in newer versions.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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

[gemini-code-assist]

Code Review

This pull request adds documentation regarding the compatibility of audit databases between versions. The added text in both English and Chinese documents could be confusing for users as it presents seemingly contradictory instructions. I've suggested clearer wording for both files to present the information as distinct options with clear outcomes, improving readability and user understanding.

[Copilot]

Pull request overview

This pull request adds documentation about audit database compatibility issues between versions before and after 3.4.0.0. The documentation explains the incompatibility, migration requirements, and provides a workaround using the auditUseToken parameter.

Changes:

• Added version compatibility notice for audit databases explaining incompatibility between pre-3.4.0.0 and post-3.4.0.0 versions
• Documented the migration requirement (drop and recreate) for pre-3.4.0.0 audit databases
• Provided workaround information using the auditUseToken parameter for users wanting to use legacy audit databases

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

File	Description
docs/zh/08-operation/16-security.md	Added Chinese documentation about audit database version compatibility and migration requirements
docs/en/08-operation/16-security.md	Added English documentation about audit database version compatibility and migration requirements

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The phrase "无法开启is_audit参数" (cannot enable the is_audit parameter) is misleading. In pre-3.4.0.0 versions, the is_audit parameter CAN be used to create audit databases, but it doesn't enforce the mandatory requirements. Consider rephrasing to "is_audit参数不强制要求" (the is_audit parameter does not enforce requirements) to be more accurate.

Suggested change

	在3.4.0.0之前的版本的审计库，与3.4.0.0之后的审计库不兼容，无法开启is_audit参数，也即没有对DURATION、WAL_LEVEL、ENCRYPT_ALGORITHM的强制要求。3.4.0.0之前的审计库只能drop后，重新创建审计库。如果要在3.4.0.0之后的版本中，使用3.4.0.0之前版本创建的审计库，需要将auditUseToken关闭，即设置为0。
	在3.4.0.0之前的版本的审计库，与3.4.0.0之后的审计库不兼容，is_audit参数不强制要求DURATION、WAL_LEVEL、ENCRYPT_ALGORITHM。3.4.0.0之前的审计库只能drop后，重新创建审计库。如果要在3.4.0.0之后的版本中，使用3.4.0.0之前版本创建的审计库，需要将auditUseToken关闭，即设置为0。