From eedf42d14e5bd37253b4714fc1729af0cc68907a Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 19:38:19 +0800 Subject: [PATCH 01/11] Create built-in-monitoring-premium --- tidb-cloud/premium/built-in-monitoring-premium | 1 + 1 file changed, 1 insertion(+) create mode 100644 tidb-cloud/premium/built-in-monitoring-premium diff --git a/tidb-cloud/premium/built-in-monitoring-premium b/tidb-cloud/premium/built-in-monitoring-premium new file mode 100644 index 0000000000000..8b137891791fe --- /dev/null +++ b/tidb-cloud/premium/built-in-monitoring-premium @@ -0,0 +1 @@ + From 72cd15d0f0006adde4cc75555ecdcbdf973b1efc Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 20:10:30 +0800 Subject: [PATCH 02/11] Update and rename built-in-monitoring-premium to monitor-alert-email-premium.md --- .../premium/built-in-monitoring-premium | 1 - .../premium/monitor-alert-email-premium.md | 62 +++++++++++++++++++ 2 files changed, 62 insertions(+), 1 deletion(-) delete mode 100644 tidb-cloud/premium/built-in-monitoring-premium create mode 100644 tidb-cloud/premium/monitor-alert-email-premium.md diff --git a/tidb-cloud/premium/built-in-monitoring-premium b/tidb-cloud/premium/built-in-monitoring-premium deleted file mode 100644 index 8b137891791fe..0000000000000 --- a/tidb-cloud/premium/built-in-monitoring-premium +++ /dev/null @@ -1 +0,0 @@ - diff --git a/tidb-cloud/premium/monitor-alert-email-premium.md b/tidb-cloud/premium/monitor-alert-email-premium.md new file mode 100644 index 0000000000000..feccb617f42e4 --- /dev/null +++ b/tidb-cloud/premium/monitor-alert-email-premium.md @@ -0,0 +1,62 @@ +--- +title: Subscribe via Email +summary: Learn how to monitor your TiDB cluster by getting alert notifications via Email. +--- + +# Subscribe via Email + +TiDB Cloud provides you with an easy way to subscribe to alert notifications via email, [Slack](/tidb-cloud/monitor-alert-slack.md), [Zoom](/tidb-cloud/monitor-alert-zoom.md), [Flashduty](/tidb-cloud/monitor-alert-flashduty.md), and [PagerDuty](/tidb-cloud/monitor-alert-pagerduty.md). This document describes how to subscribe to alert notifications via email. + +> **Note:** +> +> Currently, alert subscription is available for [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. + +## Prerequisites + + + +- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target Premium instance in TiDB Cloud. + + + +## Subscribe to alert notifications + +To receive alert notifications, take the following steps. The steps vary by cluster plan. + + + +> **Tip:** +> +> The alert subscription is for all alerts in the current instance. If you have multiple instances, you need to subscribe to each instance individually. + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target Premium Instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner. +4. Select **Email** from the **Subscriber Type** drop-down list. +5. Enter your email address. +6. Click **Test Connection**. + + - If the test succeeds, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and then retry the connection. + +7. Click **Save** to complete the subscription. + + + +Alternatively, you can also click **Subscribe** in the upper-right corner of the [**Alert**](/tidb-cloud/monitor-built-in-alerting.md#view-alerts) page of the instance. You will be directed to the **Alert Subscription** page. + +If an alert condition remains unchanged, the alert sends email notifications every three hours. + +## Unsubscribe from alert notifications + +If you no longer want to receive alert notifications, please take the following steps. The steps vary by cluster plan. + + + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, locate the row of your target subscriber to be deleted, and then click **...** > **Unsubscribe**. +4. Click **Unsubscribe** to confirm the unsubscription. + + + From 2be54db82c0bed92246d09b42f2a2333301878e1 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 20:26:11 +0800 Subject: [PATCH 03/11] Create monitor-built-in-alerting-premium.md --- .../monitor-built-in-alerting-premium.md | 85 +++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 tidb-cloud/premium/monitor-built-in-alerting-premium.md diff --git a/tidb-cloud/premium/monitor-built-in-alerting-premium.md b/tidb-cloud/premium/monitor-built-in-alerting-premium.md new file mode 100644 index 0000000000000..24173740d6ff0 --- /dev/null +++ b/tidb-cloud/premium/monitor-built-in-alerting-premium.md @@ -0,0 +1,85 @@ +--- +title: TiDB Cloud Built-in Alerting +summary: Learn how to monitor your TiDB cluster by getting alert notifications from TiDB Cloud. +--- + +# TiDB Cloud Built-in Alerting + +TiDB Cloud provides you with an easy way to view alerts, edit alert rules, and subscribe to alert notifications. + +This document describes how to do these operations and provides the TiDB Cloud built-in alert conditions for your reference. + +> **Note:** +> +> Currently, alert subscription is available for [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. + +## View alerts + +In TiDB Cloud, you can view both active and closed alerts on the **Alerts** page. + +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + + > **Tip:** + > + > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters/instances. + +2. Click the name of the target cluster/instance. The cluster/instance overview page is displayed. +3. Click **Alerts** in the left navigation pane. +4. The **Alerts** page displays the active alerts by default. You can view the information of each active alert such as the alert name, trigger time, and duration. +5. If you also want to view the closed alerts, just click the **Status** drop-down list and select **Closed** or **All**. + +## Edit alert rules + +In TiDB Cloud, you can edit the alert rules by disabling or enabling the alerts or updating the alert threshold. + +1. On the **Alerts** page, click **Edit Rules**. +2. Disable or enable alert rules as needed. +3. Click **Edit** to update the threshold of an alert rule. + + > **Tip:** + > + > Currently, TiDB Cloud provides limited capabilities for alert rule editing. Some alert rules do not support editing. If you would like to configure different trigger conditions or frequency, or have alerts automatically trigger actions in downstream services like [PagerDuty](https://www.pagerduty.com/docs/guides/datadog-integration-guide/), consider using a [third-party monitoring and alerting integration](/tidb-cloud/third-party-monitoring-integrations.md). + +## Subscribe to alert notifications + +In TiDB Cloud, you can subscribe to alert notifications via one of the following methods: + +- [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) + +## TiDB Cloud built-in alert conditions + +The following table provides the TiDB Cloud built-in alert conditions and the corresponding recommended actions. + +> **Note:** +> +> - While these alert conditions do not necessarily mean there is a problem, they are often early warning indicators of emerging issues. Therefore, taking the recommended action is advised. +> - You can edit the thresholds of the alerts on the TiDB Cloud console. +> - Some alert rules are disabled by default. You can enable them as needed. + +TiDB Cloud provides different alert rules for each cluster plan, based on the features available in that plan. + + + +### Performance overview alerts + +| Condition | Recommended Action | +|:--- |:--- | +| Request units per second (RU/s) exceed 80% of the maximum RCU |
  1. Review RU metrics to determine whether the increase is gradual or a sudden spike.
  2. If the increase is gradual, check whether query duration has increased. If so, the current maximum RCU might be insufficient.
  3. Scale capacity by manually increasing the maximum RCU in the TiDB Cloud console.

If you cannot resolve the issue, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).| +| QPS drops by 80% |
  1. Check whether the drop is caused by increasing query latency.
  2. Verify that your application is operating normally. If the drop is intentional, ignore this alert. If the drop is unintentional and you cannot identify the root cause, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) immediately.
| +| Query P99 latency exceeds 200 ms |
  1. Investigate slow queries: go to the Slow Query page and filter by a recent time range to identify newly introduced or slower-running queries.
  2. Review recent changes, such as application deployments, schema changes, or data import jobs, that might have affected traffic patterns.

If you cannot identify the root cause, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) immediately.| +| Query P95 latency exceeds 200 ms |
  1. Investigate slow queries: go to the Slow Query page and filter by a recent time range to identify newly introduced or slower-running queries.
  2. Review recent changes, such as application deployments, schema changes, or data import jobs, that might have affected traffic patterns.

If you cannot identify the root cause, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) immediately.| +| Request error rate exceeds 10% | Review recent errors and the overall statement execution status for the cluster.| + +### Changefeed alerts for {{{ .premium }}} + +| Condition | Recommended Action | +|:--------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| The changefeed latency exceeds 600 seconds. | Check the changefeed status on the **Changefeed** page and **Changefeed Detail** page of the TiDB Cloud console, where you can find some error messages to help diagnose this issue.
Possible reasons that can trigger this alert include:If the problem cannot be fixed from your side, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) for further assistance. | +| The changefeed status is `FAILED`. | Check the changefeed status on the **Changefeed** page and **Changefeed Detail** page of the TiDB Cloud console, where you can find some error messages to help diagnose this issue.
If the problem cannot be fixed from your side, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) for further assistance.| +| The changefeed status is `WARNING`. | Check the changefeed status on the **Changefeed** page and **Changefeed Detail** page of the TiDB Cloud console, where you can find some error messages to help diagnose this issue.
If the problem cannot be fixed from your side, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) for further assistance.| + + From f2fae47e980320f900a050314cb9f392da3546f3 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:07:27 +0800 Subject: [PATCH 04/11] Update monitor-alert-email-premium.md --- tidb-cloud/premium/monitor-alert-email-premium.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/premium/monitor-alert-email-premium.md b/tidb-cloud/premium/monitor-alert-email-premium.md index feccb617f42e4..975f77c39b640 100644 --- a/tidb-cloud/premium/monitor-alert-email-premium.md +++ b/tidb-cloud/premium/monitor-alert-email-premium.md @@ -13,7 +13,7 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via ## Prerequisites - + - To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target Premium instance in TiDB Cloud. From f60dbcf35a189831fbd5c3e7344e66d6ff321e96 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:12:40 +0800 Subject: [PATCH 05/11] Create monitor-alert-flashduty-premium.md --- .../monitor-alert-flashduty-premium.md | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 tidb-cloud/premium/monitor-alert-flashduty-premium.md diff --git a/tidb-cloud/premium/monitor-alert-flashduty-premium.md b/tidb-cloud/premium/monitor-alert-flashduty-premium.md new file mode 100644 index 0000000000000..6f94ac5109433 --- /dev/null +++ b/tidb-cloud/premium/monitor-alert-flashduty-premium.md @@ -0,0 +1,72 @@ +--- +title: Subscribe via Flashduty +summary: Learn how to monitor your TiDB cluster by getting alert notifications via Flashduty. +--- + +# Subscribe via Flashduty + +TiDB Cloud provides you with an easy way to subscribe to alert notifications via Flashduty, [Slack](/tidb-cloud/monitor-alert-slack.md), [email](/tidb-cloud/monitor-alert-email.md), [Zoom](/tidb-cloud/monitor-alert-zoom.md), and [PagerDuty](/tidb-cloud/monitor-alert-pagerduty.md). This document describes how to subscribe to alert notifications via Flashduty. + +> **Note:** +> +> Currently, alert subscription is available for [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. + +## Prerequisites + +- The subscribing via Flashduty feature is only available for organizations that subscribe to the **Enterprise** or **Premium** [support plan](/tidb-cloud/connected-care-overview.md). + + + +- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target Premium instance in TiDB Cloud. + + + +## Subscribe to alert notifications + +To receive alert notifications of clusters/instances, take the following steps: + +### Step 1. Generate a Flashduty webhook URL + +1. Generate a webhook URL by following the instructions in [Flashduty Prometheus Integration](https://docs.flashcat.cloud/en/flashduty/prometheus-integration-guide). +2. Save the generated webhook URL to use in the next step. + +### Step 2. Subscribe from TiDB Cloud + +Alert notification subscriptions vary by cluster plan. + + + +> **Tip:** +> +> The alert subscription is for all alerts in the current instance. If you have multiple instances, you need to subscribe to each instance individually. + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner. +4. Select **Flashduty** from the **Subscriber Type** drop-down list. +5. Enter a name in the **Name** field and your Flashduty webhook URL in the **Webhook URL** field. +6. Click **Test Connection**. + + - If the test succeeds, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and retry the connection. + +7. Click **Save** to complete the subscription. + + + +Alternatively, you can also click **Subscribe** in the upper-right corner of the **Alert** page of the cluster/instance. You will be directed to the **Alert Subscription** page. + +If an alert condition remains unchanged, the alert sends notifications every three hours. + +## Unsubscribe from alert notifications + +If you no longer want to receive alert notifications, take the following steps. The steps vary by cluster plan. + + + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, locate the row of your target subscriber to be deleted, and then click **...** > **Unsubscribe**. +4. Click **Unsubscribe** to confirm the unsubscription. + + From 99ae655add405de2105ee5e0f177803bb8b8994a Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:29:19 +0800 Subject: [PATCH 06/11] Create monitor-alert-slack-premium --- .../premium/monitor-alert-slack-premium | 75 +++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 tidb-cloud/premium/monitor-alert-slack-premium diff --git a/tidb-cloud/premium/monitor-alert-slack-premium b/tidb-cloud/premium/monitor-alert-slack-premium new file mode 100644 index 0000000000000..95b61d711a147 --- /dev/null +++ b/tidb-cloud/premium/monitor-alert-slack-premium @@ -0,0 +1,75 @@ +--- +title: Subscribe via Slack +summary: Learn how to monitor your TiDB cluster by getting alert notifications via Slack. +--- + +# Subscribe via Slack + +TiDB Cloud provides you with an easy way to subscribe to alert notifications via Slack, [email](/tidb-cloud/monitor-alert-email.md), [Zoom](/tidb-cloud/monitor-alert-zoom.md), [Flashduty](/tidb-cloud/monitor-alert-flashduty.md), and [PagerDuty](/tidb-cloud/monitor-alert-pagerduty.md). This document describes how to subscribe to alert notifications via Slack. + +> **Note:** +> +> Currently, alert subscription is available for [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. + +## Prerequisites + +- The subscribing via Slack feature is only available for organizations that subscribe to the **Enterprise** or **Premium** support plan. + + + +- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target Premium instance in TiDB Cloud. + + + +## Subscribe to alert notifications + +### Step 1. Generate a Slack webhook URL + +1. [Create a Slack app](https://api.slack.com/apps/new), if you do not have one already. Click **Create New App**, and choose **From scratch**. Enter a name, choose a workspace to associate your app with, and then click **Create App**. +2. Go to the settings page for your app. You can load its settings via your [app's management dashboard](https://api.slack.com/apps). +3. Click the **Incoming Webhooks** tab, and then toggle **Activate Incoming Webhooks** to **ON**. +4. Click **Add New Webhook to Workspace**. +5. Select a channel that you want to receive alert notifications in, and then select **Authorize**. If you need to add the incoming webhook to a private channel, you must first be in that channel. + +You can see a new entry under the **Webhook URLs for Your Workspace** section in the following format: `https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`. + +### Step 2. Subscribe from TiDB Cloud + +Alert notification subscriptions vary by cluster plan. + + + +> **Tip:** +> +> The alert subscription is for all alerts in the current instance. If you have multiple instances, you need to subscribe to each instance individually. + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner. +4. Select **Slack** from the **Subscriber Type** drop-down list. +5. Enter a name in the **Name** field and your Slack webhook URL in the **URL** field. +6. Click **Test Connection**. + + - If the test succeeds, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and retry the connection. + +7. Click **Save** to complete the subscription. + + + +Alternatively, you can also click **Subscribe** in the upper-right corner of the **Alert** page of the cluster. You will be directed to the **Alert Subscription** page. + +If an alert condition remains unchanged, the alert sends notifications every three hours. + +## Unsubscribe from alert notifications + +If you no longer want to receive alert notifications, take the following steps. The steps vary by cluster plan. + + + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, locate the row of your target subscriber to be deleted, and then click **...** > **Unsubscribe**. +4. Click **Unsubscribe** to confirm the unsubscription. + + From 401005e9d3176fff24257663ab22eae48f6262c0 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:33:49 +0800 Subject: [PATCH 07/11] Create monitor-alert-pagerduty-premium --- .../premium/monitor-alert-pagerduty-premium | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 tidb-cloud/premium/monitor-alert-pagerduty-premium diff --git a/tidb-cloud/premium/monitor-alert-pagerduty-premium b/tidb-cloud/premium/monitor-alert-pagerduty-premium new file mode 100644 index 0000000000000..ab73ca6c39e05 --- /dev/null +++ b/tidb-cloud/premium/monitor-alert-pagerduty-premium @@ -0,0 +1,72 @@ +--- +title: Subscribe via PagerDuty +summary: Learn how to monitor your TiDB cluster by getting alert notifications via PagerDuty. +--- + +# Subscribe via PagerDuty + +TiDB Cloud provides you with an easy way to subscribe to alert notifications via PagerDuty, [Slack](/tidb-cloud/monitor-alert-slack.md), [email](/tidb-cloud/monitor-alert-email.md), [Zoom](/tidb-cloud/monitor-alert-zoom.md), and [Flashduty](/tidb-cloud/monitor-alert-flashduty.md). This document describes how to subscribe to alert notifications via PagerDuty. + +> **Note:** +> +> Currently, alert subscription is available for [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. + +## Prerequisites + +- The subscribing via PagerDuty feature is only available for organizations that subscribe to the **Enterprise** or **Premium** [support plan](/tidb-cloud/connected-care-overview.md). + + + +- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target Premium instance in TiDB Cloud. + + + +## Subscribe to alert notifications + +To receive alert notifications, take the following steps: + +### Step 1. Generate a PagerDuty integration key + +1. Generate an integration key of type **Events API v2** by following the instructions in the [PagerDuty Events API v2 Overview](https://developer.pagerduty.com/docs/events-api-v2-overview#getting-started). +2. Save the generated integration key to use in the next step. + +### Step 2. Subscribe from TiDB Cloud + +Alert notification subscriptions vary by cluster plan. + + + +> **Tip:** +> +> The alert subscription is for all alerts in the current instance. If you have multiple instances, you need to subscribe to each instance individually. + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner. +4. Select **PagerDuty** from the **Subscriber Type** drop-down list. +5. Enter a name in the **Name** field and your PagerDuty integration key in the **Integration Key** field. +6. Click **Test Connection**. + + - If the test succeeds, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and retry the connection. + +7. Click **Save** to complete the subscription. + + + +Alternatively, you can also click **Subscribe** in the upper-right corner of the **Alert** page of the cluster. You will be directed to the **Alert Subscription** page. + +If an alert condition remains unchanged, the alert sends notifications every three hours. + +## Unsubscribe from alert notifications + +If you no longer want to receive alert notifications, take the following steps. The steps vary by cluster plan. + + + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, locate the row of your target subscriber to be deleted, and then click **...** > **Unsubscribe**. +4. Click **Unsubscribe** to confirm the unsubscription. + + From 3458db2c1e81cf2965e64f4880637526c940c1e9 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:38:12 +0800 Subject: [PATCH 08/11] Create monitor-alert-zoom-premium --- tidb-cloud/premium/monitor-alert-zoom-premium | 89 +++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 tidb-cloud/premium/monitor-alert-zoom-premium diff --git a/tidb-cloud/premium/monitor-alert-zoom-premium b/tidb-cloud/premium/monitor-alert-zoom-premium new file mode 100644 index 0000000000000..6372c151beee9 --- /dev/null +++ b/tidb-cloud/premium/monitor-alert-zoom-premium @@ -0,0 +1,89 @@ +--- +title: Subscribe via Zoom +summary: Learn how to monitor your TiDB cluster by getting alert notifications via Zoom. +--- + +# Subscribe via Zoom + +TiDB Cloud provides you with an easy way to subscribe to alert notifications via Zoom, [Slack](/tidb-cloud/monitor-alert-slack.md), [email](/tidb-cloud/monitor-alert-email.md), [Flashduty](/tidb-cloud/monitor-alert-flashduty.md), and [PagerDuty](/tidb-cloud/monitor-alert-pagerduty.md). This document describes how to subscribe to alert notifications via Zoom. + +> **Note:** +> +> Currently, alert subscription is available for [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. + +## Prerequisites + +- The subscribing via Zoom feature is only available for organizations that subscribe to the **Enterprise** or **Premium** support plan. + +- To add and configure the Incoming Webhook Chatbot in Zoom, you need to have admin permissions on your Zoom account. + + + +- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target Premium instance in TiDB Cloud. + + + +## Subscribe to alert notifications + +### Step 1. Add the Zoom Incoming Webhook app + +1. Sign in to the [Zoom App Marketplace](https://marketplace.zoom.us/) as the account administrator. +2. Go to the [Incoming Webhook App](https://marketplace.zoom.us/apps/eH_dLuquRd-VYcOsNGy-hQ) page in the Zoom App Marketplace, and then click **Add** to add this app. If the app is not pre-approved, contact your Zoom admin to approve this app for your account. For more information, see [Approving apps and managing app requests](https://support.zoom.us/hc/en-us/articles/360027829671). +3. Confirm the permissions the app requires, then click **Authorize** to add the Incoming Webhook app. + +### Step 2. Generate a Zoom webhook URL + +1. Sign in to the Zoom desktop client. +2. Click the **Team Chat** tab. +3. Under **Apps**, find and select **Incoming Webhook**, or select a chat channel from above that you would like to receive messages in. +4. Enter the following command to make a new connection. You need to replace `${connectionName}` with your desired connection name, for example, `tidbcloud-alerts`: + + ```shell + /inc connect ${connectionName} + ``` + +5. The command will return the following details: + + - **Endpoint**. It will provide a webhook URL in the format: `https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX`. + - **Verification Token** + +### Step 3. Subscribe from TiDB Cloud + +Alert notification subscriptions vary by cluster plan. + + + +> **Tip:** +> +> The alert subscription is for all alerts in the current instance. If you have multiple instances, you need to subscribe to each instance individually. + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner. +4. Select **Zoom** from the **Subscriber Type** drop-down list. +5. Enter a name in the **Name** field, your Zoom webhook URL in the **URL** field, and the verification token in the **Token** field. +6. Click **Test Connection**. + + - If the test succeeds, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and retry the connection. + +7. Click **Save** to complete the subscription. + + + +Alternatively, you can also click **Subscribe** in the upper-right corner of the **Alert** page of the cluster. You will be directed to the **Alert Subscription** page. + +If an alert condition remains unchanged, the alert sends notifications every three hours. + +## Unsubscribe from alert notifications + +If you no longer want to receive alert notifications, take the following steps. The steps vary by cluster plan. + + + +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target instance using the combo box in the upper-left corner. +2. In the left navigation pane, click **Settings** > **Alert Subscription**. +3. On the **Alert Subscription** page, locate the row of your target subscriber to be deleted, and then click **...** > **Unsubscribe**. +4. Click **Unsubscribe** to confirm the unsubscription. + + From a8c8c6c2724b547ea58c7a101c5ce11479099030 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:39:03 +0800 Subject: [PATCH 09/11] Rename monitor-alert-pagerduty-premium to monitor-alert-pagerduty-premium.md --- ...alert-pagerduty-premium => monitor-alert-pagerduty-premium.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename tidb-cloud/premium/{monitor-alert-pagerduty-premium => monitor-alert-pagerduty-premium.md} (100%) diff --git a/tidb-cloud/premium/monitor-alert-pagerduty-premium b/tidb-cloud/premium/monitor-alert-pagerduty-premium.md similarity index 100% rename from tidb-cloud/premium/monitor-alert-pagerduty-premium rename to tidb-cloud/premium/monitor-alert-pagerduty-premium.md From 0011b2142aa116d95f387aae2cdb1843c82e3416 Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:39:27 +0800 Subject: [PATCH 10/11] Rename monitor-alert-slack-premium to monitor-alert-slack-premium.md --- ...monitor-alert-slack-premium => monitor-alert-slack-premium.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename tidb-cloud/premium/{monitor-alert-slack-premium => monitor-alert-slack-premium.md} (100%) diff --git a/tidb-cloud/premium/monitor-alert-slack-premium b/tidb-cloud/premium/monitor-alert-slack-premium.md similarity index 100% rename from tidb-cloud/premium/monitor-alert-slack-premium rename to tidb-cloud/premium/monitor-alert-slack-premium.md From 4b077a5fd62b467c3a5127c55ff88e4e44cbc64e Mon Sep 17 00:00:00 2001 From: huoyao1125 <90880576+huoyao1125@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:39:51 +0800 Subject: [PATCH 11/11] Rename monitor-alert-zoom-premium to monitor-alert-zoom-premium.md --- .../{monitor-alert-zoom-premium => monitor-alert-zoom-premium.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename tidb-cloud/premium/{monitor-alert-zoom-premium => monitor-alert-zoom-premium.md} (100%) diff --git a/tidb-cloud/premium/monitor-alert-zoom-premium b/tidb-cloud/premium/monitor-alert-zoom-premium.md similarity index 100% rename from tidb-cloud/premium/monitor-alert-zoom-premium rename to tidb-cloud/premium/monitor-alert-zoom-premium.md