byoc: support vCPU limit alerts by wildpcww · Pull Request #24521 · pingcap/docs

wildpcww · 2026-10-21T10:52:09Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added, or deleted? (Required)

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

What is the related PR or file link(s)?

Related code change PR links (if applicable):
This PR is translated from:
Other reference 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

New Features
- Alert subscriptions and alert viewing now include BYOC instances.
- BYOC alerts cover performance thresholds, resource-pool vCPU allocation and blocked scaling, and changefeed latency or status.
Documentation
- Added threshold and configuration details for performance, resource-pool, and changefeed alerts, including default allocation thresholds and conditions for vCPU limit alerts.
- Clarified that allocation alerts can be configured per instance, while blocked-scaling alerts cannot be disabled and may appear on another instance in the pool.

coderabbitai · 2026-10-21T10:52:42Z

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Last reviewed commit: 2a3dd94
Latest commit, not reviewed: 3eacec0

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Source mode: Auto
Repository: pingcap/docs
Branch: release-8.5
File: .coderabbit.yaml
Commit: 6e320b1
Layers: Repository YAML
Review profile: ASSERTIVE
Plan: Advanced
Run ID: d741d1de-8b8f-43c0-8f3c-25609ec4e5b1

📥 Commits

Reviewing files that changed from the base of the PR and between 0060232 and 2a3dd94.

📒 Files selected for processing: 1

tidb-cloud/monitor-built-in-alerting.md

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

📝 Walkthrough

The alerting guide now includes BYOC instances in subscription and alert-viewing instructions. It adds BYOC performance, resource-pool vCPU, and changefeed alert details, and updates line breaks in existing recommendations.

Changes: BYOC alert documentation

Layer / File(s)	Summary
BYOC subscription and alert viewing `tidb-cloud/monitor-built-in-alerting.md`	Subscription availability, alert viewing, and instance selection now include BYOC instances.
BYOC alerts and recommendation formatting `tidb-cloud/monitor-built-in-alerting.md`	The guide documents BYOC performance, resource-pool vCPU, and changefeed alerts, including thresholds and settings. Existing Premium, Essential, and Dedicated recommendations remove HTML line breaks before support guidance.

Priority: ➖ Normal

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

Change: Other

Suggested reviewers: huoyao1125, oreoxmt

Merge Risk: 🔵 Low · up to 2a3dd

BYOC users may be unable to follow the documented email-alert subscription process.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Description check		The description includes the template and selects v8.5, but it leaves the required change summary blank. It also provides no related links or explanation of the alert behavior.	Complete the required change summary with the documentation changes and their purpose. Describe the supported vCPU limit alert behavior, confirm the affected TiDB version or branch, and add relevant code or reference links when applicable.

Passed checks: 4 passed

Check name	Status	Explanation
Title check		The title clearly identifies the main documentation change: support for vCPU limit alerts in BYOC environments.
Docstring Coverage		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		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.}

coderabbitai

Actionable comments posted: 2

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository: pingcap/docs/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 53713b7d-a877-41a2-8e9e-174bc595b7d5

📥 Commits

Reviewing files that changed from the base of the PR and between 6e320b1 and 737f43e.

📒 Files selected for processing: 1

tidb-cloud/monitor-built-in-alerting.md

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

for premium lik

ti-chi-bot · 2026-10-23T09:53:47Z

[LGTM Timeline notifier]

Timeline:

2026-10-23 09:53:47.42819478 +0000 UTC m=+109564.919907039: ☑️ agreed by lilin90.

lilin90 · 2026-10-23T09:54:11Z

/approve

ti-chi-bot · 2026-10-23T09:54:21Z

[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:

~~OWNERS~~ [lilin90]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Update monitor-built-in-alerting.md

737f43e

ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 21, 2026

coderabbitai Bot reviewed Oct 21, 2026

View reviewed changes

Comment thread tidb-cloud/monitor-built-in-alerting.md

Comment thread tidb-cloud/monitor-built-in-alerting.md Outdated

Update monitor-built-in-alerting.md

0060232

lilin90 self-assigned this Oct 23, 2026

lilin90 added the translation/no-need No need to translate this PR. label Oct 23, 2026

ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Oct 23, 2026

lilin90 added the BYOC Related to TiDB Cloud BYOC docs. label Oct 23, 2026

lilin90 changed the title ~~Update monitor-built-in-alerting.md~~ byoc: support vCPU limit alerts Oct 23, 2026

lilin90 and others added 5 commits October 23, 2026 17:21

Update format

2a3dd94

Update format

4f86e5d

Update Pool vCPU Limit format

6cd09bc

content changed for some alerts

9e1e0ba

for premium lik

Update tidb-cloud-release-notes.md

3eacec0

lilin90 approved these changes Oct 23, 2026

View reviewed changes

ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 23, 2026

lilin90 added the lgtm label Oct 23, 2026

ti-chi-bot Bot added the approved label Oct 23, 2026

ti-chi-bot Bot merged commit 6fa2484 into pingcap:release-8.5 Oct 23, 2026
12 checks passed

Navigation Menu

Repository navigation

byoc: support vCPU limit alerts - #24521

byoc: support vCPU limit alerts#24521
ti-chi-bot[bot] merged 7 commits into
pingcap:release-8.5from
wildpcww:byocvcpualert

wildpcww commented Oct 21, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Oct 21, 2026 •

edited

Loading

Reviews paused

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot Bot commented Oct 23, 2026

Uh oh!

lilin90 commented Oct 23, 2026

Uh oh!

ti-chi-bot Bot commented Oct 23, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

wildpcww commented Oct 21, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added, or deleted? (Required)

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

Uh oh!

coderabbitai Bot commented Oct 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot Bot commented Oct 23, 2026

[LGTM Timeline notifier]

Uh oh!

lilin90 commented Oct 23, 2026

Uh oh!

ti-chi-bot Bot commented Oct 23, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

wildpcww commented Oct 21, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Oct 21, 2026 •

edited

Loading