Skip to content

tidb-lightning: unify idle-worker wording with the Grafana panel table - #23881

Open
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-en-idle-worker-wording
Open

yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-en-idle-worker-wording

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 describes the lightning_idle_workers gauge's name label values twice in the same document:

  • Grafana panel table (Row 4: Quota, "Idle workers" panel): Number of unused \table-concurrency`, normally 0 until the end of process`
  • Metrics reference (lightning_idle_workers labels): the remainder of \table-concurrency`, normally 0 until the end of the process`

Both describe the exact same value (the trailing clause is otherwise identical, word for word, for all 4 labels: table/index/region/io). Checked against the Chinese source (docs-cn/tidb-lightning/monitor-tidb-lightning.md), which uses the identical phrase 未使用的 X 的数量 ("number of unused X") in both places — so this is not an intentional distinction, just inconsistent EN wording introduced independently in two different PRs (#1455 and #1535) by the same author, 15 days apart, back in 2019.

This PR unifies the metrics-reference wording to match the already-established Grafana-table phrasing (Number of unused X), and drops the stray "the" in "until the end of the process" to exactly match the Grafana table's "until the end of process" for full consistency.

This will also let the Japanese translation express both sites the same way, instead of forcing two different Japanese renderings ("未使用の数" vs "の余り") for what is the same underlying value.

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

  • v8.5 (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

Summary by CodeRabbit

  • Documentation
    • Clarified that the lightning_idle_workers metric reports unused workers for table, index, region, and I/O operations.

The lightning_idle_workers metric's label descriptions used "the
remainder of X", while the identical value is described in this same
document's Grafana panel table (Row 4: Quota, Idle workers) as "Number
of unused X" -- both trace back to the same Chinese source wording
(未使用的 X 的数量), so this was just inconsistent EN phrasing, not an
intentional distinction. Unify on "Number of unused X".

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

Review Change StackReview Change Stack

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: c9bf4261-50b7-4a45-a775-dbec86f32f01

📥 Commits

Reviewing files that changed from the base of the PR and between 6acba5d and b209ac6.

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

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


📝 Walkthrough

Walkthrough

The lightning_idle_workers metric documentation now describes table, index, and region values as unused-worker counts. The io description retains its existing default and disk-speed interpretation.

Changes

Metric Documentation

Layer / File(s) Summary
Update idle worker label descriptions
tidb-lightning/monitor-tidb-lightning.md
The documentation changes label descriptions from concurrency remainders to unused-worker counts. Existing defaults and the io disk-speed interpretation remain unchanged.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to b209a

This documentation-only update does not affect runtime behavior and is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: it unifies the idle-worker wording in the TiDB Lightning documentation with the Grafana panel table.
Description check ✅ Passed The description explains the documentation change, affected TiDB version, reference links, AI involvement, and scope checklist. It provides sufficient context for review.
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 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 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 tangenta 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 16, 2026
yahonda added a commit to yahonda/docs that referenced this pull request Sep 16, 2026
…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>
yahonda added a commit to yahonda/docs that referenced this pull request Sep 16, 2026
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>
@yahonda
yahonda marked this pull request as ready for review September 16, 2026 01:11
@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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant