-
Notifications
You must be signed in to change notification settings - Fork 705
tidb-monitoring-framework: add TiDB Dashboard (#20776) #20785
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
tidb-monitoring-framework: add TiDB Dashboard (#20776) #20785
Conversation
@Oreoxmt This PR has conflicts, I have hold it. |
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.
Hello @ti-chi-bot, 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!
Summary of Changes
This pull request adds TiDB Dashboard to the TiDB monitoring framework documentation. It updates the table of contents, the index page, the deploy monitoring services page, and the tidb-monitoring-framework overview page to include information and links to the TiDB Dashboard. The changes also include adding aliases to the tidb-monitoring-framework page.
Highlights
- TOC.md: Adds a section for TiDB Dashboard with links to overview, maintain, access, and other related pages.
- _index.md: Updates the monitoring learning path to include TiDB Dashboard.
- deploy-monitoring-services.md: Clarifies that TiDB Dashboard is built into the PD component and does not require separate deployment.
- tidb-monitoring-framework.md: Adds a section introducing TiDB Dashboard and its role in monitoring and diagnosing TiDB clusters.
Changelog
- TOC.md
- Added TiDB Dashboard section with links to subpages.
- Added UI section with TiDB Dashboard subsection
- _index.md
- Updated the monitoring learning path to include TiDB Dashboard.
- deploy-monitoring-services.md
- Added a note that TiDB Dashboard is built into the PD component and does not require separate deployment.
- tidb-monitoring-framework.md
- Added aliases for the page.
- Added a section introducing TiDB Dashboard and linking to its introduction page.
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.
A dashboard's clear view,
Insights into all we do,
Metrics align,
Decisions shine,
Success is coming through.
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 introduces TiDB Dashboard to the monitoring framework documentation. The changes primarily involve updating the table of contents and adding information about TiDB Dashboard to existing monitoring documentation. Overall, the changes seem well-organized and informative.
Merge Readiness
The pull request appears to be well-structured and introduces necessary updates to the documentation. I am unable to approve the pull request in any circumstance, and users should have others review and approve this code before merging. Given the absence of critical or high severity issues, the pull request seems ready for merging, pending a final review by other approvers.
TOC.md
Outdated
<<<<<<< HEAD | ||
- UI | ||
- TiDB Dashboard | ||
- [Overview](/dashboard/dashboard-intro.md) |
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.
_index.md
Outdated
<<<<<<< HEAD | ||
[Use Prometheus and Grafana](https://docs.pingcap.com/tidb/v7.1/tidb-monitoring-framework) | ||
======= | ||
[Use Prometheus, Grafana, and TiDB Dashboard](https://docs.pingcap.com/tidb/dev/tidb-monitoring-framework) | ||
>>>>>>> c98fa53442 (tidb-monitoring-framework: add TiDB Dashboard (#20776)) |
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.
@gemini-code-assist[bot]: 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. |
2150342
to
b95d697
Compare
/unhold |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #20776
First-time contributors' checklist
What is changed, added or deleted? (Required)
close pingcap/docs-cn#20206
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 (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?