monitor-alert-pagerduty.md

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, email, Zoom, and Flashduty. This document describes how to subscribe to alert notifications via PagerDuty.

Note:

Currently, alert subscription is available for TiDB Cloud Essential and TiDB Cloud Dedicated clusters.

Prerequisites

• The subscribing via PagerDuty 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

To receive alert notifications, take the following steps:

Step 1. Generate a PagerDuty integration key

1. Generate an integration key of type Events API v2 by following the instructions in the PagerDuty Events API v2 Overview.
2. Save the generated integration key to use in the next step.

Step 2. Subscribe from TiDB Cloud

Alert notification subscriptions vary by cluster plan.

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

Tip:

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

1. In the TiDB Cloud console, 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.

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, take the following steps. The steps vary by cluster plan.

1. In the TiDB Cloud console, 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.

1. In the TiDB Cloud console, 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.