tiproxy: add tiproxy usage in the tidb cloud doc #21483
Conversation
|
Skipping CI for Draft Pull Request. |
ti-chi-bot
bot
added
do-not-merge/work-in-progress
![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 @djshow832, 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 the TiDB Cloud documentation by introducing dedicated content for TiProxy. The changes aim to provide users with a clear understanding of TiProxy's functionality, how to manage it within their clusters, and how to monitor its performance and associated costs. This ensures that users can effectively leverage TiProxy for improved connection management and load balancing in their TiDB Cloud deployments.
Highlights
- New TiProxy Documentation: Added two new comprehensive documentation pages:
tiproxy-overview.mdproviding an introduction to TiProxy, its use cases, limitations, and billing, andtiproxy-management.mddetailing how to enable, disable, view, and modify TiProxy instances within TiDB Cloud. - Table of Contents Integration: Updated the
TOC-tidb-cloud.mdfile to include the newly added TiProxy documentation under a new 'Manage Connections by TiProxy' section, making it easily discoverable within the TiDB Cloud documentation. - Monitoring and Dashboard Updates: Enhanced existing monitoring documentation (
built-in-monitoring.md) by adding specific TiProxy metrics (CPU Usage, Connections, Throughput, Session Migration Reasons) and updated the TiDB Cloud Clinic dashboards (tidb-cloud-clinic.md) to include a 'TiProxy-Summary' dashboard.
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 or fill out our survey 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
The code changes introduce documentation for TiProxy in TiDB Cloud. The new pages are well-structured and helpful for users. The review focuses on enhancing clarity, ensuring consistency with the style guide, and correcting minor issues, including copy-paste errors, tense, and terminology.
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 |
tidb-cloud/tiproxy-management.md
Outdated
|
|
||
| - The TiDB instance number in the TiDB node group must be at least two | ||
| - The TiDB instance size must be at least 4 vCPU | ||
| - The TiProxy instance number quota of an organization is 10 |
There was a problem hiding this comment.
| - The TiProxy instance number quota of an organization is 10 | |
| - The default TiProxy instance quota of a tenant is 10 |
There was a problem hiding this comment.
The other docs use the word organization, not tenant.
|
|
||
| 1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. | ||
| 2. In the left navigation pane, click **Billing**. On the **Billing** page, the **Bills** tab is displayed by default. | ||
| 3. In the **Summary by Service** section, TiProxy node cost is displayed under **TiDB Dedicated**, while TiProxy data transfer cost is included in **Data Transfer > Same Region**. |
There was a problem hiding this comment.
Do we need add description for tiproxy is charge free for the Private Preview stage @joey-yez
There was a problem hiding this comment.
The doc is public from the public preview. It won't be committed during private preview.
Renamed 'tiproxy-overview.md' to 'tiproxy-overview-for-cloud.md' and updated the corresponding link in the TOC to reflect the new filename.
ti-chi-bot
bot
removed
the
do-not-merge/work-in-progress
Replaced internal documentation links with external URLs in TiProxy management and overview docs for better accessibility. Fixed a step numbering issue and clarified a support contact instruction.
What is changed, added or deleted? (Required)
TiProxy will be under public preview on the Dedicated Tier soon. This PR adds an introduction and usage of TiProxy.
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?