Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 43 additions & 6 deletions tidb-cloud/monitor-alert-email.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,22 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

> **Note:**
>
> Currently, alert subscription is only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) and [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) clusters.
## 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

To receive alert notifications, take the following steps. The steps vary by cluster plans.

<CustomContent plan="dedicated">

> **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. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner.
2. In the left navigation pane, click **Project Settings** > **Alert Subscription**.
3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner.
Expand All @@ -34,16 +36,51 @@ To get alert notifications of clusters in your project, take the following steps
- 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.

</CustomContent>

<CustomContent plan="essential">

> **Tip:**
>
> The alert subscription is for all alerts in the current cluster. If you have multiple clusters, you need to subscribe to each one individually.
1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>

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 cluster. You will be directed to the **Alert Subscriber** page.
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 cluster. 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 of clusters in your project, take the following steps:
If you no longer want to receive alert notifications, please take the following steps. The steps vary by cluster plans.

<CustomContent plan="dedicated">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner.
2. In the left navigation pane, click **Project 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.
4. Click **Unsubscribe** to confirm the unsubscription.

</CustomContent>

<CustomContent plan="essential">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>
47 changes: 43 additions & 4 deletions tidb-cloud/monitor-alert-flashduty.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

> **Note:**
>
> Currently, alert subscription is only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) and [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) clusters.
## Prerequisites

Expand All @@ -19,7 +19,7 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

## Subscribe to alert notifications

To receive alert notifications of clusters in your project, take the following steps:
To receive alert notifications of clusters, take the following steps:

### Step 1. Generate a Flashduty webhook URL

Expand All @@ -28,6 +28,10 @@ To receive alert notifications of clusters in your project, take the following s

### Step 2. Subscribe from TiDB Cloud

Alert notification subscriptions vary by cluster plans.

<CustomContent plan="dedicated">

> **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.
Expand All @@ -44,15 +48,50 @@ To receive alert notifications of clusters in your project, take the following s

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.
</CustomContent>

<CustomContent plan="essential">

> **Tip:**
>
> The alert subscription is for all alerts in the current cluster. If you have multiple clusters, you need to subscribe to each one individually.
1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>

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 of clusters in your project, take the following steps:
If you no longer want to receive alert notifications, please take the following steps. The steps vary by cluster plans.

<CustomContent plan="dedicated">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner.
2. In the left navigation pane, click **Project 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.

</CustomContent>

<CustomContent plan="essential">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>
45 changes: 42 additions & 3 deletions tidb-cloud/monitor-alert-pagerduty.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

> **Note:**
>
> Currently, alert subscription is only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) and [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) clusters.

## Prerequisites

Expand All @@ -19,7 +19,7 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

## Subscribe to alert notifications

To receive alert notifications of clusters in your project, take the following steps:
To receive alert notifications, take the following steps:

### Step 1. Generate a PagerDuty integration key

Expand All @@ -28,6 +28,10 @@ To receive alert notifications of clusters in your project, take the following s

### Step 2. Subscribe from TiDB Cloud

Alert notification subscriptions vary by cluster plans.

<CustomContent plan="dedicated">

> **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.
Expand All @@ -44,15 +48,50 @@ To receive alert notifications of clusters in your project, take the following s

7. Click **Save** to complete the subscription.

</CustomContent>

<CustomContent plan="essential">

> **Tip:**
>
> The alert subscription is for all alerts in the current cluster. If you have multiple clusters, you need to subscribe to each one individually.

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>

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:
If you no longer want to receive alert notifications, take the following steps. The steps vary by cluster plans.

<CustomContent plan="dedicated">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner.
2. In the left navigation pane, click **Project 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.

</CustomContent>

<CustomContent plan="essential">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>
49 changes: 42 additions & 7 deletions tidb-cloud/monitor-alert-slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,9 @@ summary: Learn how to monitor your TiDB cluster by getting alert notifications v

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.

The following screenshot shows two example alerts.

![TiDB Cloud Alerts in Slack](/media/tidb-cloud/tidb-cloud-alert-subscription.png)

> **Note:**
>
> Currently, alert subscription is only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) and [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) clusters.

## Prerequisites

Expand All @@ -35,6 +31,10 @@ You can see a new entry under the **Webhook URLs for Your Workspace** section in

### Step 2. Subscribe from TiDB Cloud

Alert notification subscriptions vary by cluster plans.

<CustomContent plan="dedicated">

> **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.
Expand All @@ -51,15 +51,50 @@ You can see a new entry under the **Webhook URLs for Your Workspace** section in

7. Click **Save** to complete the subscription.

</CustomContent>

<CustomContent plan="essential">

> **Tip:**
>
> The alert subscription is for all alerts in the current cluster. If you have multiple clusters, you need to subscribe to each one individually.

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>

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:
If you no longer want to receive alert notifications, take the following steps. The steps vary by cluster plans.

<CustomContent plan="dedicated">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner.
2. In the left navigation pane, click **Project 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.
4. Click **Unsubscribe** to confirm the unsubscription.

</CustomContent>

<CustomContent plan="essential">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>
45 changes: 42 additions & 3 deletions tidb-cloud/monitor-alert-zoom.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

> **Note:**
>
> Currently, alert subscription is only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) and [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) clusters.
## Prerequisites

Expand Down Expand Up @@ -45,6 +45,10 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

### Step 3. Subscribe from TiDB Cloud

Alert notification subscriptions vary by cluster plans.

<CustomContent plan="dedicated">

> **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.
Expand All @@ -61,15 +65,50 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

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.
</CustomContent>

<CustomContent plan="essential">

> **Tip:**
>
> The alert subscription is for all alerts in the current cluster. If you have multiple clusters, you need to subscribe to each one individually.

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>

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 of clusters in your project, take the following steps:
If you no longer want to receive alert notifications, take the following steps. The steps vary by cluster plans.

<CustomContent plan="dedicated">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner.
2. In the left navigation pane, click **Project 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.

</CustomContent>

<CustomContent plan="essential">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster 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.

</CustomContent>
Loading