Skip to content

i18n(ja): restore literal English Grafana panel/series names in TiDB Lightning monitoring doc - #23879

Open
yahonda wants to merge 6 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-lightning-grafana-panel-names
Open

yahonda wants to merge 6 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-lightning-grafana-panel-names

Conversation

@yahonda

@yahonda yahonda commented Sep 16, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

tidb-lightning/monitor-tidb-lightning.md documents the TiDB Lightning Grafana dashboard (Rows 1-7). Its Panel and Series table-column values, and the English row-name portion of each ### N行目: <name> heading, had been translated into Japanese. Since these are literal panel/series/row labels from the real Grafana dashboard, translating them makes it impossible for a reader to match the doc against what they actually see in the Grafana UI.

Verified against the real TiDB Lightning dashboard JSON (pingcap/monitoring) and the parallel English doc file. Restored to literal English across all 7 rows, for example:

  • インポート速度Import speed, Chunk処理期間Chunk process duration
  • アイドルワーカーIdle workers, 外部リソースExternal resources
  • SQL処理速度SQL process rate, 合計バイト数Total bytes
  • Series values such as クローズ済みエンジンclosed-engine, 応募者apply worker, ストレージサイズ / 3storage_size / 3
  • Row headings, e.g. 1行目: スピード1行目: Speed, 7行目: インポート速度7行目: Import speed

Also translated one Description cell (Row 1, "Chunk process duration") that had been left as raw, untranslated English ("Average time needed to completely encode one single data file") into Japanese.

Description-column prose (the actual explanatory text) was left in Japanese as before — only the literal panel/series/row-name labels were restored to English.

Follow-up scope added to this PR (same file, same "keep literal identifiers literal" principle, found during review):

  • The ## Monitoring metrics section's Prometheus label keys type/name/state/result had also been translated (タイプ/名前/状態/結果), even though these are the actual label keys used in the real metric output (e.g. lightning_importer_engine{type="open"}). Restored to literal English.
  • Unified the state label's description wording (テーブルの状態/エンジンの状態テーブルのステータス/エンジンのステータス) to match this file's own dominant rendering of "status" (used in every metric's intro sentence and in lightning_chunks's own state description), plus the same word in the estimated caveat.
  • Translated the lightning_import_seconds description, which had been left as raw, untranslated English.

Deferred to the upcoming EN→JA sync rather than hand-applied here: unifying the lightning_idle_workers label descriptions ("Xの余り") with this document's own Grafana panel table wording ("未使用の数はX"), since the underlying English-source fix (#23881) hasn't merged yet.

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

🤖 Generated with Claude Code

…Lightning monitoring doc

Panel, series, and row-name labels in the Grafana dashboard tables were
translated into Japanese, making them impossible to match against the
real dashboard UI. Restore them as literal English (verified against
the live TiDB Lightning Grafana dashboard JSON) and translate the one
Description cell that had been left as raw, untranslated English.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ti-chi-bot

ti-chi-bot Bot commented Sep 16, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@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 16, 2026
@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 6 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 694e3898-e68c-43b0-8ede-f0db5bf686f7

📥 Commits

Reviewing files that changed from the base of the PR and between 09ec082 and b5a9210.

📒 Files selected for processing (1)
  • tidb-lightning/monitor-tidb-lightning.md

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 16, 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 hfxsd 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/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 16, 2026
yahonda and others added 5 commits September 16, 2026 09:36
The previous commit compacted the header row of each Grafana panel
table but left the old, now-mismatched dash-padding in the separator
row untouched. Normalize all separator rows to the same compact style.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…htning metrics reference

- Restore the Prometheus label keys type/name/state/result as literal
  English (they were translated to タイプ/名前/状態/結果, but these are
  the actual label keys used in the real metric, e.g.
  lightning_importer_engine{type="open"}).
- Unify the table/index/region/io idle-worker descriptions from
  '`X`の余り' to '未使用の数は`X`', matching this same document's
  Grafana panel table wording for the identical value (see
  pingcap#23881, which unifies the English source the same way).
- Translate the lightning_import_seconds description, which had been
  left as raw, untranslated English.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Revert the table/index/region/io description wording change from the
previous commit. The English source fix (pingcap#23881) hasn't
merged yet, and this wording will be picked up automatically by the
regular EN-to-JA sync once it does, rather than hand-applied here
ahead of it.

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

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
lightning_tables and lightning_engines described their state label as
'X の状態', while lightning_chunks (and every intro sentence in this
section, including these two metrics' own) already said 'X の
ステータス' for the identical English word 'status'. Unify on
ステータス, matching the file's own dominant convention.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda
yahonda marked this pull request as ready for review September 16, 2026 01:04
@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 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant