cloud: audit log CLI #21786
cloud: audit log CLI #21786
Conversation
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 @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 expands and refactors the command-line interface documentation for managing audit logs within TiDB Cloud Essential clusters. It introduces a suite of new commands for granular control over audit log configuration, including cloud storage integration and rotation policies, as well as comprehensive management of audit log filter rules. The changes aim to provide users with a more robust and intuitive CLI experience for audit log operations.
Highlights
- New Audit Log CLI Commands: Introduced a comprehensive set of new CLI commands for managing audit logs, including
config update,config describe,filter-rule create,filter-rule delete,filter-rule describe,filter-rule list,filter-rule template, anddownload. - Refactored Audit Log Documentation: Existing documentation for
ticloud serverless audit-log configandticloud serverless audit-log downloadhas been replaced with more detailed and structured versions, enhancing clarity and completeness. - Standardized Command Naming: All audit log CLI commands now adhere to a consistent
ticloud serverless audit-log <sub-command> <action>structure, improving discoverability and ease of use. - Enhanced Audit Log Configuration: New options for configuring audit logs are available, including integration with various cloud storage providers (S3, GCS, Azure Blob, OSS) and advanced rotation strategies.
- Improved Filter Rule Management: Dedicated commands have been added for granular management of audit log filter rules, allowing users to create, delete, describe, list, update, and view templates for these 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 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
-
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 updates the documentation for the ticloud CLI, specifically for the audit-log subcommands, to reflect a restructuring of the commands. The changes involve renaming files, creating new ones, and modifying content to match the new command structure. Overall, the updates are good, but I've found several inconsistencies in wording, formatting issues such as using quotes instead of backticks for commands, and some unclear descriptions. I have provided specific suggestions to improve clarity and ensure adherence to the style guide.
hfxsd
added
translation/no-need
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
[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 |
|
|
||
| # ticloud serverless audit-log config update | ||
|
|
||
| Update the database audit logging configuration for a TiDB Cloud Essential cluster. |
There was a problem hiding this comment.
| Update the database audit logging configuration for a TiDB Cloud Essential cluster. | |
| Update the database audit logging configuration for a {{{ .essential }}} cluster. |
| | --rotation-interval-minutes int32 | The rotation interval in minutes, range [10, 1440]. | No | Only works in non-interactive mode. | | ||
| | --rotation-size-mib int32 | The rotation size in MiB, range [1, 1024]. | No | Only works in non-interactive mode. | |
There was a problem hiding this comment.
| | --rotation-interval-minutes int32 | The rotation interval in minutes, range [10, 1440]. | No | Only works in non-interactive mode. | | |
| | --rotation-size-mib int32 | The rotation size in MiB, range [1, 1024]. | No | Only works in non-interactive mode. | | |
| | --rotation-interval-minutes int32 | The rotation interval in minutes. Valid range: [10, 1440]. | No | Only works in non-interactive mode. | | |
| | --rotation-size-mib int32 | The rotation size in MiB. Valid range: [1, 1024]. | No | Only works in non-interactive mode. | |
|
|
||
| # ticloud serverless audit-log download | ||
|
|
||
| Download the database audit log files from a TiDB Cloud Essential cluster. |
There was a problem hiding this comment.
| Download the database audit log files from a TiDB Cloud Essential cluster. | |
| Download the database audit log files from a {{{ .essential }}} cluster. |
| | --start-date string | The start date of the audit log you want to download in the format of `YYYY-MM-DD`, for example, `2025-01-01`. | Yes | Only works in non-interactive mode. | | ||
| | --end-date string | The end date of the audit log you want to download in the format of `YYYY-MM-DD`, for example, `2025-01-01`. | Yes | Only works in non-interactive mode. | | ||
| | --output-path string | The path to download the audit logs. If not specified, logs are downloaded to the current directory. | No | Only works in non-interactive mode. | | ||
| | --concurrency int | Download concurrency. (default 3) | No | Works in both interactive and non-interactive modes. | |
There was a problem hiding this comment.
| | --concurrency int | Download concurrency. (default 3) | No | Works in both interactive and non-interactive modes. | | |
| | --concurrency int | Download concurrency. By default, the value is `3`. | No | Works in both interactive and non-interactive modes. | |
| # ticloud serverless audit-log filter-rule create | ||
|
|
||
| Create an audit log filter rule for a {{{ .starter }}} or {{{ .essential }}} cluster. | ||
| Create an audit log filter rule for a TiDB Cloud Essential cluster. |
There was a problem hiding this comment.
| Create an audit log filter rule for a TiDB Cloud Essential cluster. | |
| Create an audit log filter rule for a {{{ .essential }}} cluster. |
| # ticloud serverless audit-log filter-rule template | ||
|
|
||
| Show audit log filter rule templates for a {{{ .starter }}} or {{{ .essential }}} cluster. | ||
| Show audit log filter rule templates for a TiDB Cloud Essential cluster. |
There was a problem hiding this comment.
| Show audit log filter rule templates for a TiDB Cloud Essential cluster. | |
| Show audit log filter rule templates for a {{{ .essential }}} cluster. |
| | -D, --debug | Enable debug mode. | No | Works in both interactive and non-interactive modes. | | ||
| | --no-color | Disable color output. | No | Only works in non-interactive mode. | |
There was a problem hiding this comment.
| | -D, --debug | Enable debug mode. | No | Works in both interactive and non-interactive modes. | | |
| | --no-color | Disable color output. | No | Only works in non-interactive mode. | | |
| | -D, --debug | Enables debug mode. | No | Works in both interactive and non-interactive modes. | | |
| | --no-color | Disables color output. | No | Only works in non-interactive mode. | |
| # ticloud serverless audit-log filter-rule update | ||
|
|
||
| Update an audit log filter rule for a {{{ .starter }}} or {{{ .essential }}} cluster. | ||
| Update an audit log filter rule for a TiDB Cloud Essential cluster. |
There was a problem hiding this comment.
| Update an audit log filter rule for a TiDB Cloud Essential cluster. | |
| Update an audit log filter rule for a {{{ .essential }}} cluster. |
| | --rule string | The new, complete filter rule expression. Use `ticloud serverless audit-log filter template` to see filter templates. | No | Only works in non-interactive mode. | | ||
| | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | ||
| | --display-name string | The display name of the filter rule. | No | Only works in non-interactive mode. | | ||
| | --enabled | Enable or disable the filter rule. | No | Only works in non-interactive mode. | |
There was a problem hiding this comment.
| | --enabled | Enable or disable the filter rule. | No | Only works in non-interactive mode. | | |
| | --enabled | Enables or disables the filter rule. | No | Only works in non-interactive mode. | |
| | -D, --debug | Enable debug mode. | No | Works in both interactive and non-interactive modes. | | ||
| | --no-color | Disable color output. | No | Only works in non-interactive mode. | |
There was a problem hiding this comment.
| | -D, --debug | Enable debug mode. | No | Works in both interactive and non-interactive modes. | | |
| | --no-color | Disable color output. | No | Only works in non-interactive mode. | | |
| | -D, --debug | Enables debug mode. | No | Works in both interactive and non-interactive modes. | | |
| | --no-color | Disables color output. | No | Only works in non-interactive mode. | |
First-time contributors' checklist
What is changed, added or deleted? (Required)
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?