Skip to content

i18n(ja): restore literal English metric names in TiDB Cloud monitoring docs - #23751

Merged
qiancai merged 1 commit into
pingcap:i18n-ja-release-8.5from
yahonda:fix-monitoring-metric-names-english
Sep 7, 2026
Merged

i18n(ja): restore literal English metric names in TiDB Cloud monitoring docs#23751
qiancai merged 1 commit into
pingcap:i18n-ja-release-8.5from
yahonda:fix-monitoring-metric-names-english

Conversation

@yahonda

@yahonda yahonda commented Sep 7, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Restores the literal English metric/panel names in TiDB Cloud built-in monitoring docs. The Metric name column in these dashboard tables must contain the literal panel name exactly as shown on the actual TiDB Cloud Metrics page in the product UI (for example, "Database Time by SQL types", "Query Per Second"). The Japanese translation had translated these literal names into Japanese descriptive phrases instead of keeping the literal English UI text. Also restored the accompanying Labels column values where the EN source itself presents them as literal legend/series values (e.g. {SQL type}, hit, miss, All, avg-in-txn) rather than descriptive prose.

  • tidb-cloud/built-in-monitoring.md: 5 tables (Overview, Advanced, Server for Dedicated; Instance Overview, Database Status for Starter/Essential) — 58 Metric-name/Labels cells restored to literal English.
  • tidb-cloud/premium/built-in-monitoring-premium.md: 3 tables (Overview, Database, Advanced) — 24 Metric-name/Labels cells restored to literal English.

Description columns (free translated prose) were left unchanged.

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
    • Updated TiDB Cloud built-in monitoring metric names and labels to match the English terminology displayed in the Metrics UI.
    • Applied consistent English naming across Dedicated, Starter, Essential, and Premium monitoring documentation.
    • Retained Japanese metric descriptions while standardizing metric names and label values.

…ng docs

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

ti-chi-bot Bot commented Sep 7, 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 lance6716 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 7, 2026
@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review 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: Team

Run ID: e19c4d20-4595-4263-8c65-692b6d270830

📥 Commits

Reviewing files that changed from the base of the PR and between 80dffad and fec3448.

📒 Files selected for processing (2)
  • tidb-cloud/built-in-monitoring.md
  • tidb-cloud/premium/built-in-monitoring-premium.md

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


📝 Walkthrough

Walkthrough

The monitoring documentation replaces Japanese metric names and labels with English names from the Metrics UI. Japanese metric descriptions remain in the Dedicated, Starter, Essential, and Premium tables.

Changes

Monitoring metric documentation

Layer / File(s) Summary
Dedicated cluster metric names
tidb-cloud/built-in-monitoring.md
The Dedicated Overview, Advanced, and Server tables now use English metric names and labels.
Starter and Essential metric names
tidb-cloud/built-in-monitoring.md
The Instance Overview and Database Status tables now use English metric names and labels.
Premium metric names
tidb-cloud/premium/built-in-monitoring-premium.md
The Premium Overview, Database, and Advanced tables now use English metric names and labels. Japanese descriptions remain unchanged.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to fec34

Monitoring documentation now matches the English metric and label names shown in the UI while preserving Japanese explanatory text. The documentation-only update is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: restoring literal English metric names in TiDB Cloud monitoring documentation.
Description check ✅ Passed The description explains the changes, affected files and tables, version scope, related PR, AI involvement, and applicable change categories. It is sufficiently complete 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 💡 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.

@qiancai qiancai added translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. translation/no-need No need to translate this PR. labels Sep 7, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Sep 7, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 7, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 7, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-09-07 06:33:29.032977264 +0000 UTC m=+1693044.204071372: ☑️ agreed by qiancai.

@qiancai
qiancai merged commit 32db0cb into pingcap:i18n-ja-release-8.5 Sep 7, 2026
5 of 9 checks passed
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/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/no-need No need to translate this PR. translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants