Skip to content

troubleshoot-stale-read: fix the Grafana panel name for resolved-ts - #23920

Open
sary8 wants to merge 1 commit into
pingcap:masterfrom
sary8:fix/stale-read-resolved-ts-panel-name
Open

sary8 wants to merge 1 commit into
pingcap:masterfrom
sary8:fix/stale-read-resolved-ts-panel-name

Conversation

@sary8

@sary8 sary8 commented Sep 21, 2026

Copy link
Copy Markdown

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

troubleshoot-stale-read.md refers to the panel as Max Resolved TS gap, but the current panel name is Max gap of resolved-ts (tikv_details.dashboard.py#L9052). grafana-tikv-dashboard.md already uses the current name.

Update the panel name and the image alt text. The screenshot itself still shows the old name.

Fixes #23817.

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

  • 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 Stale Read troubleshooting guidance to use the revised “Max gap of resolved-ts” metric name in dashboard instructions and image alt text.

The panel in TiKV-Details is named "Max gap of resolved-ts". The same
name is used in grafana-tikv-dashboard.md.
@ti-chi-bot

ti-chi-bot Bot commented Sep 21, 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 lilin90 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 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. labels Sep 21, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 21, 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 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 21, 2026
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

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: adc827a7-2ad9-4305-9ff1-9190170ddfda

📥 Commits

Reviewing files that changed from the base of the PR and between a343636 and c2e70cc.

📒 Files selected for processing (1)
  • troubleshoot-stale-read.md

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


📝 Walkthrough

Walkthrough

The troubleshooting example renames “Max Resolved TS gap” to “Max gap of resolved-ts” in the dashboard instructions and image alt text. The dashboard link and image path remain unchanged.

Changes

Stale Read Documentation

Layer / File(s) Summary
Update Resolved-TS panel references
troubleshoot-stale-read.md
The example text and image alt text now use the actual Grafana panel name, “Max gap of resolved-ts”.

Priority: ➖ Normal

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

Change: Other · Severity of issue fixed: Medium

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation file and the specific Grafana panel name correction.
Description check ✅ Passed The description explains the change, affected file, reason, related reference, affected version, and unchanged screenshot. It includes the required sections and version selection.
Linked Issues check ✅ Passed The change satisfies issue #23817. In troubleshoot-stale-read.md, both the dashboard panel reference and the image alt text change from Max Resolved TS gap to Max gap of resolved-ts. The dashboa…
Out of Scope Changes check ✅ Passed The pull request changes only the two outdated panel-name references in troubleshoot-stale-read.md. The screenshot, dashboard reference, and image path remain unchanged. No unrelated changes are ide…
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…
✨ 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.

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/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.

troubleshoot-stale-read.md names a Grafana panel that doesn't exist ("Max Resolved TS gap")

1 participant