tidb-monitoring-framework: add TiDB Dashboard (#20776) #20787
Conversation
ti-chi-bot
added
area/diagnosis
|
@Oreoxmt This PR has conflicts, I have hold it. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 introduces TiDB Dashboard to the TiDB monitoring framework documentation. The changes primarily involve updating the table of contents (TOC) to include a comprehensive listing of TiDB Dashboard documentation pages, as well as updating the overview documentation to reflect the addition of TiDB Dashboard as a monitoring tool. The PR also updates the deployment documentation to indicate that TiDB Dashboard is built into the PD component and doesn't require separate deployment.
Highlights
- TOC Update: The table of contents (TOC.md) has been updated to include a detailed listing of TiDB Dashboard documentation pages, covering various aspects such as overview, deployment, access, and specific features like Top SQL and Key Visualizer.
- Monitoring Framework Overview: The
tidb-monitoring-framework.mdfile has been updated to reflect that the TiDB monitoring framework now includes TiDB Dashboard in addition to Prometheus and Grafana. - Deployment Documentation: The
deploy-monitoring-services.mdfile has been updated to clarify that TiDB Dashboard is integrated into the PD component and does not require separate deployment.
Changelog
- TOC.md
- Added a comprehensive listing of TiDB Dashboard documentation pages, including overview, maintain, access, feature-specific pages, and FAQ.
- The changes add a nested structure for TiDB Dashboard topics, improving navigation.
- _index.md
- Updated the monitoring learning path to include TiDB Dashboard alongside Prometheus and Grafana.
- deploy-monitoring-services.md
- Clarified that TiDB Dashboard is built into the PD component and does not require independent deployment.
- tidb-monitoring-framework.md
- Updated the summary to include TiDB Dashboard as part of the monitoring framework.
- 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 gleam,
Insights from a data stream,
Clusters now in sight,
With metrics shining bright,
Problems now less of a scream.
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 introduces TiDB Dashboard to the TiDB monitoring framework documentation. The changes include updates to the table of contents, the main monitoring framework overview page, and the deploy monitoring services page. Overall, the changes look good and provide a comprehensive overview of TiDB Dashboard and how it fits into the monitoring ecosystem. However, there are a few minor issues that could be addressed to improve clarity and consistency.
Summary of Findings
- Inconsistent Link Versions: The _index.md file uses
v8.1for Prometheus and Grafana links butdevfor TiDB Dashboard. This inconsistency should be addressed to ensure users are directed to the correct documentation version. - Merge Conflict Markers: The TOC.md and _index.md files contain merge conflict markers (
<<<<<<< HEAD,=======,>>>>>>>). These markers should be removed to ensure the files are clean and readable.
Merge Readiness
The pull request is almost ready for merging. However, the merge conflict markers in TOC.md and _index.md must be removed. Additionally, the inconsistent link versions in _index.md should be addressed to ensure users are directed to the correct documentation. I am unable to approve this pull request, and recommend that another reviewer approves this code before merging.
TOC.md
Outdated
| - [`schema_unused_indexes`](/sys-schema/sys-schema-unused-indexes.md) | ||
| - [Metadata Lock](/metadata-lock.md) | ||
| - [TiDB Accelerated Table Creation](/accelerated-table-creation.md) | ||
| <<<<<<< HEAD |
There was a problem hiding this comment.
This line contains a merge conflict marker. Please resolve the conflict and remove this line.
TOC.md
Outdated
| ======= | ||
| - [Schema Cache](/schema-cache.md) | ||
| >>>>>>> c98fa53442 (tidb-monitoring-framework: add TiDB Dashboard (#20776)) |
There was a problem hiding this comment.
These lines contain merge conflict markers. Please resolve the conflict and remove these lines.
_index.md
Outdated
| <<<<<<< HEAD | ||
| [Use Prometheus and Grafana](https://docs.pingcap.com/tidb/v8.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.
These lines contain merge conflict markers. Please resolve the conflict and remove these lines.
_index.md
Outdated
| <<<<<<< HEAD | ||
| [Use Prometheus and Grafana](https://docs.pingcap.com/tidb/v8.1/tidb-monitoring-framework) | ||
| ======= | ||
| [Use Prometheus, Grafana, and TiDB Dashboard](https://docs.pingcap.com/tidb/dev/tidb-monitoring-framework) |
There was a problem hiding this comment.
Consider using v8.1 here for consistency with the other links in this section, unless there's a specific reason to link to the dev version.
| [Use Prometheus, Grafana, and TiDB Dashboard](https://docs.pingcap.com/tidb/dev/tidb-monitoring-framework) | |
| [Use Prometheus, Grafana, and TiDB Dashboard](https://docs.pingcap.com/tidb/v8.1/tidb-monitoring-framework) |
|
@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. |
Oreoxmt
force-pushed
the
cherry-pick-20776-to-release-8.1
branch
from
acf7841 to
4af5d62
Compare
|
/unhold |
|
/approve |
ti-chi-bot
bot
removed
the
do-not-merge/hold
|
[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 |
2 participants
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?