|
| 1 | +--- |
| 2 | +title: Subscribe via PagerDuty |
| 3 | +summary: Learn how to monitor your TiDB cluster by getting alert notifications via PagerDuty. |
| 4 | +--- |
| 5 | + |
| 6 | +# Subscribe via PagerDuty |
| 7 | + |
| 8 | +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. |
| 9 | + |
| 10 | +> **Note:** |
| 11 | +> |
| 12 | +> Currently, alert subscription is only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. |
| 13 | +
|
| 14 | +## Prerequisites |
| 15 | + |
| 16 | +- 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). |
| 17 | + |
| 18 | +- 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. |
| 19 | + |
| 20 | +## Subscribe to alert notifications |
| 21 | + |
| 22 | +To receive alert notifications of clusters in your project, take the following steps: |
| 23 | + |
| 24 | +### Step 1. Generate a PagerDuty integration key |
| 25 | + |
| 26 | +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). |
| 27 | +2. Save the generated integration key to use in the next step. |
| 28 | + |
| 29 | +### Step 2. Subscribe from TiDB Cloud |
| 30 | + |
| 31 | +> **Tip:** |
| 32 | +> |
| 33 | +> 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. |
| 34 | +
|
| 35 | +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner. |
| 36 | +2. In the left navigation pane, click **Project Settings** > **Alert Subscription**. |
| 37 | +3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner. |
| 38 | +4. Select **PagerDuty** from the **Subscriber Type** drop-down list. |
| 39 | +5. Enter a name in the **Name** field and your PagerDuty integration key in the **Integration Key** field. |
| 40 | +6. Click **Test Connection**. |
| 41 | + |
| 42 | + - If the test succeeds, the **Save** button is displayed. |
| 43 | + - If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and retry the connection. |
| 44 | + |
| 45 | +7. Click **Save** to complete the subscription. |
| 46 | + |
| 47 | +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. |
| 48 | + |
| 49 | +If an alert condition remains unchanged, the alert sends notifications every three hours. |
| 50 | + |
| 51 | +## Unsubscribe from alert notifications |
| 52 | + |
| 53 | +If you no longer want to receive alert notifications of clusters in your project, take the following steps: |
| 54 | + |
| 55 | +1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner. |
| 56 | +2. In the left navigation pane, click **Project Settings** > **Alert Subscription**. |
| 57 | +3. On the **Alert Subscription** page, locate the row of your target subscriber to be deleted, and then click **...** > **Unsubscribe**. |
| 58 | +4. Click **Unsubscribe** to confirm the unsubscription. |
0 commit comments