Skip to content

i18n(ja): restore literal English Grafana panel names in dashboard docs - #23763

Merged
qiancai merged 18 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-grafana-panel-names-english
Sep 8, 2026
Merged

qiancai merged 18 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-grafana-panel-names-english

Conversation

@yahonda

@yahonda yahonda commented Sep 8, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Restores literal English Grafana panel/metric names in three Japanese monitoring docs. These panel names (e.g. "Services Up", "PD role", "Duration", "CPS By Instance") are literal strings shown in the actual Grafana dashboard UI and must stay in English, matching the convention already established for tidb-cloud/built-in-monitoring.md (#23751). Descriptions after each panel name remain translated.

  • grafana-overview-dashboard.md: 49 panel-name table cells restored to English
  • grafana-tidb-dashboard.md: 126 panel-name bullet leads restored to English
  • grafana-pd-dashboard.md: 76 panel-name bullet leads restored to English

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

  • i18n-ja-release-8.5 (TiDB Japanese documentation for TiDB 8.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
    • Translated Grafana dashboard metric, panel, service, and section names from Japanese to English across the Overview, PD, and TiDB dashboard documentation.
    • Retained Japanese descriptions, normal-range values, anchors, and image references where applicable.
    • Updated the TiDB duration description to clarify that elapsed time includes returning results to the client.

@ti-chi-bot

ti-chi-bot Bot commented Sep 8, 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 breezewish 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/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 8, 2026
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: dc98cef4-c2cc-4b41-b204-0ee2bf382cfc

📥 Commits

Reviewing files that changed from the base of the PR and between 5f9d1f2 and 1d9684d.

📒 Files selected for processing (2)
  • grafana-pd-dashboard.md
  • grafana-tidb-dashboard.md

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


📝 Walkthrough

Walkthrough

The Grafana Overview, PD, and TiDB dashboard documentation now uses English metric and panel names. Japanese descriptions and normal-range values remain unchanged.

Changes

Grafana metric translations

Layer / File(s) Summary
Overview dashboard labels
grafana-overview-dashboard.md
The key metrics table uses English service and panel names across the Services Port Status, PD, TiDB, TiKV, and System Info rows.
PD dashboard metric labels
grafana-pd-dashboard.md
Metric names and section headings use English across the cluster, operator, balance, hot region, scheduler, gRPC, etcd, TiDB, heartbeat, and region storage sections.
TiDB dashboard metric labels
grafana-tidb-dashboard.md
Metric display names and section headings use English across all documented TiDB dashboard sections. The Duration description now refers to returning results to the client.

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

Merge Risk: 🔵 Low · up to 1d968

This documentation change restores English Grafana labels while retaining Japanese descriptions. Two Overview panel labels remain inconsistent with their dashboard titles, which can mislead users locating those panels but has bounded documentation impact.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: restoring literal English Grafana panel names in Japanese dashboard documentation.
Description check ✅ Passed The description explains the changes, identifies affected files and counts, specifies the TiDB 8.5 Japanese documentation scope, includes reference information, records AI involvement, and addresses t…
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 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 09b21e65-f873-4c40-b6bf-e9bf6ac0f2ab

📥 Commits

Reviewing files that changed from the base of the PR and between 32db0cb and acc63e7.

📒 Files selected for processing (3)
  • grafana-overview-dashboard.md
  • grafana-pd-dashboard.md
  • grafana-tidb-dashboard.md

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

Comment thread grafana-overview-dashboard.md
@ti-chi-bot ti-chi-bot Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 8, 2026
@qiancai qiancai added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Sep 8, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 8, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 8, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-09-08 06:04:24.119183936 +0000 UTC m=+1777699.290278046: ☑️ agreed by qiancai.

# Conflicts:
#	grafana-overview-dashboard.md
#	grafana-tidb-dashboard.md
@qiancai
qiancai merged commit 7ec44ef into pingcap:i18n-ja-release-8.5 Sep 8, 2026
5 of 8 checks passed
yahonda added a commit to yahonda/docs that referenced this pull request Sep 8, 2026
…oring doc

ticdc/monitor-ticdc.md documents the literal panel/metric names shown on
the actual TiCDC Grafana dashboards (both the new-architecture and
classic-architecture monitoring boards). Nearly every bullet label across
all 9 sections had been translated into Japanese, breaking the reader's
ability to match a label against what they see in Grafana -- the same
defect class documented for the grafana-*-dashboard.md files in PR pingcap#23763
(see memory ja-grafana-panel-names-english). Restored all metric/panel
labels to literal English (matching the live Grafana panel/section names)
while keeping the Japanese description text after each label unchanged.
Also fixed 2 section headings and the panel-name references in prose that
had drifted from their own anchor's English name (e.g. 概要/サーバー
panel-name mentions not matching the Summary/Server heading english form).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
yahonda added a commit to yahonda/docs that referenced this pull request Sep 8, 2026
…peer mistranslation

- follower-read.md: restored a Grafana breadcrumb link (TiDB > KV Request >
  Read Req Traffic panel) to literal English, matching the panel-name
  defect class from PR pingcap#23763.
- grafana-performance-overview-dashboard.md: restored all panel/metric
  labels across every section (Performance Overview, TiFlash, CDC) to
  literal English while keeping descriptions in Japanese; also fixed
  several scrambled/garbled sentences found in the same pass (QPS, avg by
  type, kv request by type bullets) and a duplicated Raft/Raft typo.
- grafana-resource-control-dashboard.md: same treatment across all 3
  metric sections.
- glossary.md: fixed a same-file self-contradiction where the Region/Peer
  section heading and its inbound link used 仲間 (an informal, wrong
  register for 'peer') while the section's own body text already
  correctly used the established term ピア for the identical concept.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants