i18n(ja): restore literal Grafana panel and section names in TiKV/TiCDC dashboards - #23816
i18n(ja): restore literal Grafana panel and section names in TiKV/TiCDC dashboards#23816yahonda wants to merge 12 commits into
Conversation
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis 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 ChangesDashboard and metric labels
TiCDC terminology and monitoring documentation
Release-note terminology
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~10 minutes Suggested reviewers: Merge Risk: 🔵 Low · up to 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)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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. Comment |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
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
📒 Files selected for processing (53)
alert-rules.mdbest-practices/massive-regions-best-practices.mdbest-practices/three-nodes-hybrid-deployment.mdbest-practices/tidb-partitioned-tables-best-practices.mdbr/br-auto-tune.mdbr/br-monitoring-and-alert.mddm/dm-webui-guide.mddynamic-config.mdfollower-read.mdgarbage-collection-configuration.mdgrafana-pd-dashboard.mdgrafana-performance-overview-dashboard.mdgrafana-resource-control-dashboard.mdgrafana-tidb-dashboard.mdgrafana-tikv-dashboard.mdreleases/release-3.0.1.mdreleases/release-3.0.8.mdreleases/release-4.0.13.mdreleases/release-4.0.15.mdreleases/release-5.0.4.mdreleases/release-5.1.2.mdreleases/release-5.2.4.mdreleases/release-5.3.2.mdreleases/release-5.4.2.mdreleases/release-6.1.2.mdreleases/release-6.3.0.mdreleases/release-6.5.1.mdreleases/release-7.1.3.mdreleases/release-7.2.0.mdreleases/release-7.5.1.mdreleases/release-7.6.0.mdreleases/release-8.3.0.mdreleases/release-8.5.4.mdsql-prepared-plan-cache.mdsystem-variables.mdticdc-performance-tuning-methods.mdticdc/monitor-ticdc.mdticdc/ticdc-architecture.mdticdc/ticdc-changefeed-overview.mdticdc/ticdc-classic-architecture.mdticdc/ticdc-data-replication-capabilities.mdticdc/ticdc-open-protocol.mdticdc/ticdc-overview.mdticdc/ticdc-summary-monitor.mdtidb-cloud/tidb-cloud-clinic.mdtidb-performance-tuning-config.mdtidb-resource-control-ru-groups.mdtiflash/troubleshoot-tiflash.mdtikv-configuration-file.mdtikv-in-memory-engine.mdtroubleshoot-cpu-issues.mdtroubleshoot-hot-spot-issues.mdtroubleshoot-stale-read.md
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.
| - 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) |
There was a problem hiding this comment.
📐 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.
| - 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
738dbc3 to
5edb4cc
Compare
…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>
5edb4cc to
c8d6438
Compare
…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>
|
@coderabbitai full review |
✅ Action performedFull review finished. |
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
tidb-resource-control-ru-groups.md (1)
380-380: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRemove the self-managed Grafana instructions from the TiDB Cloud block.
Line 380 still directs TiDB Cloud users to the self-managed
TiDB > Resource Controldashboard. This conflicts with the Note on Line 378, which directs TiDB Cloud Dedicated users toCalibrate 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
📒 Files selected for processing (35)
alert-rules.mdbest-practices/massive-regions-best-practices.mdbest-practices/three-nodes-hybrid-deployment.mdbr/br-auto-tune.mdbr/br-monitoring-and-alert.mddm/dm-webui-guide.mdfollower-read.mdgarbage-collection-configuration.mdgrafana-pd-dashboard.mdgrafana-performance-overview-dashboard.mdgrafana-resource-control-dashboard.mdgrafana-tidb-dashboard.mdgrafana-tikv-dashboard.mdreleases/release-3.0.8.mdreleases/release-4.0.13.mdreleases/release-8.3.0.mdreleases/release-8.5.4.mdsql-prepared-plan-cache.mdsystem-variables.mdticdc/monitor-ticdc.mdticdc/ticdc-architecture.mdticdc/ticdc-classic-architecture.mdticdc/ticdc-data-replication-capabilities.mdticdc/ticdc-overview.mdticdc/ticdc-summary-monitor.mdtidb-cloud/releases/tidb-cloud-release-notes.mdtidb-cloud/tidb-cloud-clinic.mdtidb-performance-tuning-config.mdtidb-resource-control-ru-groups.mdtiflash/troubleshoot-tiflash.mdtikv-configuration-file.mdtikv-in-memory-engine.mdtroubleshoot-cpu-issues.mdtroubleshoot-hot-spot-issues.mdtroubleshoot-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**では、次の監視メトリックを確認できます。 |
There was a problem hiding this comment.
🎯 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.
| 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** >**リソース制御**ダッシュボードでそのメトリクスの視覚的なグラフを提供します。 | ||
| TiDBは、リソース制御に関するランタイム情報を定期的に収集し、Grafanaの**TiDB** > **Resource Control**ダッシュボードでそのメトリクスの視覚的なグラフを提供します。 |
There was a problem hiding this comment.
🎯 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.
| TiDBは、リソース制御に関するランタイム情報を定期的に収集し、Grafanaの**TiDB** > **Resource Control**ダッシュボードでそのメトリクスの視覚的なグラフを提供します。 |
What is changed, added or deleted? (Required)
grafana-tikv-dashboard.mdandticdc/monitor-ticdc.mddocument Grafana dashboard panels as bulleted lists (- <panel name>: <description>). The panel-name portion of nearly every bullet (363 sites ingrafana-tikv-dashboard.md, 100 sites inticdc/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)
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit