diff --git a/TOC-tidb-cloud.md b/TOC-tidb-cloud.md index 3a3ac00224a06..a688888ea934f 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 Notifications + - [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/media/tidb-cloud/tidb-cloud-alert-subscription.png b/media/tidb-cloud/tidb-cloud-alert-subscription.png new file mode 100644 index 0000000000000..6dfaa96d269c5 Binary files /dev/null and b/media/tidb-cloud/tidb-cloud-alert-subscription.png differ diff --git a/tidb-cloud/monitor-alert-email.md b/tidb-cloud/monitor-alert-email.md new file mode 100644 index 0000000000000..640171fcc55ea --- /dev/null +++ b/tidb-cloud/monitor-alert-email.md @@ -0,0 +1,46 @@ +--- +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), and [Zoom](/tidb-cloud/monitor-alert-zoom.md). This document describes how to subscribe to alert notifications via email. + +## Prerequisites + +- 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. + +## 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. 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**. + + - 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** 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 three 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, click **...**. +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..91398240388b1 --- /dev/null +++ b/tidb-cloud/monitor-alert-slack.md @@ -0,0 +1,62 @@ +--- +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](https://slack.com/), [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. + +The following screenshot shows two example alerts. + +![TiDB Cloud Alerts in Slack](/media/tidb-cloud/tidb-cloud-alert-subscription.png) + +## 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 `Project Owner` access to the target project 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 + +> **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. 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 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 Subscriber** 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 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, click **...**. +5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window. diff --git a/tidb-cloud/monitor-alert-zoom.md b/tidb-cloud/monitor-alert-zoom.md new file mode 100644 index 0000000000000..0e33561c2b2cb --- /dev/null +++ b/tidb-cloud/monitor-alert-zoom.md @@ -0,0 +1,72 @@ +--- +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](https://www.zoom.com/), [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 + +- The subscribing via Zoom 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 `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. + +## 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 + +> **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. 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 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 for troubleshooting 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 Subscriber** 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 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, click **...**. +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