cloud: add subscribing alert via Lark by huoyao1125 · Pull Request #23487 · pingcap/docs

huoyao1125 · 2026-08-10T13:44:59Z

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)?

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

Documentation
- Added guidance for subscribing to and unsubscribing from TiDB Cloud alert notifications through Lark.
- Documented supported plans, prerequisites, webhook requirements, permissions, setup procedures, testing, notification frequency, and troubleshooting.
- Updated Connected Care service details to list Lark as an alert subscription channel for Enterprise and Premium plans.
- Added links to the new Lark alert documentation throughout relevant table-of-contents pages.

coderabbitai · 2026-08-10T13:45:44Z

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.

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

📝 Walkthrough

Walkthrough

This change adds a Lark alert subscription guide, documents Lark support for applicable Connected Care plans, and links the guide from TiDB Cloud table-of-contents pages.

Changes

Lark Alert Subscription Documentation

Layer / File(s)	Summary
Lark alert guide and plan support `tidb-cloud/monitor-alert-lark.md`, `tidb-cloud/connected-care-detail.md`	Adds Lark subscription and unsubscription procedures, prerequisites, webhook requirements, permissions, connection-test handling, notification frequency, and plan support details.
Lark alert navigation `TOC-tidb-cloud*.md`	Adds links to the Lark alert subscription guide in the main, Essential, Premium, and Connected Care table-of-contents sections.

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

Possibly related PRs

pingcap/docs#23432: Documents related TiDB Cloud alert subscription capabilities on different documentation pages.

Suggested labels: area/tidb-cloud

Suggested reviewers: lilin90

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description keeps the template and selects v8.5, but it leaves the required change summary and reference links blank.	Add a concise summary of the Lark alert subscription documentation changes and provide relevant reference links.

✅ Passed checks (4 passed)

Check name	Status	Explanation
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.
Title check	✅ Passed	The title clearly identifies the main change: adding Lark alert subscription documentation.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch huoyao1125-patch-5

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

tidb-cloud/monitor-alert-lark (1)

1-2: 🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift

Add the Monitor Alert Lark documentation content before merge.

tidb-cloud/monitor-alert-lark contains only blank lines. The new documentation page cannot provide Monitor Alert Lark information for the TiDB 8.5 release branch.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 47a63681-67e6-4fc7-9687-1acfe27b3807

📥 Commits

Reviewing files that changed from the base of the PR and between 84444c6 and 3b852bc.

📒 Files selected for processing (1)

tidb-cloud/monitor-alert-lark

Adds the Subscribe via Lark alert notification guide, mirroring monitor-alert-webhook.md with Lark-specific configuration, and registers it alongside the other subscription channels in the TOC and Connected Care detail page.

coderabbitai

Actionable comments posted: 2

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4cd23265-0c04-49ef-94b7-ac9f72e0de16

📥 Commits

Reviewing files that changed from the base of the PR and between 3b852bc and 6a8c105.

📒 Files selected for processing (5)

TOC-tidb-cloud-essential.md
TOC-tidb-cloud-premium.md
TOC-tidb-cloud.md
tidb-cloud/connected-care-detail.md
tidb-cloud/monitor-alert-lark.md

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 13ee7a11-bfb5-4fd7-8a3e-7640024ea3b7

📥 Commits

Reviewing files that changed from the base of the PR and between 6a8c105 and 4a5ec3d.

📒 Files selected for processing (1)

tidb-cloud/monitor-alert-lark.md

ti-chi-bot · 2026-08-11T03:28:29Z

[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 ask for approval from lilin90. 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:

OWNERS

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

lilin90 · 2026-08-11T03:41:47Z

+
+<CustomContent plan="essential">
+
+- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` or `Instance Manager` access to the target instance in TiDB Cloud.


In Subscribe via Flashduty | TiDB Docs, the required access is "Organization Owner access to your organization or Project Owner access to the target project". Please double check whether the descriptions should be updated to keep the two consistent.

Co-authored-by: Lilian Lee <lilin@pingcap.com>

Create monitor-alert-lark

3b852bc

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 Aug 10, 2026

coderabbitai Bot reviewed Aug 10, 2026

View reviewed changes

cloud: create monitor-alert-lark.md

6a8c105

Adds the Subscribe via Lark alert notification guide, mirroring monitor-alert-webhook.md with Lark-specific configuration, and registers it alongside the other subscription channels in the TOC and Connected Care detail page.

ti-chi-bot Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 10, 2026

coderabbitai Bot reviewed Aug 10, 2026

View reviewed changes

Comment thread tidb-cloud/monitor-alert-lark.md

Comment thread tidb-cloud/monitor-alert-lark.md Outdated

Update monitor-alert-lark.md

4a5ec3d

coderabbitai Bot reviewed Aug 10, 2026

View reviewed changes

Comment thread tidb-cloud/monitor-alert-lark.md

Update monitor-alert-lark.md

b529181

lilin90 self-assigned this Aug 11, 2026

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

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

lilin90 changed the title ~~Create monitor-alert-lark~~ cloud: add subscribing alert via Lark Aug 11, 2026

Add new topics to more related pages

68a0365

lilin90 reviewed Aug 11, 2026

View reviewed changes

Apply suggestion from @lilin90

763ea80

Co-authored-by: Lilian Lee <lilin@pingcap.com>

Navigation Menu

Uh oh!

cloud: add subscribing alert via Lark - #23487

cloud: add subscribing alert via Lark#23487
huoyao1125 wants to merge 6 commits into
release-8.5from
huoyao1125-patch-5

huoyao1125 commented Aug 10, 2026 •

edited by lilin90

Loading

Uh oh!

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

Reviews paused

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

ti-chi-bot Bot commented Aug 11, 2026

Uh oh!

Uh oh!

lilin90 Aug 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		<CustomContent plan="essential">

		- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` or `Instance Manager` access to the target instance in TiDB Cloud.

Uh oh!

Conversation

huoyao1125 commented Aug 10, 2026 • edited by lilin90 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 Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ti-chi-bot Bot commented Aug 11, 2026

Uh oh!

Uh oh!

lilin90 Aug 11, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

huoyao1125 commented Aug 10, 2026 •

edited by lilin90

Loading

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading