Skip to content

metrics: fix typo in tidb_summary.jsonnet template variable#65582

Merged
ti-chi-bot[bot] merged 2 commits intopingcap:masterfrom
boltandrke:fix-tidb-summary-typo
Jan 16, 2026
Merged

metrics: fix typo in tidb_summary.jsonnet template variable#65582
ti-chi-bot[bot] merged 2 commits intopingcap:masterfrom
boltandrke:fix-tidb-summary-typo

Conversation

@boltandrke
Copy link
Contributor

@boltandrke boltandrke commented Jan 15, 2026

What problem does this PR solve?

Issue Number: close #65589

Problem Summary: The tidb_cluster template variable query references a non-existent variable $kuberentes (typo) instead of $k8s_cluster.

What changed and how does it work?

Fixed the variable reference from $kuberentes to $k8s_cluster in:

  • pkg/metrics/grafana/tidb_summary.jsonnet (line 62)
  • pkg/metrics/grafana/tidb_summary.json (line 1789)

The $k8s_cluster variable is defined earlier in the dashboard templates.

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No need to test
    • I checked and no code files have been changed.

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

None

@ti-chi-bot ti-chi-bot bot added do-not-merge/needs-linked-issue do-not-merge/needs-triage-completed release-note-none Denotes a PR that doesn't merit a release note. contribution This PR is from a community contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 15, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 15, 2026

Hi @boltandrke. 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 the first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. label Jan 15, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 15, 2026

Welcome @boltandrke!

It looks like this is your first PR to pingcap/tidb 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/tidb. 😃

@pingcap-cla-assistant
Copy link

pingcap-cla-assistant bot commented Jan 15, 2026

CLA assistant check
All committers have signed the CLA.

@tiprow
Copy link

tiprow bot commented Jan 15, 2026

Hi @boltandrke. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

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.

Fix incorrect variable reference `$kuberentes` -> `$k8s_cluster` in the
tidb_cluster template query. The variable was misspelled and should
reference `$k8s_cluster` which is defined earlier in the dashboard templates.

Signed-off-by: andrke <andrke@users.noreply.github.com>
@boltandrke boltandrke force-pushed the fix-tidb-summary-typo branch from 4490b3a to f8a4f29 Compare January 15, 2026 09:01
@dveeden
Copy link
Contributor

dveeden commented Jan 15, 2026

From the description:

Issue Number: ref #58436

The link goes to a pull request, not an issue. Could you update this. Feel free to create a new issue if needed. This makes it easier to triage and cherry pick to the right branches.

Also, please sign the CLA on https://cla.pingcap.net/pingcap/tidb?pullRequest=65582

@dveeden
Copy link
Contributor

dveeden commented Jan 15, 2026

/ok-to-test

@ti-chi-bot ti-chi-bot bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Jan 15, 2026
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 15, 2026
@dveeden dveeden requested a review from zimulala January 15, 2026 12:53
@dveeden
Copy link
Contributor

dveeden commented Jan 15, 2026

Introduced in cc3c905 / #32546

$ git show cc3c9050134 | grep -B1 kuberentes
-            "query": "label_values(pd_cluster_status, tidb_cluster)",
+            "query": "label_values(pd_cluster_status{k8s_cluster=\"$kuberentes\"}, tidb_cluster)",
--
-    query='label_values(pd_cluster_status, tidb_cluster)',
+    query='label_values(pd_cluster_status{k8s_cluster="$kuberentes"}, tidb_cluster)',

@dveeden dveeden requested a review from just1900 January 15, 2026 12:59
Copy link
Contributor

@just1900 just1900 left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 15, 2026

@just1900: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

LGTM

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.

@codecov
Copy link

codecov bot commented Jan 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.5480%. Comparing base (53dc671) to head (d8a7b76).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files
@@               Coverage Diff                @@
##             master     #65582        +/-   ##
================================================
- Coverage   77.8520%   77.5480%   -0.3041%     
================================================
  Files          1973       1907        -66     
  Lines        541968     531378     -10590     
================================================
- Hits         421933     412073      -9860     
- Misses       118376     119297       +921     
+ Partials       1659          8      -1651     
Flag Coverage Δ
integration 41.6050% <ø> (-6.5849%) ⬇️
unit 76.7968% <ø> (+0.3196%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
dumpling 56.7974% <ø> (ø)
parser ∅ <ø> (∅)
br 48.8272% <ø> (-12.3178%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dveeden
Copy link
Contributor

dveeden commented Jan 15, 2026

/check-issue-triage-complete

@dveeden dveeden added needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. labels Jan 15, 2026
@dveeden dveeden added needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. labels Jan 15, 2026
@dveeden dveeden requested a review from XuHuaiyu January 15, 2026 13:44
Copy link
Contributor

@zimulala zimulala left a comment

Choose a reason for hiding this comment

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

Could you update the pd_cluster_status related content to align with the next-gen in
tidb_summary_with_keyspace_name.json and tidb_summary_with_keyspace_name.jsonnet?

@hawkingrei
Copy link
Member

/retest

1 similar comment
@dveeden
Copy link
Contributor

dveeden commented Jan 16, 2026

/retest

@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 16, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dveeden, just1900, zimulala

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:

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 approved lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jan 16, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 16, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-01-15 12:52:29.150839498 +0000 UTC m=+66376.764796344: ☑️ agreed by dveeden.
  • 2026-01-16 15:11:01.300615128 +0000 UTC m=+161088.914571974: ☑️ agreed by zimulala.

@dveeden
Copy link
Contributor

dveeden commented Jan 16, 2026

/retest

1 similar comment
@dveeden
Copy link
Contributor

dveeden commented Jan 16, 2026

/retest

@ti-chi-bot ti-chi-bot bot merged commit 78403e5 into pingcap:master Jan 16, 2026
31 checks passed
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.1: #65612.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.5: #65613.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.1: #65614.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #65615.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-6.1: #65616.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-6.5: #65617.

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

Labels

approved contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. needs-cherry-pick-release-7.1 Should cherry pick this PR to release-7.1 branch. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. ok-to-test Indicates a PR is ready to be tested. release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

metrics: TiDB Summary dashboard shows no data due to typo in tidb_cluster variable query

6 participants