Skip to content
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.

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

cloud: update alert subscriber #19461

Open
wants to merge 4 commits into
base: release-7.5
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 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
4 changes: 4 additions & 0 deletions TOC-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@
- [Overview](/tidb-cloud/monitor-tidb-cluster.md)
- [Built-in Metrics](/tidb-cloud/built-in-monitoring.md)
- [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md)
- Subscribe To Alert Notification
- [Subscribe via Email](/tidb-cloud/monitor-alert-email.md)
- [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md)
- [Subscribe via Zoom](/tidb-cloud/monitor-alert-zoom.md)
- [Cluster Events](/tidb-cloud/tidb-cloud-events.md)
- [Third-Party Metrics Integrations (Beta)](/tidb-cloud/third-party-monitoring-integrations.md)
- Tune Performance
Expand Down
47 changes: 47 additions & 0 deletions tidb-cloud/monitor-alert-email.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Subscribe via Email
summary: Learn how to monitor your TiDB cluster by getting alert notification via Email.
---

# Subscribe via Email

TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Email.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

## Prerequisites

- To subscribe to alert notification 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

> **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. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
2. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane.
3. Click **Add Subscriber**.
4. Select **Email** from the **Subscriber Type** drop-down list.
5. Enter your email address.
6. Click **Test Connection** button.

- If the test successes, the **Save** button is displayed.
- If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

7. Click **Save** button to complete the subscription.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

If an alert condition remains unchanged, the alert sends email notifications every 3 hours.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

## Unsubscribe from alert notifications

If you no longer want to receive alert notifications of clusters in your project, take the following steps:

1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane.
4. In the row of your target subscriber to be deleted, and click **...**.
5. Click **Unsubscribe** in the drop-down menu.
5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window.
58 changes: 58 additions & 0 deletions tidb-cloud/monitor-alert-slack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Subscribe via Slack
summary: Learn how to monitor your TiDB cluster by getting alert notification via Slack.
---

# Subscribe via Slack

TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Slack.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

## Prerequisites

- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud.

- To receive alert notifications via Slack, you need to have an Enterprise support plan or higher.

## Subscribe to alert notifications

### Step 1. Generate a Slack webhook URL

1. [Create a Slack app](https://api.slack.com/apps/new), if you don't have one already. Click **Create New App**, and choose **From scratch**. Pick a name, choose a workspace to associate your app with, then click **Create App**.
2. Goto the settings page for your app, you can load its settings via your [app's management dashboard](https://api.slack.com/apps).
3. Select **Incoming Webhooks** tab, and toggle **Activate Incoming Webhooks** to **ON**.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
4. Click **Add New Webhook to Workspace**.
5. Go ahead and pick a channel that you want to receive alert notifications in, then select **Authorize**. If you need to add the incoming webhook to a private channel, you must first be in that channel.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
6. You can see a new entry under the **Webhook URLs for Your Workspace** section in the format: `https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`.

### 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. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
2. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane.
3. Click **Add Subscriber**.
4. Select **Slack** from the **Subscriber Type** drop-down list.
5. Enter **Name** field and your Slack webhook URL into **URL** field.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
6. Click **Test Connection** button.

- If the test successes, the **Save** button is displayed.
- If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

7. Click **Save** button to complete the subscription.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

If an alert condition remains unchanged, the alert sends notifications every 3 hours.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

## Unsubscribe from alert notifications

If you no longer want to receive alert notifications of clusters in your project, take the following steps:

1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane.
4. In the row of your target subscriber to be deleted, and click **...**.
5. Click **Unsubscribe** in the drop-down menu.
5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window.
70 changes: 70 additions & 0 deletions tidb-cloud/monitor-alert-zoom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Subscribe via Zoom
summary: Learn how to monitor your TiDB cluster by getting alert notification via Zoom.
---

# Subscribe via Zoom

TiDB Cloud provides you with an easy way to subscribe to alert notifications via multiple channels. This document describes how to subscribe to alert notifications via Zoom.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

## Prerequisites

- To subscribe to alert notification of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud.

- To receive alert notifications via Zoom, you need to have an Enterprise support plan or higher.

- To add and configure the Incoming Webhook Chatbot in Zoom, you need to have admin permissions on your Zoom account.

## Subscribe to alert notifications

### Step 1. Add Zoom Incoming Webhook App

1. Sign in to the [Zoom App Marketplace](https://marketplace.zoom.us/) as the account administrator.
2. Add [Incoming Webhook App](https://marketplace.zoom.us/apps/eH_dLuquRd-VYcOsNGy-hQ) from the Zoom App Marketplace, Click **Add**. If the app is not pre-approved, contact your Zoom admin to approve this app for your account. Learn more about [admin app approvals](https://support.zoom.us/hc/en-us/articles/360027829671).
3. Confirm the permissions the app requires, then click **Authorize**. The Incoming Webhook app is now added.

### Step 2. Generate a Zoom webhook URL

1. Sign in to the Zoom desktop client.
2. Click the **Team Chat** tab.
3. Under **Apps**, find and select **Incoming Webhook**, or select a chat channel from above that you would like to receive messages in.
4. Enter the following command to make a new connection, please replace `<connectionName>` with your connection name that you want to use, for example, `tidbcloud-alerts`:
```shell
/inc connect <connectionName>
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
```
5. The command will return the following details:
- **Endpoint**, this will provide a webhook URL in the format: `https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX`.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
- **Verification Token**

### Step 3. 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. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
2. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane.
3. Click **Add Subscriber**
4. Select **Zoom** from the **Subscriber Type** drop-down list.
5. Enter the **Name** field, your Zoom webhook URL into the **URL** field and the verification token into the **Token** field.
6. Click **Test Connection** button.

- If the test successes, the **Save** button is displayed.
- If the test fails, an error message is displayed. Follow the message for troubleshooting and retry the connection.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

7. Click **Save** button to complete the subscription.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

Alternatively, you can also find a **Subscribe** button in the top right corner of the **Alert** page of the cluster. Clicking it will take you to the **Alert Subscriber** page.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

If an alert condition remains unchanged, the alert sends notifications every 3 hours.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

## Unsubscribe from alert notifications

If you no longer want to receive alert notifications of clusters in your project, take the following steps:

1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane.
4. In the row of your target subscriber to be deleted, and click **...**.
5. Click **Unsubscribe** in the drop-down menu.
5. Click **Unsubscribe** to confirm the unsubscription in the pop-up window.
36 changes: 7 additions & 29 deletions tidb-cloud/monitor-built-in-alerting.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: TiDB Cloud Built-in Alerting
summary: Learn how to monitor your TiDB cluster by getting alert notification emails from TiDB Cloud.
summary: Learn how to monitor your TiDB cluster by getting alert notifications from TiDB Cloud.
---

# TiDB Cloud Built-in Alerting

TiDB Cloud provides you with an easy way to view alerts, edit alert rules, and subscribe to alert notification emails.
TiDB Cloud provides you with an easy way to view alerts, edit alert rules, and subscribe to alert notifications.

This document describes how to do these operations and provides the TiDB Cloud built-in alert conditions for your reference.

Expand Down Expand Up @@ -40,35 +40,13 @@ In TiDB Cloud, you can edit the alert rules by disabling or enabling the alerts
>
> Currently, TiDB Cloud provides limited capabilities for alert rule editing. Some alert rules do not support editing. If you would like to configure different trigger conditions or frequency, or have alerts automatically trigger actions in downstream services like [PagerDuty](https://www.pagerduty.com/docs/guides/datadog-integration-guide/), consider using a [third-party monitoring and alerting integration](/tidb-cloud/third-party-monitoring-integrations.md).

## Subscribe to alert notification emails
## Subscribe to alert notifications

To get alert notification emails of clusters in your project, take the following steps:
In TiDB Cloud, you can subscribe to alert notifications via one of the following methods:

1. On the **Alerts** page , click **Subscribe Alerts**.
2. Enter your email address, and then click **Subscribe**.

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

Alternatively, you can also add the subscription from the **Alert Subscription** page as follows:

1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane.
4. Click **Add Subscriber**, enter your email address in the displayed dialog, and then click **Add**.

If an alert condition remains unchanged, the alert sends email notifications every 3 hours.

## Unsubscribe from alert notification emails

If you no longer want to receive alert notification emails of clusters in your project, take the following steps:

1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
3. On the **Project Settings** page of your project, click **Alert Subscription** in the left navigation pane.
4. Locate your email address and click **Unsubscribe**.
5. Click **Delete** to confirm the unsubscription.
- [Email](/tidb-cloud/monitor-alert-email.md)
- [Slack](/tidb-cloud/monitor-alert-slack.md)
- [Zoom](/tidb-cloud/monitor-alert-zoom.md)

## TiDB Cloud built-in alert conditions

Expand Down
Loading