Skip to content

Update TiDB X monitoring dashboards#23188

Open
Yujie-Xie wants to merge 2 commits into
pingcap:masterfrom
Yujie-Xie:yujie/add-datadog-dashboard-for-x
Open

Update TiDB X monitoring dashboards#23188
Yujie-Xie wants to merge 2 commits into
pingcap:masterfrom
Yujie-Xie:yujie/add-datadog-dashboard-for-x

Conversation

@Yujie-Xie

Copy link
Copy Markdown
Contributor

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot

ti-chi-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign oreoxmt for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the contribution This PR is from a community contributor. label Jul 1, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown

Hi @Yujie-Xie. 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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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 ti-chi-bot Bot added needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 1, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 Datadog integration dashboards for TiDB X Essential and Premium clusters, alongside updates to the Grafana integration dashboard for TiDB X Essential. The review feedback highlights several minor issues, specifically recommending the correct capitalization of product names ('Essential' and 'Premium') in the Datadog configurations for consistency, and suggesting the removal of an unnecessary space in a PromQL sum expression within the Grafana dashboard.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

"id": 0,
"definition": {
"type": "note",
"content": "Database performance and storage metrics for TiDB X essential.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with the product name and other occurrences in the dashboard, 'essential' should be capitalized as 'Essential'.

Suggested change
"content": "Database performance and storage metrics for TiDB X essential.",
"content": "Database performance and storage metrics for TiDB X Essential.",
References
  1. Use consistent terminology and correct capitalization of product names. (link)

"id": 0,
"definition": {
"type": "note",
"content": "Connection state at TiDB X essential cluster or instance scope.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with the product name and other occurrences in the dashboard, 'essential' should be capitalized as 'Essential'.

Suggested change
"content": "Connection state at TiDB X essential cluster or instance scope.",
"content": "Connection state at TiDB X Essential cluster or instance scope.",
References
  1. Use consistent terminology and correct capitalization of product names. (link)

"id": 0,
"definition": {
"type": "note",
"content": "This panel shows RU usage for TiDB X essential clusters.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with the product name and other occurrences in the dashboard, 'essential' should be capitalized as 'Essential'.

Suggested change
"content": "This panel shows RU usage for TiDB X essential clusters.",
"content": "This panel shows RU usage for TiDB X Essential clusters.",
References
  1. Use consistent terminology and correct capitalization of product names. (link)

"id": 0,
"definition": {
"type": "note",
"content": "Database performance and storage metrics for TiDB X premium.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with the product name and other occurrences in the dashboard, 'premium' should be capitalized as 'Premium'.

Suggested change
"content": "Database performance and storage metrics for TiDB X premium.",
"content": "Database performance and storage metrics for TiDB X Premium.",
References
  1. Use consistent terminology and correct capitalization of product names. (link)

"id": 0,
"definition": {
"type": "note",
"content": "Connection state at TiDB X premium cluster or instance scope.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with the product name and other occurrences in the dashboard, 'premium' should be capitalized as 'Premium'.

Suggested change
"content": "Connection state at TiDB X premium cluster or instance scope.",
"content": "Connection state at TiDB X Premium cluster or instance scope.",
References
  1. Use consistent terminology and correct capitalization of product names. (link)

"id": 0,
"definition": {
"type": "note",
"content": "This panel shows RU usage for TiDB X premium clusters.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with the product name and other occurrences in the dashboard, 'premium' should be capitalized as 'Premium'.

Suggested change
"content": "This panel shows RU usage for TiDB X premium clusters.",
"content": "This panel shows RU usage for TiDB X Premium clusters.",
References
  1. Use consistent terminology and correct capitalization of product names. (link)

"id": 0,
"definition": {
"type": "note",
"content": "CDC metrics supported for TiDB X premium. Panels stay empty when CDC is not enabled.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with the product name and other occurrences in the dashboard, 'premium' should be capitalized as 'Premium'.

Suggested change
"content": "CDC metrics supported for TiDB X premium. Panels stay empty when CDC is not enabled.",
"content": "CDC metrics supported for TiDB X Premium. Panels stay empty when CDC is not enabled.",
References
  1. Use consistent terminology and correct capitalization of product names. (link)

"uid": "${DS_PROMETHEUS}"
},
"editorMode": "code",
"expr": "sum (tidbcloud_resource_manager_resource_request_unit_total{instance_name=~\"$Instance_name\", instance_id=~\"$Instance_id\"})",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with all other PromQL expressions in this dashboard, remove the space between the function name sum and the opening parenthesis (.

Suggested change
"expr": "sum (tidbcloud_resource_manager_resource_request_unit_total{instance_name=~\"$Instance_name\", instance_id=~\"$Instance_id\"})",
"expr": "sum(tidbcloud_resource_manager_resource_request_unit_total{instance_name=~\"$Instance_name\", instance_id=~\"$Instance_id\"})",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant