Skip to content

*: fix Grafana dashboard and panel names - #23953

Open
sary8 wants to merge 3 commits into
pingcap:masterfrom
sary8:fix/grafana-panel-name-casing
Open

sary8 wants to merge 3 commits into
pingcap:masterfrom
sary8:fix/grafana-panel-name-casing

Conversation

@sary8

@sary8 sary8 commented Sep 26, 2026 •

Copy link
Copy Markdown

What is changed, added, or deleted? (Required)

Change these names to match the dashboard and panel titles:

This PR also fixes the same names in configure-store-limit.md, dashboard/dashboard-monitoring.md, grafana-tikv-dashboard.md, storage-engine/titan-configuration.md, and tidb-troubleshooting-map.md, which #23818 does not list.

Fixes #23818.

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)

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • Documentation
    • Updated Grafana dashboard and panel names across monitoring, configuration, and troubleshooting guides, including consistent use of “TiKV-Details.”
    • Changed the metric label “Execution Duration” to “Execute Duration” in performance guidance.
    • Corrected the capitalization of “Raft Propose” in alert guidance and the panel name “Thread CPU” in Raftstore monitoring instructions.

Use the titles in tikv_details.json from tikv/tikv and
performance_overview.json from pingcap/tidb.
@ti-chi-bot ti-chi-bot Bot added 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. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Sep 26, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 26, 2026

Copy link
Copy Markdown

Hi @sary8. 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 commented Sep 26, 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 overvenus 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 missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 26, 2026
@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: pingcap/docs/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 77be1d62-b2ef-4090-86a8-087ff03c72f3

📥 Commits

Reviewing files that changed from the base of the PR and between 43f6ad3 and 600ff2d.

📒 Files selected for processing (2)
  • grafana-tikv-dashboard.md
  • tidb-troubleshooting-map.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Documentation references to Grafana panel and dashboard titles now match their displayed names. Existing descriptions, thresholds, configuration values, and troubleshooting guidance remain unchanged.

Changes

Grafana title corrections

Layer / File(s) Summary
Panel title references
alert-rules.md, best-practices/massive-regions-best-practices.md, dashboard/dashboard-monitoring.md, grafana-performance-overview-dashboard.md, grafana-tikv-dashboard.md
References now use the displayed panel names Raft Propose, Thread CPU, and Execute Duration.
TiKV-Details references
configure-store-limit.md, grafana-tikv-dashboard.md, storage-engine/titan-configuration.md, tidb-troubleshooting-map.md, tikv-configuration-file.md, troubleshoot-cpu-issues.md
References now use TiKV-Details for the dashboard name.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 600ff

The documentation updates align the referenced names with their displayed titles. No actionable current-head issue remains; the change is ready to merge.

Architecture Summary

Architecture risk: 🔵 Low · up to 600ff

The change affects 10 systems.

Changed systems: alert-rules.md, best-practices, configure-store-limit.md, dashboard, grafana-performance-overview-dashboard.md, grafana-tikv-dashboard.md, storage-engine, tidb-troubleshooting-map.md, tikv-configuration-file.md, troubleshoot-cpu-issues.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — alert-rules.md (service) was modified; 1 changed file maps to changed impact.
  • observed — best-practices (service) was modified; 1 changed file maps to changed impact.
  • observed — configure-store-limit.md (service) was modified; 1 changed file maps to changed impact.
  • observed — dashboard (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in alert-rules.md: The TiKV async write-duration solution changes the dashboard label from “Raft propose” to “Raft Propose”; the link and remaining guidance are unchanged.
  • observed — Modified behavior in best-practices/massive-regions-best-practices.md: The monitoring instruction now refers to the Thread CPU panel instead of Thread-CPU.
  • observed — Modified behavior in configure-store-limit.md: The dashboard path label changes from TiKV Details to TiKV-Details; the Snapshot, Snapshot Speed, and TiKV snapshot-limit guidance remain unchanged.
  • observed — Modified behavior in dashboard/dashboard-monitoring.md: Renamed the metric label Execution Duration to Execute Duration; the description remains the same.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The PR changes 100MB to 100 MB in two instances in tidb-troubleshooting-map.md. This spacing change does not correct a Grafana dashboard or panel title and has no demonstrated connection to issu… Remove the unrelated 100MB to 100 MB changes, or provide a directly linked coding requirement that includes this formatting correction.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: correcting Grafana dashboard and panel names. The leading '*:' is unusual but does not prevent understanding.
Description check ✅ Passed The description covers the required change summary, affected TiDB versions, related references, AI involvement, and applicable change categories. The optional first-time contributor checklist is omitt…
Linked Issues check ✅ Passed Issue #23818 requires five documentation corrections. The PR applies the required names: TiKV-Details, Thread CPU, Raft Propose, and Execute Duration in the five specified documents. It also u…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Out of Scope Changes check

Explanation

The PR changes 100MB to 100 MB in two instances in tidb-troubleshooting-map.md. This spacing change does not correct a Grafana dashboard or panel title and has no demonstrated connection to issue #23818.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: pingcap/docs/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d23d190a-3f8a-46e2-9d81-77e311e63b00

📥 Commits

Reviewing files that changed from the base of the PR and between 0274a33 and 17e4c19.

📒 Files selected for processing (10)
  • alert-rules.md
  • best-practices/massive-regions-best-practices.md
  • configure-store-limit.md
  • dashboard/dashboard-monitoring.md
  • grafana-performance-overview-dashboard.md
  • grafana-tikv-dashboard.md
  • storage-engine/titan-configuration.md
  • tidb-troubleshooting-map.md
  • tikv-configuration-file.md
  • troubleshoot-cpu-issues.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread tidb-troubleshooting-map.md Outdated
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. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time 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/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Several docs pages misname Grafana panel/dashboard titles (casing/spelling mismatches)

1 participant