Skip to content

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

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:masterfrom
lilin90:copilot/fix-grafana-tikv-dashboard-names-23922
Sep 22, 2026
Merged

ti-chi-bot[bot] merged 2 commits into
pingcap:masterfrom
lilin90:copilot/fix-grafana-tikv-dashboard-names-23922

Conversation

@lilin90

@lilin90 lilin90 commented Sep 22, 2026

Copy link
Copy Markdown
Member

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
  • Fixes #23921

Summary by CodeRabbit

  • 新增功能

    • 新增多项 TiKV 监控指标,包括 Worker CPU、Check leader duration、Follower Region Safe TS 及 resolved-ts 间隔等指标。
  • 文档更新

    • 统一 Grafana 面板与指标名称及大小写格式。
    • 更新相关操作指南和故障排查文档中的指标引用,确保名称与监控面板保持一致。

Copilot AI lite review requested due to automatic review settings September 22, 2026 03:18
@lilin90 lilin90 added 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. translation/from-docs This PR is translated from a PR in pingcap/docs. labels Sep 22, 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 wasn't able to review any files in this pull request.


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@lilin90 lilin90 removed the needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. label Sep 22, 2026
@lilin90 lilin90 self-assigned this Sep 22, 2026
Synced from: pingcap/docs#23922
Target PR: pingcap#21951

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

Auto-sync completed successfully

Source PR: pingcap/docs#23922
Target PR: #21951

Chinese documentation has been updated based on English documentation changes.

@ti-chi-bot ti-chi-bot Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 22, 2026
@coderabbitai

coderabbitai Bot commented Sep 22, 2026

Copy link
Copy Markdown

Review in Change Stack →

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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 710b81a0-9b9e-49c5-983c-1be08c158016

📥 Commits

Reviewing files that changed from the base of the PR and between 7e1b1f3 and 378fc1a.

📒 Files selected for processing (3)
  • grafana-tikv-dashboard.md
  • tikv-control.md
  • troubleshoot-stale-read.md

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


📝 Walkthrough

Walkthrough

更新 TiKV Grafana 面板中的指标名称,并同步 tikv-control.mdtroubleshoot-stale-read.md 中的相关引用。

Changes

指标名称同步

Layer / File(s) Summary
更新 Grafana 指标名称
grafana-tikv-dashboard.md
Resolved-TS 改为 Resolved TS,统一多个指标的大小写,并更新 Max gap of safe-tsMin Safe TS Region 的名称。
同步文档引用
tikv-control.md, troubleshoot-stale-read.md
同步 Min Safe TS Follower RegionResolved TSCheck leader duration 的文档引用。

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 378fc

本 PR 仅同步 Grafana 面板名称及相关文档引用,不改变运行逻辑或产品行为,可合并。

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了 PR 的主要变更,即同步 Resolved TS 行和面板名称。标题简洁、明确,并与变更内容一致。
Description check ✅ Passed PR 描述完整说明了变更内容、影响版本、相关 PR 和参考链接,并勾选了 master 版本及 AI 参与项。描述符合模板要求,且与实际变更一致。
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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

@lilin90 lilin90 added the lgtm label Sep 22, 2026
@lilin90

lilin90 commented Sep 22, 2026

Copy link
Copy Markdown
Member Author

/approve

@ti-chi-bot

ti-chi-bot Bot commented Sep 22, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

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 the approved label Sep 22, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 0f9f2f8 into pingcap:master Sep 22, 2026
9 checks passed
@lilin90
lilin90 deleted the copilot/fix-grafana-tikv-dashboard-names-23922 branch September 22, 2026 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm ONCALL Relates to documentation oncall. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants