Skip to content
2 changes: 2 additions & 0 deletions TOC-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -753,6 +753,8 @@
- Connected: IM Subscription for TiDB Cloud Alerts
- [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md)
- [Subscribe via Zoom](/tidb-cloud/monitor-alert-zoom.md)
- [Subscribe via Flashduty](/tidb-cloud/monitor-alert-flashduty.md)
- [Subscribe via PagerDuty](/tidb-cloud/monitor-alert-pagerduty.md)
- Connected: IM Ticket Creation and Update Subscription
- [Create Tickets and Subscribe to Ticket Updates via Slack](/tidb-cloud/connected-slack-ticket-creation.md)
- [Create Tickets and Subscribe to Ticket Updates via Lark](/tidb-cloud/connected-lark-ticket-creation.md)
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/monitor-alert-email.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: Learn how to monitor your TiDB cluster by getting alert notifications v

# 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.
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:**
>
Expand Down
58 changes: 58 additions & 0 deletions tidb-cloud/monitor-alert-flashduty
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
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 only available for [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 `Project Owner` access to the target project in TiDB Cloud.

## Subscribe to alert notifications

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

### Step 1. Generate a Flashduty webhook URL

1. Refer to the official Flashduty documentation under [Flashduty > Integrations > Alerts integration > Prometheus Integration](https://docs.flashcat.cloud/en/flashduty/prometheus-integration-guide) to generate a webhook URL.
2. Copy the webhook URL generated in step 1.

### 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. 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.
4. From the **Subscriber Type** drop-down list, select **Flashduty**.
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. 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. 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.
58 changes: 58 additions & 0 deletions tidb-cloud/monitor-alert-pagerduty
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
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 only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.

## Prerequisites

- Subscribing to alerts via PagerDuty 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, 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 get alert notifications of clusters in your project, take the following steps:

### Step 1. Generate a PagerDuty integration key

1. Refer to the official [PagerDuty documentation](https://developer.pagerduty.com/docs/events-api-v2-overview#getting-started) to generate an integration key of 'Events API v2' type.
2. Copy the integration key generated in step 1.

### 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. 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.
4. From the **Subscriber Type** drop-down list, select **PagerDuty**.
5. Enter a name in the **Name** field and your 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 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 for clusters in your project, follow these 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, find the subscriber that you want to delete, and then click **...** > **Unsubscribe**.
4. Click **Unsubscribe** to confirm the unsubscription.
2 changes: 1 addition & 1 deletion tidb-cloud/monitor-alert-slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: Learn how to monitor your TiDB cluster by getting alert notifications v

# 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.
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.

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/monitor-alert-zoom.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: Learn how to monitor your TiDB cluster by getting alert notifications v

# 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.
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:**
>
Expand Down
2 changes: 2 additions & 0 deletions tidb-cloud/monitor-built-in-alerting.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ In TiDB Cloud, you can subscribe to alert notifications via one of the following
- [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

Expand Down
Loading