tidb cloud: add more Prometheus monitoring metrics #21075
Conversation
|
|
|
Welcome @huoyao1125! |
ti-chi-bot
bot
added
first-time-contributor
|
Hi @huoyao1125. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
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.
Hello @huoyao1125, 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
Hello team, Gemini here with a summary of this pull request. This PR focuses on updating the documentation for integrating Prometheus and Grafana with TiDB Cloud. The primary changes involve adding guidance on how to handle existing Grafana dashboards when new metrics become available and listing several new Prometheus metrics that users can now scrape and visualize.
Highlights
- Grafana Dashboard Guidance: Added a note in the Grafana integration steps recommending users create a new dashboard when incorporating newly available metrics, rather than directly updating an existing one. This helps avoid potential issues with existing configurations.
- New Prometheus Metrics Added: Included a list of several new Prometheus metrics that are now available for monitoring TiDB Cloud. These new metrics cover areas such as node storage availability, disk read/write latency, KV request duration, component uptime, TiCDC changefeed lag and status, and Resource Manager Request Unit consumption.
Changelog
Click here to see the changelog
- tidb-cloud/monitor-prometheus-and-grafana-integration.md
- Added a sentence to step 2 of the Grafana integration section advising on dashboard updates (line 58).
- Added a table row for the
tidbcloud_node_storage_available_bytesmetric (line 91). - Added a table row for the
tidbcloud_disk_read_latencymetric (line 92). - Added a table row for the
tidbcloud_disk_write_latencymetric (line 93). - Added a table row for the
tidbcloud_kv_request_durationmetric (line 94). - Added a table row for the
tidbcloud_component_uptimemetric (line 95). - Added a table row for the
tidbcloud_ticdc_owner_resolved_ts_lagmetric (line 96). - Added a table row for the
tidbcloud_changefeed_statusmetric (line 97). - Added a table row for the
tidbcloud_resource_manager_resource_unit_read_request_unitmetric (line 98). - Added a table row for the
tidbcloud_resource_manager_resource_unit_write_request_unitmetric (line 99).
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.
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 Prometheus and Grafana integration guide by adding a helpful recommendation for dashboard updates and expanding the list of available metrics. These are valuable additions that enhance the document's utility for users.
I've included a couple of minor suggestions focusing on conciseness and formatting consistency to further improve readability, in line with our documentation style guide. Specifically, these relate to simplifying phrasing [^1] and maintaining consistent formatting for placeholders, ellipsis, and HTML tags within the metrics table [^2][^3].
Additionally, please remember to complete the 'Which TiDB version(s) do your changes apply to?' section in the PR description, as this is crucial information for our users.
Overall, great work on improving this documentation!
Summary of Findings
- Documentation Clarity: A minor suggestion was made to improve the conciseness and simplicity of the new recommendation for Grafana dashboard updates.
- Table Formatting Consistency: Several minor inconsistencies were noted in the newly added metric table rows regarding placeholder style for
cluster_name, ellipsis usage, and HTML break tags. A combined suggestion was provided to align them with existing entries for better readability and consistency. - PR Metadata: The 'Which TiDB version(s) do your changes apply to?' section in the PR description needs to be completed to provide necessary context for users and maintainers.
Merge Readiness
The changes are a valuable update to the monitoring documentation, adding new metrics and a helpful recommendation for dashboard updates. The suggested minor consistency improvements in the table formatting and a small tweak for conciseness will further enhance readability.
Please also ensure the 'Which TiDB version(s) do your changes apply to?' section in the PR description is completed.
As per the contribution guidelines, I've added comments directly. This PR appears to be in good shape for merging once these minor points are considered. As a reviewer, I am not authorized to approve pull requests; this PR should be reviewed and approved by other maintainers before merging.
hfxsd
added
translation/no-need
|
/retest |
hfxsd
changed the title
|
/retest |
|
@jinshayumi: 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. |
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hfxsd 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 |
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?