Create monitor-alert-lark - #23487
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
missing-translation-status
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis 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. ChangesLark Alert Subscription Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 liftAdd the Monitor Alert Lark documentation content before merge.
tidb-cloud/monitor-alert-larkcontains 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
📒 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.
ti-chi-bot
Bot
added
size/L
There was a problem hiding this comment.
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
📒 Files selected for processing (5)
TOC-tidb-cloud-essential.mdTOC-tidb-cloud-premium.mdTOC-tidb-cloud.mdtidb-cloud/connected-care-detail.mdtidb-cloud/monitor-alert-lark.md
|
|
||
| # Subscribe via Lark | ||
|
|
||
| TiDB Cloud provides you with an easy way to subscribe to alert notifications via Lark, [email](/tidb-cloud/monitor-alert-email.md), [Slack](/tidb-cloud/monitor-alert-slack.md), [Zoom](/tidb-cloud/monitor-alert-zoom.md), [Flashduty](/tidb-cloud/monitor-alert-flashduty.md), [PagerDuty](/tidb-cloud/monitor-alert-pagerduty.md), and [Webhook](/tidb-cloud/monitor-alert-webhook.md). This document describes how to subscribe to alert notifications via Lark. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
Propagate the Lark link to the remaining alert-channel indexes.
The new Lark guide is present in the plan TOCs and Connected Care details, but two existing entry points still expose incomplete channel lists.
tidb-cloud/monitor-alert-lark.md#L8-L8: Add the Lark guide to the channel list intidb-cloud/monitor-built-in-alerting.md#L64-L72.tidb-cloud/connected-care-detail.md#L87-L88: Add Lark to the Connected Care feature links intidb-cloud/connected-care-overview.md#L56-L58.
📍 Affects 2 files
tidb-cloud/monitor-alert-lark.md#L8-L8(this comment)tidb-cloud/connected-care-detail.md#L87-L88
| - The subscribing via Lark feature is only available for organizations that subscribe to the **Enterprise** or **Premium** support plan. | ||
|
|
||
| - You need a Lark webhook URL from the Lark group where you want to receive alert notifications on. Currently, TiDB Cloud does not support customizing the request headers or the payload format. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Clarify the Lark prerequisite wording.
The current text uses “The subscribing via Lark feature” and “receive alert notifications on.” Use direct wording and “in the Lark group.”
Apply this wording change
-- The subscribing via Lark feature is only available for organizations that subscribe to the **Enterprise** or **Premium** support plan.
+- Subscribing via Lark is only available to organizations with the **Enterprise** or **Premium** support plan.
-- You need a Lark webhook URL from the Lark group where you want to receive alert notifications on. Currently, TiDB Cloud does not support customizing the request headers or the payload format.
+- You need a Lark webhook URL from the Lark group where you want to receive alert notifications. Currently, TiDB Cloud does not support customizing request headers or the payload format.As per path instructions, act as a senior technical writer with deep database expertise when reviewing the documentation.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - The subscribing via Lark feature is only available for organizations that subscribe to the **Enterprise** or **Premium** support plan. | |
| - You need a Lark webhook URL from the Lark group where you want to receive alert notifications on. Currently, TiDB Cloud does not support customizing the request headers or the payload format. | |
| - Subscribing via Lark is only available to organizations with the **Enterprise** or **Premium** support plan. | |
| - You need a Lark webhook URL from the Lark group where you want to receive alert notifications. Currently, TiDB Cloud does not support customizing request headers or the payload format. |
Source: Path instructions
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
tidb-cloud/monitor-alert-lark.md
| <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. | ||
|
|
||
| </CustomContent> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Correct the Essential access prerequisite.
Line [34] adds Instance Manager access and scopes Project Owner to the target instance. The analogous alert guide, tidb-cloud/monitor-alert-flashduty.md (Lines 8-28), documents Essential access as Organization Owner or Project Owner for the target project. Align this block with that existing contract.
Apply the prerequisite correction
- 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.
+ To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud.As per coding guidelines, keep the edit minimal and limited to the requested task. As per path instructions, make feedback specific and tied to the changed content.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <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. | |
| </CustomContent> | |
| <CustomContent plan="essential"> | |
| - To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud. | |
| </CustomContent> |
🧰 Tools
🪛 LanguageTool
[style] ~34-~34: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t> - To subscribe to alert notifications of TiD...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Sources: Coding guidelines, Path instructions
1 participant
First-time contributors' checklist
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)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit