Update TiDB X monitoring dashboards by Yujie-Xie · Pull Request #23188 · pingcap/docs

Yujie-Xie · 2026-07-01T10:47:00Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

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)?

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 · 2026-07-01T10:47:10Z

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.

gemini-code-assist

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.

gemini-code-assist · 2026-07-01T10:49:32Z

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


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

Use consistent terminology and correct capitalization of product names. ^(link)

gemini-code-assist · 2026-07-01T10:49:32Z

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


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

Use consistent terminology and correct capitalization of product names. ^(link)

gemini-code-assist · 2026-07-01T10:49:32Z

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


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

Use consistent terminology and correct capitalization of product names. ^(link)

gemini-code-assist · 2026-07-01T10:49:32Z

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


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

Use consistent terminology and correct capitalization of product names. ^(link)

gemini-code-assist · 2026-07-01T10:49:32Z

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


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

Use consistent terminology and correct capitalization of product names. ^(link)

gemini-code-assist · 2026-07-01T10:49:32Z

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


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

Use consistent terminology and correct capitalization of product names. ^(link)

gemini-code-assist · 2026-07-01T10:49:32Z

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


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

Use consistent terminology and correct capitalization of product names. ^(link)

gemini-code-assist · 2026-07-01T10:49:32Z

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


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\"})",

…al.json

Align Datadog and Grafana dashboard titles and descriptions with TiDB Cloud branding. Co-authored-by: Cursor <cursoragent@cursor.com>

ti-chi-bot · 2026-07-07T09:41:12Z

[LGTM Timeline notifier]

Timeline:

2026-07-07 09:41:11.92540013 +0000 UTC m=+101857.961495186: ☑️ agreed by qiancai.

qiancai · 2026-07-07T09:41:16Z

/approve

ti-chi-bot · 2026-07-07T09:41:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiancai]

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 · 2026-07-07T09:41:34Z

@qiancai: You cannot manually add or delete the cherry pick approval state labels, only I and the tursted members have permission to do so. You can approve it in internal platform.

Details

In response to removing label named approved.

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 ti-community-infra/tichi repository.

Update TiDB X monitoring dashboards

d054d73

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

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 Bot reviewed Jul 1, 2026

View reviewed changes

Yujie-Xie and others added 4 commits July 1, 2026 18:59

Reduce dashboard JSON diff noise

ab6f6f8

Update monitor-datadog-integration-tidb-cloud-dynamic-tracker-essenti…

4cd5805

…al.json

Update description for TiDB X Premium instances

bd20ca9

Rename TiDB X to TiDB Cloud in dynamic tracker dashboards.

2517c73

Align Datadog and Grafana dashboard titles and descriptions with TiDB Cloud branding. Co-authored-by: Cursor <cursoragent@cursor.com>

qiancai approved these changes Jul 7, 2026

View reviewed changes

ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 7, 2026

qiancai added the lgtm label Jul 7, 2026

ti-chi-bot Bot added the approved label Jul 7, 2026

qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. and removed approved labels Jul 7, 2026

ti-chi-bot Bot added the approved label Jul 7, 2026

ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 7, 2026

ti-chi-bot Bot merged commit 3e5078b into pingcap:master Jul 7, 2026
11 checks passed

	"content": "Database performance and storage metrics for TiDB X essential.",
	"content": "Database performance and storage metrics for TiDB X Essential.",

	"content": "Connection state at TiDB X essential cluster or instance scope.",
	"content": "Connection state at TiDB X Essential cluster or instance scope.",

	"content": "This panel shows RU usage for TiDB X essential clusters.",
	"content": "This panel shows RU usage for TiDB X Essential clusters.",

	"content": "Connection state at TiDB X premium cluster or instance scope.",
	"content": "Connection state at TiDB X Premium cluster or instance scope.",

	"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.",

	"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\"})",

Uh oh!

Conversation

Yujie-Xie commented Jul 1, 2026

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

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

Do your changes match any of the following descriptions?

Uh oh!

ti-chi-bot Bot commented Jul 1, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot Bot commented Jul 7, 2026

[LGTM Timeline notifier]

Uh oh!

qiancai commented Jul 7, 2026

Uh oh!

ti-chi-bot Bot commented Jul 7, 2026

Uh oh!

ti-chi-bot Bot commented Jul 7, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants