Skip to content

i18n(ja): restore literal Grafana panel and section names in TiKV/TiCDC dashboards - #23816

Open
yahonda wants to merge 12 commits into
pingcap:i18n-ja-release-8.5from
yahonda:restore-grafana-panel-names
Open

i18n(ja): restore literal Grafana panel and section names in TiKV/TiCDC dashboards#23816
yahonda wants to merge 12 commits into
pingcap:i18n-ja-release-8.5from
yahonda:restore-grafana-panel-names

Conversation

@yahonda

@yahonda yahonda commented Sep 10, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

grafana-tikv-dashboard.md and ticdc/monitor-ticdc.md document Grafana dashboard panels as bulleted lists (- <panel name>: <description>). The panel-name portion of nearly every bullet (363 sites in grafana-tikv-dashboard.md, 100 sites in ticdc/monitor-ticdc.md) had been translated into Japanese instead of kept as the literal panel name from the actual Grafana dashboard JSON (pingcap/monitoring), breaking the reader's ability to locate the same panel in the live Grafana UI. Also restores literal English for the section (###) headings in both files (32 + 7 sites) — heading anchors ({#slug}) are unchanged, only the visible heading text.

Spot-verified several restored names against the real dashboard JSON via gh search code "<title>" --repo pingcap/monitoring, e.g. "Store size", "PD requests", "Server is busy", "gRPC message error", "Critical error" all match the real panel "title" field exactly.

Mechanically generated by pairing each EN/JA bullet and heading 1:1 by position (EN and JA have the identical bullet/heading count in both files, confirming a strict line-for-line correspondence) and replacing only the JA panel-name segment before the colon with EN's exact text, leaving the JA description text untouched. Verified a large sample of the diff by hand before applying.

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)?

  • This PR is translated from:
  • Other reference 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
    • Standardized Japanese documentation with official English Grafana dashboard, panel, metric, and navigation names.
    • Improved terminology consistency across TiDB, TiKV, TiCDC, DM, TiFlash, and TiDB Cloud guides.
    • Corrected panel references, labels, punctuation, spacing, formatting, and selected metric descriptions.
    • Updated release notes and support documentation wording without changing product functionality, configuration behavior, or links.

@coderabbitai

coderabbitai Bot commented Sep 10, 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
📝 Walkthrough

Walkthrough

This documentation update standardizes Grafana names, metric labels, TiCDC terminology, architecture wording, and support terms across Japanese documentation. It also corrects selected metric units and adds the User-Node-Info dashboard. No product logic changed.

Changes

Dashboard and metric labels

Layer / File(s) Summary
Grafana references and operational labels
alert-rules.md, best-practices/*, br/*, dm/*, follower-read.md, garbage-collection-configuration.md, grafana-*.md, sql-prepared-plan-cache.md, system-variables.md, tidb-*.md, tiflash/*, tikv-*.md, troubleshoot-*.md
Japanese Grafana names and metric labels now use standardized English names. Related emphasis, spacing, and terminology were adjusted.
TiKV and TiDB dashboard documentation
grafana-tikv-dashboard.md, grafana-pd-dashboard.md, grafana-performance-overview-dashboard.md, tidb-cloud/tidb-cloud-clinic.md, tikv-configuration-file.md
Dashboard sections use English panel names. The clinic dashboard list adds User-Node-Info, and configuration descriptions use English terms.

TiCDC terminology and monitoring documentation

Layer / File(s) Summary
TiCDC monitoring labels and metric descriptions
ticdc/monitor-ticdc.md, ticdc/ticdc-summary-monitor.md
TiCDC panel names and metric labels now use English names. Sink flush throughput is described in rows per second, and KV client dispatch is described in events per second.
TiCDC architecture terminology
ticdc/ticdc-architecture.md, ticdc/ticdc-classic-architecture.md, ticdc/ticdc-data-replication-capabilities.md, ticdc/ticdc-overview.md
Architecture references use クラシックアーキテクチャ. Timestamp terms use ResolvedTS, CheckpointTS, and Barrier TS. Existing link targets and anchors remain unchanged.

Release-note terminology

Layer / File(s) Summary
Release and support wording
releases/release-*.md, tidb-cloud/releases/tidb-cloud-release-notes.md
Release notes use standardized Grafana and architecture names. TiDB Cloud release notes use Support Plan and Support Portal.

Priority: ⬇️ Low

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

Suggested reviewers: qiancai

Merge Risk: 🔵 Low · up to 33886

TiDB Cloud users can be directed to an unavailable dashboard, and a few dashboard labels remain inconsistent. These documentation corrections should be made before merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: restoring literal Grafana panel and section names in the TiKV and TiCDC dashboards.
Description check ✅ Passed The description includes the required change summary, affected version, related-links section, AI involvement, and change-type checklist. It accurately explains the primary TiKV and TiCDC updates, alt…
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.

@ti-chi-bot

ti-chi-bot Bot commented Sep 10, 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 kissmydb 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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 10, 2026

@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: 12


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 498e0ac6-52f4-440a-8471-cf66c16e4b53

📥 Commits

Reviewing files that changed from the base of the PR and between d13d772 and 7ed73bb.

📒 Files selected for processing (53)
  • alert-rules.md
  • best-practices/massive-regions-best-practices.md
  • best-practices/three-nodes-hybrid-deployment.md
  • best-practices/tidb-partitioned-tables-best-practices.md
  • br/br-auto-tune.md
  • br/br-monitoring-and-alert.md
  • dm/dm-webui-guide.md
  • dynamic-config.md
  • follower-read.md
  • garbage-collection-configuration.md
  • grafana-pd-dashboard.md
  • grafana-performance-overview-dashboard.md
  • grafana-resource-control-dashboard.md
  • grafana-tidb-dashboard.md
  • grafana-tikv-dashboard.md
  • releases/release-3.0.1.md
  • releases/release-3.0.8.md
  • releases/release-4.0.13.md
  • releases/release-4.0.15.md
  • releases/release-5.0.4.md
  • releases/release-5.1.2.md
  • releases/release-5.2.4.md
  • releases/release-5.3.2.md
  • releases/release-5.4.2.md
  • releases/release-6.1.2.md
  • releases/release-6.3.0.md
  • releases/release-6.5.1.md
  • releases/release-7.1.3.md
  • releases/release-7.2.0.md
  • releases/release-7.5.1.md
  • releases/release-7.6.0.md
  • releases/release-8.3.0.md
  • releases/release-8.5.4.md
  • sql-prepared-plan-cache.md
  • system-variables.md
  • ticdc-performance-tuning-methods.md
  • ticdc/monitor-ticdc.md
  • ticdc/ticdc-architecture.md
  • ticdc/ticdc-changefeed-overview.md
  • ticdc/ticdc-classic-architecture.md
  • ticdc/ticdc-data-replication-capabilities.md
  • ticdc/ticdc-open-protocol.md
  • ticdc/ticdc-overview.md
  • ticdc/ticdc-summary-monitor.md
  • tidb-cloud/tidb-cloud-clinic.md
  • tidb-performance-tuning-config.md
  • tidb-resource-control-ru-groups.md
  • tiflash/troubleshoot-tiflash.md
  • tikv-configuration-file.md
  • tikv-in-memory-engine.md
  • troubleshoot-cpu-issues.md
  • troubleshoot-hot-spot-issues.md
  • troubleshoot-stale-read.md

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

Comment thread alert-rules.md Outdated
Comment thread grafana-performance-overview-dashboard.md Outdated
Comment thread grafana-resource-control-dashboard.md Outdated
Comment thread releases/release-6.1.2.md
- TiCDC

- 解決されたTSをバッチで処理することにより、リージョンワーカーのパフォーマンスを向上させます。 [#7078](https://github.com/pingcap/tiflow/issues/7078) @[sdojjy](https://github.com/sdojjy)
- resolved TSをバッチで処理することにより、リージョンワーカーのパフォーマンスを向上させます。 [#7078](https://github.com/pingcap/tiflow/issues/7078) @[sdojjy](https://github.com/sdojjy)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use the standardized Resolved TS capitalization.

The other supplied release notes use Resolved TS for this TiKV concept. Keep the capitalization consistent across the release-note set.

Suggested change
- resolved TSをバッチで処理することにより、リージョンワーカーのパフォーマンスを向上させます。 [#7078](https://github.com/pingcap/tiflow/issues/7078) @[sdojjy](https://github.com/sdojjy)
- Resolved TSをバッチで処理することにより、リージョンワーカーのパフォーマンスを向上させます。 [`#7078`](https://github.com/pingcap/tiflow/issues/7078) @[sdojjy](https://github.com/sdojjy)

As per path instructions, this Markdown issue includes a committable suggestion block.

Source: Path instructions

Comment thread ticdc/monitor-ticdc.md Outdated
Comment thread ticdc/monitor-ticdc.md Outdated
Comment thread ticdc/ticdc-summary-monitor.md Outdated
Comment thread tikv-configuration-file.md Outdated
Comment thread tikv-configuration-file.md Outdated
Comment thread troubleshoot-stale-read.md Outdated
@yahonda
yahonda force-pushed the restore-grafana-panel-names branch 3 times, most recently from 738dbc3 to 5edb4cc Compare September 10, 2026 06:18
@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 10, 2026
yahonda and others added 11 commits September 11, 2026 09:15
…DC dashboards

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
… dashboards and cross-references

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…-monitor.md

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda
yahonda force-pushed the restore-grafana-panel-names branch from 5edb4cc to c8d6438 Compare September 11, 2026 00:19
…bbit

- プラー -> Puller typo in two monitor-ticdc.md bullets
- Sink flush rows/s described in events instead of rows
- KV client dispatch events/s missing the per-second rate qualifier
- Full Flush Duration cross-reference still translated Backend Flush
  Duration instead of reusing the literal label defined two bullets above

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda

yahonda commented Sep 11, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@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: 2

♻️ Duplicate comments (1)
tidb-resource-control-ru-groups.md (1)

380-380: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Remove the self-managed Grafana instructions from the TiDB Cloud block.

Line 380 still directs TiDB Cloud users to the self-managed TiDB > Resource Control dashboard. This conflicts with the Note on Line 378, which directs TiDB Cloud Dedicated users to Calibrate Resource. Remove this sentence and the unchanged TiKV dashboard sentence on Line 382, or replace both with the TiDB Cloud console workflow.

As per path instructions, use a regular comment because the complete fix spans changed and unchanged lines.

Source: Path instructions


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 06bf086f-bfb0-4f83-b2aa-bc350a72dc8c

📥 Commits

Reviewing files that changed from the base of the PR and between 645c2ff and 33886b6.

📒 Files selected for processing (35)
  • alert-rules.md
  • best-practices/massive-regions-best-practices.md
  • best-practices/three-nodes-hybrid-deployment.md
  • br/br-auto-tune.md
  • br/br-monitoring-and-alert.md
  • dm/dm-webui-guide.md
  • follower-read.md
  • garbage-collection-configuration.md
  • grafana-pd-dashboard.md
  • grafana-performance-overview-dashboard.md
  • grafana-resource-control-dashboard.md
  • grafana-tidb-dashboard.md
  • grafana-tikv-dashboard.md
  • releases/release-3.0.8.md
  • releases/release-4.0.13.md
  • releases/release-8.3.0.md
  • releases/release-8.5.4.md
  • sql-prepared-plan-cache.md
  • system-variables.md
  • ticdc/monitor-ticdc.md
  • ticdc/ticdc-architecture.md
  • ticdc/ticdc-classic-architecture.md
  • ticdc/ticdc-data-replication-capabilities.md
  • ticdc/ticdc-overview.md
  • ticdc/ticdc-summary-monitor.md
  • tidb-cloud/releases/tidb-cloud-release-notes.md
  • tidb-cloud/tidb-cloud-clinic.md
  • tidb-performance-tuning-config.md
  • tidb-resource-control-ru-groups.md
  • tiflash/troubleshoot-tiflash.md
  • tikv-configuration-file.md
  • tikv-in-memory-engine.md
  • troubleshoot-cpu-issues.md
  • troubleshoot-hot-spot-issues.md
  • troubleshoot-stale-read.md

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

### パフォーマンス監視 {#performance-monitoring}

Grafana の**TiKV ダッシュボード**では、次の監視メトリックを確認できます。
Grafana の**TiKV Dashboard**では、次の監視メトリックを確認できます。

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Use the canonical dashboard title.

The referenced Grafana view is titled TiKV-Details. TiKV Dashboard is used only in image alt text, not as a separate dashboard title, so the current wording can make the view harder to locate.

Apply this replacement
-Grafana の**TiKV Dashboard**では、次の監視メトリックを確認できます。
+Grafana の**TiKV-Details**ダッシュボードでは、次の監視メトリックを確認できます。
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Grafana の**TiKV Dashboard**では、次の監視メトリックを確認できます。
Grafana の**TiKV-Details**ダッシュボードでは、次の監視メトリックを確認できます。

> このセクションでは、TiDB Self-Managed でのみ利用可能な Grafana ダッシュボードについて説明します。TiDB Cloud Dedicated では、TiDB Cloud コンソールの [Calibrate Resource](/tidb-cloud/calibrate-resource.md) ページで、**Total RU Consumed** や **RU Consumed by Resource Groups** などのリソース制御メトリクスを表示できます。

TiDBは、リソース制御に関するランタイム情報を定期的に収集し、Grafanaの**TiDB** &gt;**リソース制御**ダッシュボードでそのメトリクスの視覚的なグラフを提供します。
TiDBは、リソース制御に関するランタイム情報を定期的に収集し、Grafanaの**TiDB** &gt; **Resource Control**ダッシュボードでそのメトリクスの視覚的なグラフを提供します。

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Remove the unavailable Grafana instruction for TiDB Cloud

The surrounding note directs TiDB Cloud Dedicated users to Monitoring > Calibrate Resource for these metrics. This sentence still directs them to the unavailable Grafana > TiDB > Resource Control dashboard.

Suggested change
TiDBは、リソース制御に関するランタイム情報を定期的に収集し、Grafanaの**TiDB** &gt; **Resource Control**ダッシュボードでそのメトリクスの視覚的なグラフを提供します。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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