Skip to content

docs: sync Resolved TS row/panel names with TiKV dashboard - #23922

Open
lilin90 with Copilot wants to merge 2 commits into
masterfrom
copilot/fix-grafana-tikv-dashboard-names
Open

lilin90 with Copilot wants to merge 2 commits into
masterfrom
copilot/fix-grafana-tikv-dashboard-names

Conversation

Copilot AI commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

First-time contributors' checklist

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

The Resolved-TS section in grafana-tikv-dashboard.md was out of sync with current TiKV dashboard titles, including two safe-ts panels whose meanings are now follower-scoped. This update aligns labels and descriptions with the upstream dashboard source.

  • Resolved TS section title and panel title alignment

    • Renamed section heading Resolved-TSResolved TS
    • Updated seven panel names to match TiKV dashboard casing/wording exactly:
      • Resolved TS Worker CPU
      • Advance ts Worker CPU
      • Scan lock Worker CPU
      • Check leader duration
      • Max gap of resolved-ts in region leaders
      • Max gap of follower safe-ts
      • Min Safe TS Follower Region
  • Follower safe-ts semantic correction

    • Updated descriptions for:
      • Max gap of follower safe-ts (minimum non-zero follower safe-ts gap to current time)
      • Min Safe TS Follower Region (follower Region with minimum safe-ts)
  • Doc snippet (updated section excerpt)

    ### Resolved TS
    - Max gap of follower safe-ts: The maximum time difference between the minimum non-zero safe-ts of followers in this TiKV and the current time
    - Min Safe TS Follower Region: The ID of the follower Region whose safe-ts is the minimal

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

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 21, 2026
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Advanced

Run ID: c92b467d-07ab-442c-9228-319b67aef499

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

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

ti-chi-bot Bot commented Sep 21, 2026

Copy link
Copy Markdown

Hi @Copilot. 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 needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. label Sep 21, 2026
@ti-chi-bot ti-chi-bot Bot added 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
Co-authored-by: lilin90 <30922556+lilin90@users.noreply.github.com>
@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 ask for approval from lilin90. 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 size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 21, 2026
Copilot AI changed the title [WIP] Fix TS row and panel names in grafana-tikv-dashboard docs: sync Resolved TS row/panel names with TiKV dashboard Sep 21, 2026
Copilot AI requested a review from lilin90 September 21, 2026 05:44

@sary8 sary8 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.

I filed #23921 and checked this against the TiKV dashboard source.

The eight renames match ResolvedTS() in tikv_details.dashboard.py (lines 8998-9257 at bdf406f). The two description changes carry over TiKV's own wording:

title="Max gap of follower safe-ts",
description="The gap between now() and the minimal (non-zero) safe ts for followers",
title="Min Safe TS Follower Region",
description="The region id of the follower that has minimal safe ts",

One thing I noticed: this patch only changes master, but the PR description also marks v9.0, v8.5, v8.1, v7.5, v7.1 and v6.5 as affected.

release-8.5, release-8.1, release-7.5 and release-7.1 still have Resolved-TS worker CPU here, while the TiKV dashboard on those branches already uses the newer names, including Max gap of follower safe-ts, so they seem to need the same update.

v9.0 and v6.5 are different. There is no release-9.0 branch in this repo, and TiKV release-6.5 has Resolved TS Worker CPU but neither Max gap of follower safe-ts nor Max gap of safe-ts, so I would verify that branch separately rather than backporting the same change.

Also, separately, this row has six panels the section does not mention at all: CheckLeader request region count, CheckLeader request size, Fail advance ts count, Initial scan backoff duration, Observe region status, Pending command size. I can open another issue for those if useful.

@lilin90
lilin90 marked this pull request as ready for review September 21, 2026 09:33
Copilot AI lite review requested due to automatic review settings September 21, 2026 09:33
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 21, 2026
@lilin90 lilin90 added the ONCALL Relates to documentation oncall. label Sep 21, 2026

Copilot AI 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.

Copilot review overview

🟡 Changes recommended

Several cross-document references still use renamed or removed dashboard labels.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 2 Low severity

Open (2)
What changed in this PR

Updates TiKV Grafana dashboard documentation to match current panel names and follower-specific safe-ts semantics.

Changes:

  • Renames the Resolved TS section and seven panel labels.
  • Corrects follower safe-ts descriptions.
  • Leaves related cross-references requiring updates.
File Description
grafana-tikv-dashboard.md Synchronizes Resolved TS labels and descriptions with TiKV.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread grafana-tikv-dashboard.md
- Min Safe TS Region: The ID of the Region whose safe-ts is the minimal
- Check Leader Duration: The distribution of time spent on processing leader requests. The duration is from sending requests to receiving responses in leader
- Max gap of resolved-ts in Region leaders: The maximum time difference between the resolved-ts of all active Regions in this TiKV and the current time, only for Region leaders
- Min Safe TS Follower Region: The ID of the follower Region whose safe-ts is the minimal
Comment thread grafana-tikv-dashboard.md
- Check Leader Duration: The distribution of time spent on processing leader requests. The duration is from sending requests to receiving responses in leader
- Max gap of resolved-ts in Region leaders: The maximum time difference between the resolved-ts of all active Regions in this TiKV and the current time, only for Region leaders
- Min Safe TS Follower Region: The ID of the follower Region whose safe-ts is the minimal
- Check leader duration: The distribution of time spent on processing leader requests. The duration is from sending requests to receiving responses in leader
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. ONCALL Relates to documentation oncall. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

grafana-tikv-dashboard.md: Resolved TS row and panel names are out of sync with TiKV

4 participants