Skip to content

Create monitor-alert-pagerduty #22365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
huoyao1125 wants to merge 3 commits into from
Closed

Create monitor-alert-pagerduty #22365

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca83bec
Create monitor-alert-pagerduty
huoyao1125 Jan 26, 2026
ae4dd7d
Apply suggestions from code review
hfxsd Jan 26, 2026
509ed88
Apply suggestions from code review
hfxsd Jan 26, 2026
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
65 changes: 65 additions & 0 deletions tidb-cloud/monitor-alert-pagerduty
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
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 [Slack](/tidb-cloud/monitor-alert-slack.md), [email](/tidb-cloud/monitor-alert-email.md), [Zoom](/tidb-cloud/monitor-alert-zoom.md), [Flashduty](/tidb-cloud/monitor-alert-flashduty.md) and PagerDuty. This document describes how to subscribe to alert notifications via PagerDuty.

The following screenshot shows two example alerts.

![TiDB Cloud Alerts in PagerDuty](/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.

## Prerequisites

- Subscribing to alerts via PagerDuty is only available for organizations that subscribe to the **Enterprise** or **Premium** support plan.

- 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

### Step 1. Generate a PagerDuty webhook URL ##这部分请思雨帮忙更新

1. [Create a PagerDuty app](https://api.PagerDuty.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.PagerDuty.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.PagerDuty.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`.
Comment on lines +26 to +34
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

This section contains a placeholder comment and incorrect instructions copied from the Slack integration document. These steps will not work for PagerDuty and will cause user confusion.

I've provided the likely correct steps for integrating with PagerDuty, which involves using the Prometheus integration type to generate a compatible URL. Please verify if this is the intended integration method.

### Step 1. Generate a PagerDuty integration URL

1. In your PagerDuty account, go to **Services** > **Service Directory**.
2. Choose whether to add your integration to a new or existing service:
    * **To add to an existing service**: Click the name of the service, select the **Integrations** tab, and then click **Add a new integration**.
    * **To create a new service**: Follow the PagerDuty documentation to [create a new service](https://support.pagerduty.com/docs/services-and-integrations#create-a-new-service).
3. On the **Add an Integration** page, search for and select **Prometheus**.
4. Click **Add**.
5. You will be redirected back to the **Integrations** tab. Copy the **Integration URL** that was just generated. You will use this URL in the TiDB Cloud console.


### 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. Select **PagerDuty** from the **Subscriber Type** drop-down list.
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with the suggested changes in 'Step 1', let's use 'integration URL' instead of 'webhook URL'.

5. Enter a name in the **Name** field and your PagerDuty integration URL in the **URL** field.
References
  1. The style guide requires using consistent terminology (line 25). (link)

5. Enter a name in the **Name** field and your PagerDuty 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 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.