Skip to content

tiup: document Prometheus external labels in Chinese (#21837) - #21844

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-21837-to-release-8.5
Jul 29, 2026
Merged

tiup: document Prometheus external labels in Chinese (#21837)#21844
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-21837-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Jul 29, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #21837

First-time contributors' checklist

What is changed, added or deleted? (Required)

This PR adds the Chinese documentation for TiUP support for monitoring_servers[].external_labels.

It mirrors the English docs update by documenting the new field in the TiUP cluster and DM topology references, and by adding a dedicated section to the monitoring customization guide. It also keeps the compatibility note aligned with the implementation: older TiUP versions fail to parse the topology file instead of ignoring the field.

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

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.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

  • 文档
    • 新增 Prometheus 全局 external_labels 配置说明,支持在监控服务拓扑配置中设置环境、区域等标签。
    • 补充配置示例、标签命名限制及保留标签规则。
    • 明确该功能自 TiUP v1.17.0 起支持,旧版本解析包含该字段的拓扑配置时会失败。

@ti-chi-bot ti-chi-bot added area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool. for-release This PR relates to a TiDB release but does not have a tracked feature. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Jul 29, 2026
@coderabbitai

coderabbitai Bot commented Jul 29, 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: Pro Plus

Run ID: cee2424c-e46d-4180-8201-1ac7fe7bdf69

📥 Commits

Reviewing files that changed from the base of the PR and between 598728f and 23ef650.

📒 Files selected for processing (3)
  • tiup/customized-montior-in-tiup-environment.md
  • tiup/tiup-cluster-topology-reference.md
  • tiup/tiup-dm-topology-reference.md

📝 Walkthrough

Walkthrough

新增 TiUP monitoring_servers.external_labels 文档,涵盖配置方式、标签命名与保留规则、版本兼容行为,以及 TiUP Cluster 和 TiUP DM 的拓扑示例。

Changes

Prometheus 外部标签文档

Layer / File(s) Summary
配置行为与约束
tiup/customized-montior-in-tiup-environment.md, tiup/*topology-reference.md
说明 external_labels 的引入版本、全局配置渲染行为、标签命名规则、保留标签及旧版 TiUP 的解析失败行为。
拓扑配置示例
tiup/tiup-cluster-topology-reference.md, tiup/tiup-dm-topology-reference.md
在 TiUP Cluster 和 TiUP DM 的 monitoring_servers 示例中加入外部标签配置。

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

Possibly related PRs

  • pingcap/docs-cn#21837:同样补充 TiUP monitoring_servers[].external_labels 的中文文档、示例及旧版解析行为。

Suggested labels: translation/from-docs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了文档新增 Prometheus external_labels 说明这一主要改动。
Description check ✅ Passed 描述基本覆盖模板要求,包含变更说明、适用版本、相关链接和 AI 参与信息。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

@lilin90 lilin90 self-assigned this Jul 29, 2026
@lilin90

lilin90 commented Jul 29, 2026

Copy link
Copy Markdown
Member

/approve

@ti-chi-bot

ti-chi-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 the approved label Jul 29, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 28f4b39 into pingcap:release-8.5 Jul 29, 2026
11 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-21837-to-release-8.5 branch July 29, 2026 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool. for-release This PR relates to a TiDB release but does not have a tracked feature. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants