From 1292d23b0ac71808da11dd7b55d393a4e9bea946 Mon Sep 17 00:00:00 2001 From: SiyuChen Date: Wed, 20 Nov 2024 15:05:34 +0800 Subject: [PATCH 1/6] cloud: update alert subscriber Signed-off-by: SiyuChen --- TOC-tidb-cloud.md | 4 ++ tidb-cloud/monitor-alert-email.md | 58 +++++++++++++++++ tidb-cloud/monitor-alert-slack.md | 69 ++++++++++++++++++++ tidb-cloud/monitor-alert-zoom.md | 85 +++++++++++++++++++++++++ tidb-cloud/monitor-built-in-alerting.md | 36 ++--------- 5 files changed, 223 insertions(+), 29 deletions(-) create mode 100644 tidb-cloud/monitor-alert-email.md create mode 100644 tidb-cloud/monitor-alert-slack.md create mode 100644 tidb-cloud/monitor-alert-zoom.md diff --git a/TOC-tidb-cloud.md b/TOC-tidb-cloud.md index d26249300f927..786fcf99e3a9e 100644 --- a/TOC-tidb-cloud.md +++ b/TOC-tidb-cloud.md @@ -157,6 +157,10 @@ - [Overview](/tidb-cloud/monitor-tidb-cluster.md) - [Built-in Metrics](/tidb-cloud/built-in-monitoring.md) - [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md) + - Subscribe To Alert Notification + - [Subscribe via Email](/tidb-cloud/monitor-alert-email.md) + - [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md) + - [Subscribe via Zoom](/tidb-cloud/monitor-alert-zoom.md) - [Cluster Events](/tidb-cloud/tidb-cloud-events.md) - [Third-Party Metrics Integrations (Beta)](/tidb-cloud/third-party-monitoring-integrations.md) - Tune Performance diff --git a/tidb-cloud/monitor-alert-email.md b/tidb-cloud/monitor-alert-email.md new file mode 100644 index 0000000000000..6050dbf07eccd --- /dev/null +++ b/tidb-cloud/monitor-alert-email.md @@ -0,0 +1,58 @@ +--- +title: Subscribe via Email +summary: Learn how to monitor your TiDB cluster by getting alert notification via Email. +--- + +# Subscribe via Email + +TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Email. + +## Prerequisites + +- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud. + +## Subscribe to alert notifications + +> **Tip:** +> +> The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once. + +To get alert notifications of clusters in your project, take the following steps: + +1. On the **Alerts** page , click **Subscribe Alerts**. +2. Select **Email** from the **Subscriber Type** drop-down list. +3. Enter your email address. +4. Click **Test Connection** button. + + - If the test successes, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. + +5. Click **Save** button to complete the subscription. + +Alternatively, you can also add the subscription from the **Alert Subscription** page as follows: + +1. Log in to the [TiDB Cloud console](https://tidbcloud.com). +2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +4. Click **Add Subscriber**. +5. Select **Email** from the **Subscriber Type** drop-down list. +6. Enter your email address. +7. Click **Test Connection** button. + + - If the test successes, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. + +8. Click **Save** button to complete the subscription. + +If an alert condition remains unchanged, the alert sends email notifications every 3 hours. + +## Unsubscribe from alert notifications + +If you no longer want to receive alert notifications of clusters in your project, take the following steps: + +1. Log in to the [TiDB Cloud console](https://tidbcloud.com). +2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +4. In the row of your target subscriber to be deleted, and click **...**. +5. Click **Unsubscribe** in the drop-down menu. +5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window. \ No newline at end of file diff --git a/tidb-cloud/monitor-alert-slack.md b/tidb-cloud/monitor-alert-slack.md new file mode 100644 index 0000000000000..8845d9c7878c9 --- /dev/null +++ b/tidb-cloud/monitor-alert-slack.md @@ -0,0 +1,69 @@ +--- +title: Subscribe via Slack +summary: Learn how to monitor your TiDB cluster by getting alert notification via Slack. +--- + +# Subscribe via Slack + +TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Slack. + +## Prerequisites + +- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud. + +- To receive alert notifications via Slack, you need to have an Enterprise support plan or higher. + +## Subscribe to alert notifications + +### Step 1. Generate a Slack webhook URL + +1. [Create a Slack app](https://api.slack.com/apps/new), if you don't have one already. Click **Create New App**, and choose **From scratch**. Pick a name, choose a workspace to associate your app with, then click **Create App**. +2. Goto the settings page for your app, you can load its settings via your [app's management dashboard](https://api.slack.com/apps). +3. Select **Incoming Webhooks** tab, and toggle **Activate Incoming Webhooks** to **ON**. +4. Click **Add New Webhook to Workspace**. +5. Go ahead and pick a channel that you want to receive alert notifications in, then select **Authorize**. If you need to add the incoming webhook to a private channel, you must first be in that channel. +6. You can see a new entry under the **Webhook URLs for Your Workspace** section in the format: `https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`. + +### Step 2. Subscribe from TiDB Cloud + +> **Tip:** +> +> The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once. + +1. On the **Alerts** page , click **Subscribe Alerts**. +2. Select **Slack** from the **Subscriber Type** drop-down list. +3. Enter **Name** field and your Slack webhook URL into **URL** field. +4. Click **Test Connection** button. + + - If the test successes, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. + +5. Click **Save** button to complete the subscription. + +Alternatively, you can also add the subscription from the **Alert Subscription** page as follows: + +1. Log in to the [TiDB Cloud console](https://tidbcloud.com). +2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +4. Click **Add Subscriber**. +5. Select **Slack** from the **Subscriber Type** drop-down list. +6. Enter **Name** field and your Slack webhook URL into **URL** field. +7. Click **Test Connection** button. + + - If the test successes, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. + +8. Click **Save** button to complete the subscription. + +If an alert condition remains unchanged, the alert sends notifications every 3 hours. + +## Unsubscribe from alert notifications + +If you no longer want to receive alert notifications of clusters in your project, take the following steps: + +1. Log in to the [TiDB Cloud console](https://tidbcloud.com). +2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +4. In the row of your target subscriber to be deleted, and click **...**. +5. Click **Unsubscribe** in the drop-down menu. +5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window. \ No newline at end of file diff --git a/tidb-cloud/monitor-alert-zoom.md b/tidb-cloud/monitor-alert-zoom.md new file mode 100644 index 0000000000000..ac60f12006009 --- /dev/null +++ b/tidb-cloud/monitor-alert-zoom.md @@ -0,0 +1,85 @@ +--- +title: Subscribe via Zoom +summary: Learn how to monitor your TiDB cluster by getting alert notification via Zoom. +--- + +# Subscribe via Zoom + +TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Zoom. + +## Prerequisites + +- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud. + +- To receive alert notifications via Zoom, you need to have an Enterprise support plan or higher. + +- To add and configure the Incoming Webhook Chatbot in Zoom, you need to have admin permissions on your Zoom account. + +## Subscribe to alert notifications + +### Step 1. Add Zoom Incoming Webhook App + +1. Sign in to the [Zoom App Marketplace](https://marketplace.zoom.us/) as the account administrator. +2. Add [Incoming Webhook App](https://marketplace.zoom.us/apps/eH_dLuquRd-VYcOsNGy-hQ) from the Zoom App Marketplace, Click **Add**. If the app is not pre-approved, contact your Zoom admin to approve this app for your account. Learn more about [admin app approvals](https://support.zoom.us/hc/en-us/articles/360027829671). +3. Confirm the permissions the app requires, then click **Authorize**. The Incoming Webhook app is now added. + +### 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, please replace `` with your connection name that you want to use, for example, `tidbcloud-alerts`: + ```shell + /inc connect + ``` +5. The command will return the following details: + - **Endpoint**, this will provide a webhook URL in the format: `https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX`. + - **Verification Token** + +### Step 3. Subscribe from TiDB Cloud + +> **Tip:** +> +> The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once. + +1. On the **Alerts** page , click **Subscribe Alerts**. +2. Select **Zoom** from the **Subscriber Type** drop-down list. +3. Enter the **Name** field, the **URL** field and the verification token into the **Token** field. + - To make the notification content more structured and elegant, please append the `?format=full` suffix to the endpoint provided by the Zoom Incoming Webhook App. For example, if the endpoint is: +`https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX`, +enter the following in the **URL** field: +`https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX?format=full`. +4. Click **Test Connection** button. + + - If the test successes, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. + +5. Click **Save** button to complete the subscription. + +Alternatively, you can also add the subscription from the **Alert Subscription** page as follows: + +1. Log in to the [TiDB Cloud console](https://tidbcloud.com). +2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +4. Click **Add Subscriber** +5. Select **Zoom** from the **Subscriber Type** drop-down list. +6. Enter the **Name** field, your Zoom webhook URL into the **URL** field and the verification token into the **Token** field. +7. Click **Test Connection** button. + + - If the test successes, the **Save** button is displayed. + - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. + +8. Click **Save** button to complete the subscription. + +If an alert condition remains unchanged, the alert sends notifications every 3 hours. + +## Unsubscribe from alert notifications + +If you no longer want to receive alert notifications of clusters in your project, take the following steps: + +1. Log in to the [TiDB Cloud console](https://tidbcloud.com). +2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +4. In the row of your target subscriber to be deleted, and click **...**. +5. Click **Unsubscribe** in the drop-down menu. +5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window. \ No newline at end of file diff --git a/tidb-cloud/monitor-built-in-alerting.md b/tidb-cloud/monitor-built-in-alerting.md index 3ecb609b80ca9..f8b11f7f8eb9c 100644 --- a/tidb-cloud/monitor-built-in-alerting.md +++ b/tidb-cloud/monitor-built-in-alerting.md @@ -1,11 +1,11 @@ --- title: TiDB Cloud Built-in Alerting -summary: Learn how to monitor your TiDB cluster by getting alert notification emails from TiDB Cloud. +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 notification emails. +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. @@ -40,35 +40,13 @@ In TiDB Cloud, you can edit the alert rules by disabling or enabling the alerts > > 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 notification emails +## Subscribe to alert notifications -To get alert notification emails of clusters in your project, take the following steps: +In TiDB Cloud, you can subscribe to alert notifications via one of the following methods: -1. On the **Alerts** page , click **Subscribe Alerts**. -2. Enter your email address, and then click **Subscribe**. - - > **Tip:** - > - > The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once. - -Alternatively, you can also add the subscription from the **Alert Subscription** page as follows: - -1. Log in to the [TiDB Cloud console](https://tidbcloud.com). -2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. -3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. -4. Click **Add Subscriber**, enter your email address in the displayed dialog, and then click **Add**. - -If an alert condition remains unchanged, the alert sends email notifications every 3 hours. - -## Unsubscribe from alert notification emails - -If you no longer want to receive alert notification emails of clusters in your project, take the following steps: - -1. Log in to the [TiDB Cloud console](https://tidbcloud.com). -2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. -3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. -4. Locate your email address and click **Unsubscribe**. -5. Click **Delete** to confirm the unsubscription. +- [Email](/tidb-cloud/monitor-alert-email.md) +- [Slack](/tidb-cloud/monitor-alert-slack.md) +- [Zoom](/tidb-cloud/monitor-alert-zoom.md) ## TiDB Cloud built-in alert conditions From 8b96a3dea2bde4ed4bc833da551b22e8d1b60846 Mon Sep 17 00:00:00 2001 From: SiyuChen Date: Tue, 10 Dec 2024 15:48:47 -0800 Subject: [PATCH 2/6] fix description Signed-off-by: SiyuChen --- tidb-cloud/monitor-alert-email.md | 27 ++++++++------------------- tidb-cloud/monitor-alert-slack.md | 27 ++++++++------------------- tidb-cloud/monitor-alert-zoom.md | 31 ++++++++----------------------- 3 files changed, 24 insertions(+), 61 deletions(-) diff --git a/tidb-cloud/monitor-alert-email.md b/tidb-cloud/monitor-alert-email.md index 6050dbf07eccd..cc383cae81ece 100644 --- a/tidb-cloud/monitor-alert-email.md +++ b/tidb-cloud/monitor-alert-email.md @@ -19,30 +19,19 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via To get alert notifications of clusters in your project, take the following steps: -1. On the **Alerts** page , click **Subscribe Alerts**. -2. Select **Email** from the **Subscriber Type** drop-down list. -3. Enter your email address. -4. Click **Test Connection** button. +1. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +2. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +3. Click **Add Subscriber**. +4. Select **Email** from the **Subscriber Type** drop-down list. +5. Enter your email address. +6. Click **Test Connection** button. - If the test successes, the **Save** button is displayed. - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. -5. Click **Save** button to complete the subscription. +7. Click **Save** button to complete the subscription. -Alternatively, you can also add the subscription from the **Alert Subscription** page as follows: - -1. Log in to the [TiDB Cloud console](https://tidbcloud.com). -2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. -3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. -4. Click **Add Subscriber**. -5. Select **Email** from the **Subscriber Type** drop-down list. -6. Enter your email address. -7. Click **Test Connection** button. - - - If the test successes, the **Save** button is displayed. - - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. - -8. Click **Save** button to complete the subscription. +Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page. If an alert condition remains unchanged, the alert sends email notifications every 3 hours. diff --git a/tidb-cloud/monitor-alert-slack.md b/tidb-cloud/monitor-alert-slack.md index 8845d9c7878c9..1fe5db8b2424c 100644 --- a/tidb-cloud/monitor-alert-slack.md +++ b/tidb-cloud/monitor-alert-slack.md @@ -30,30 +30,19 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via > > The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once. -1. On the **Alerts** page , click **Subscribe Alerts**. -2. Select **Slack** from the **Subscriber Type** drop-down list. -3. Enter **Name** field and your Slack webhook URL into **URL** field. -4. Click **Test Connection** button. +1. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +2. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +3. Click **Add Subscriber**. +4. Select **Slack** from the **Subscriber Type** drop-down list. +5. Enter **Name** field and your Slack webhook URL into **URL** field. +6. Click **Test Connection** button. - If the test successes, the **Save** button is displayed. - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. -5. Click **Save** button to complete the subscription. +7. Click **Save** button to complete the subscription. -Alternatively, you can also add the subscription from the **Alert Subscription** page as follows: - -1. Log in to the [TiDB Cloud console](https://tidbcloud.com). -2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. -3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. -4. Click **Add Subscriber**. -5. Select **Slack** from the **Subscriber Type** drop-down list. -6. Enter **Name** field and your Slack webhook URL into **URL** field. -7. Click **Test Connection** button. - - - If the test successes, the **Save** button is displayed. - - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. - -8. Click **Save** button to complete the subscription. +Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page. If an alert condition remains unchanged, the alert sends notifications every 3 hours. diff --git a/tidb-cloud/monitor-alert-zoom.md b/tidb-cloud/monitor-alert-zoom.md index ac60f12006009..b0d6a60606f51 100644 --- a/tidb-cloud/monitor-alert-zoom.md +++ b/tidb-cloud/monitor-alert-zoom.md @@ -42,34 +42,19 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via > > The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once. -1. On the **Alerts** page , click **Subscribe Alerts**. -2. Select **Zoom** from the **Subscriber Type** drop-down list. -3. Enter the **Name** field, the **URL** field and the verification token into the **Token** field. - - To make the notification content more structured and elegant, please append the `?format=full` suffix to the endpoint provided by the Zoom Incoming Webhook App. For example, if the endpoint is: -`https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX`, -enter the following in the **URL** field: -`https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX?format=full`. -4. Click **Test Connection** button. +1. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. +2. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. +3. Click **Add Subscriber** +4. Select **Zoom** from the **Subscriber Type** drop-down list. +5. Enter the **Name** field, your Zoom webhook URL into the **URL** field and the verification token into the **Token** field. +6. Click **Test Connection** button. - If the test successes, the **Save** button is displayed. - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. -5. Click **Save** button to complete the subscription. +7. Click **Save** button to complete the subscription. -Alternatively, you can also add the subscription from the **Alert Subscription** page as follows: - -1. Log in to the [TiDB Cloud console](https://tidbcloud.com). -2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. -3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. -4. Click **Add Subscriber** -5. Select **Zoom** from the **Subscriber Type** drop-down list. -6. Enter the **Name** field, your Zoom webhook URL into the **URL** field and the verification token into the **Token** field. -7. Click **Test Connection** button. - - - If the test successes, the **Save** button is displayed. - - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. - -8. Click **Save** button to complete the subscription. +Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page. If an alert condition remains unchanged, the alert sends notifications every 3 hours. From 80d6097bb99d869eb3f9744188248ac0b989a09b Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Fri, 13 Dec 2024 08:21:24 +0800 Subject: [PATCH 3/6] Apply suggestions from code review --- tidb-cloud/monitor-alert-email.md | 14 +++++++------- tidb-cloud/monitor-alert-slack.md | 24 ++++++++++++------------ tidb-cloud/monitor-alert-zoom.md | 16 ++++++++-------- 3 files changed, 27 insertions(+), 27 deletions(-) diff --git a/tidb-cloud/monitor-alert-email.md b/tidb-cloud/monitor-alert-email.md index cc383cae81ece..1940ff64e6002 100644 --- a/tidb-cloud/monitor-alert-email.md +++ b/tidb-cloud/monitor-alert-email.md @@ -5,7 +5,7 @@ summary: Learn how to monitor your TiDB cluster by getting alert notification vi # Subscribe via Email -TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Email. +TiDB Cloud provides you with an easy way to subscribe to alert notifications via email, [Slack](/tidb-cloud/monitor-alert-slack.md), and [Zoom](/tidb-cloud/monitor-alert-zoom.md). This document describes how to subscribe to alert notifications via email. ## Prerequisites @@ -24,16 +24,16 @@ To get alert notifications of clusters in your project, take the following steps 3. Click **Add Subscriber**. 4. Select **Email** from the **Subscriber Type** drop-down list. 5. Enter your email address. -6. Click **Test Connection** button. +6. Click **Test Connection**. - - If the test successes, the **Save** button is displayed. - - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the 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** button to complete the subscription. +7. Click **Save** to complete the subscription. -Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page. +Alternatively, you can also click **Subscribe** in the top right corner of the **Alert** page of the cluster. You will be directed to the **Alert Subscriber** page. -If an alert condition remains unchanged, the alert sends email notifications every 3 hours. +If an alert condition remains unchanged, the alert sends email notifications every three hours. ## Unsubscribe from alert notifications diff --git a/tidb-cloud/monitor-alert-slack.md b/tidb-cloud/monitor-alert-slack.md index 1fe5db8b2424c..04e7ffbaf8e4c 100644 --- a/tidb-cloud/monitor-alert-slack.md +++ b/tidb-cloud/monitor-alert-slack.md @@ -5,7 +5,7 @@ summary: Learn how to monitor your TiDB cluster by getting alert notification vi # Subscribe via Slack -TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Slack. +TiDB Cloud provides you with an easy way to subscribe to alert notifications via Slack, [email](/tidb-cloud/monitor-alert-email.md), and [Zoom](/tidb-cloud/monitor-alert-zoom.md). This document describes how to subscribe to alert notifications via Slack. ## Prerequisites @@ -17,11 +17,11 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via ### Step 1. Generate a Slack webhook URL -1. [Create a Slack app](https://api.slack.com/apps/new), if you don't have one already. Click **Create New App**, and choose **From scratch**. Pick a name, choose a workspace to associate your app with, then click **Create App**. -2. Goto the settings page for your app, you can load its settings via your [app's management dashboard](https://api.slack.com/apps). -3. Select **Incoming Webhooks** tab, and toggle **Activate Incoming Webhooks** to **ON**. +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. Go ahead and pick a channel that you want to receive alert notifications in, then select **Authorize**. If you need to add the incoming webhook to a private channel, you must first be in that channel. +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. 6. You can see a new entry under the **Webhook URLs for Your Workspace** section in the format: `https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`. ### Step 2. Subscribe from TiDB Cloud @@ -34,17 +34,17 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via 2. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. 3. Click **Add Subscriber**. 4. Select **Slack** from the **Subscriber Type** drop-down list. -5. Enter **Name** field and your Slack webhook URL into **URL** field. -6. Click **Test Connection** button. +5. In the **Name** field, enter a name and your Slack webhook URL into **URL** field. +6. Click **Test Connection**. - - If the test successes, the **Save** button is displayed. - - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the 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** button to complete the subscription. +7. Click **Save** to complete the subscription. -Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page. +Alternatively, you can also click **Subscribe** in the top right corner of the **Alert** page of the cluster. You will be directed to the **Alert Subscriber** page. -If an alert condition remains unchanged, the alert sends notifications every 3 hours. +If an alert condition remains unchanged, the alert sends notifications every three hours. ## Unsubscribe from alert notifications diff --git a/tidb-cloud/monitor-alert-zoom.md b/tidb-cloud/monitor-alert-zoom.md index b0d6a60606f51..8a46416fd1d69 100644 --- a/tidb-cloud/monitor-alert-zoom.md +++ b/tidb-cloud/monitor-alert-zoom.md @@ -5,7 +5,7 @@ summary: Learn how to monitor your TiDB cluster by getting alert notification vi # Subscribe via Zoom -TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Zoom. +TiDB Cloud provides you with an easy way to subscribe to alert notifications via Zoom, [Slack](/tidb-cloud/monitor-alert-slack.md), and [email](/tidb-cloud/monitor-alert-email.md). This document describes how to subscribe to alert notifications via Zoom. ## Prerequisites @@ -30,10 +30,10 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via 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, please replace `` with your connection name that you want to use, for example, `tidbcloud-alerts`: ```shell - /inc connect + /inc connect ${connectionName} ``` 5. The command will return the following details: - - **Endpoint**, this will provide a webhook URL in the format: `https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX`. + - **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 @@ -47,16 +47,16 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via 3. Click **Add Subscriber** 4. Select **Zoom** from the **Subscriber Type** drop-down list. 5. Enter the **Name** field, your Zoom webhook URL into the **URL** field and the verification token into the **Token** field. -6. Click **Test Connection** button. +6. Click **Test Connection**. - - If the test successes, the **Save** button is displayed. + - If the test succeeds, the **Save** button is displayed. - If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection. -7. Click **Save** button to complete the subscription. +7. Click **Save** to complete the subscription. -Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page. +Alternatively, you can also click **Subscribe** in the top right corner of the **Alert** page of the cluster. You will be directed to the **Alert Subscriber** page. -If an alert condition remains unchanged, the alert sends notifications every 3 hours. +If an alert condition remains unchanged, the alert sends notifications every three hours. ## Unsubscribe from alert notifications From b5628c9efb67dc7cd08da3d3a7f191486c506c1e Mon Sep 17 00:00:00 2001 From: SiyuChen Date: Mon, 13 Jan 2025 14:09:47 -0800 Subject: [PATCH 4/6] fix: lint Signed-off-by: SiyuChen --- tidb-cloud/monitor-alert-zoom.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tidb-cloud/monitor-alert-zoom.md b/tidb-cloud/monitor-alert-zoom.md index 8a46416fd1d69..2f99f0830b1cb 100644 --- a/tidb-cloud/monitor-alert-zoom.md +++ b/tidb-cloud/monitor-alert-zoom.md @@ -29,10 +29,13 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via 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, please replace `` with your connection name that you want to use, 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** From b84e73294d1ce2c63e3041f9c98e689d9cf3f392 Mon Sep 17 00:00:00 2001 From: SiyuChen Date: Mon, 13 Jan 2025 14:28:26 -0800 Subject: [PATCH 5/6] fix: lint Signed-off-by: SiyuChen --- tidb-cloud/monitor-alert-email.md | 1 - tidb-cloud/monitor-alert-slack.md | 1 - tidb-cloud/monitor-alert-zoom.md | 1 - 3 files changed, 3 deletions(-) diff --git a/tidb-cloud/monitor-alert-email.md b/tidb-cloud/monitor-alert-email.md index 1940ff64e6002..4e7d7fe1e5382 100644 --- a/tidb-cloud/monitor-alert-email.md +++ b/tidb-cloud/monitor-alert-email.md @@ -43,5 +43,4 @@ If you no longer want to receive alert notifications of clusters in your project 2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. 3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. 4. In the row of your target subscriber to be deleted, and click **...**. -5. Click **Unsubscribe** in the drop-down menu. 5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window. \ No newline at end of file diff --git a/tidb-cloud/monitor-alert-slack.md b/tidb-cloud/monitor-alert-slack.md index 04e7ffbaf8e4c..b2c8dc7717d2a 100644 --- a/tidb-cloud/monitor-alert-slack.md +++ b/tidb-cloud/monitor-alert-slack.md @@ -54,5 +54,4 @@ If you no longer want to receive alert notifications of clusters in your project 2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. 3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. 4. In the row of your target subscriber to be deleted, and click **...**. -5. Click **Unsubscribe** in the drop-down menu. 5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window. \ No newline at end of file diff --git a/tidb-cloud/monitor-alert-zoom.md b/tidb-cloud/monitor-alert-zoom.md index 2f99f0830b1cb..7f7139eafbef6 100644 --- a/tidb-cloud/monitor-alert-zoom.md +++ b/tidb-cloud/monitor-alert-zoom.md @@ -69,5 +69,4 @@ If you no longer want to receive alert notifications of clusters in your project 2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**. 3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane. 4. In the row of your target subscriber to be deleted, and click **...**. -5. Click **Unsubscribe** in the drop-down menu. 5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window. \ No newline at end of file From 10bd9f7546ad355dbc5d53b025a2218eb7dd7745 Mon Sep 17 00:00:00 2001 From: SiyuChen Date: Mon, 13 Jan 2025 19:57:24 -0800 Subject: [PATCH 6/6] modify description for prerequisites Signed-off-by: SiyuChen --- tidb-cloud/monitor-alert-slack.md | 4 ++-- tidb-cloud/monitor-alert-zoom.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/tidb-cloud/monitor-alert-slack.md b/tidb-cloud/monitor-alert-slack.md index b2c8dc7717d2a..d31b0f4e28f65 100644 --- a/tidb-cloud/monitor-alert-slack.md +++ b/tidb-cloud/monitor-alert-slack.md @@ -9,9 +9,9 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via ## Prerequisites -- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud. +- The Subscribing via Slack feature is only available for organizations that subscribes to the Enterprise support plan or higher. -- To receive alert notifications via Slack, you need to have an Enterprise support plan or higher. +- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud. ## Subscribe to alert notifications diff --git a/tidb-cloud/monitor-alert-zoom.md b/tidb-cloud/monitor-alert-zoom.md index 7f7139eafbef6..6c41a72ff9b78 100644 --- a/tidb-cloud/monitor-alert-zoom.md +++ b/tidb-cloud/monitor-alert-zoom.md @@ -9,9 +9,9 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via ## Prerequisites -- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud. +- The Subscribing via Zoom feature is only available for organizations that subscribes to the Enterprise support plan or higher. -- To receive alert notifications via Zoom, you need to have an Enterprise support plan or higher. +- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud. - To add and configure the Incoming Webhook Chatbot in Zoom, you need to have admin permissions on your Zoom account.