Skip to content

Commit

Permalink
fix description
Browse files Browse the repository at this point in the history
Signed-off-by: SiyuChen <[email protected]>
  • Loading branch information
iguoyr committed Dec 10, 2024
1 parent 1292d23 commit 8b96a3d
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 61 deletions.
27 changes: 8 additions & 19 deletions tidb-cloud/monitor-alert-email.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,19 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via
To get alert notifications of clusters in your project, take the following steps:

1. On the **Alerts** page , click **Subscribe Alerts**.
2. Select **Email** from the **Subscriber Type** drop-down list.
3. Enter your email address.
4. Click **Test Connection** button.
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.

5. Click **Save** button to complete the subscription.
7. Click **Save** button to complete the subscription.

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**.
5. Select **Email** from the **Subscriber Type** drop-down list.
6. Enter your email address.
7. 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.

8. Click **Save** button to complete the subscription.
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.

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

Expand Down
27 changes: 8 additions & 19 deletions tidb-cloud/monitor-alert-slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,30 +30,19 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via
>
> 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. On the **Alerts** page , click **Subscribe Alerts**.
2. Select **Slack** from the **Subscriber Type** drop-down list.
3. Enter **Name** field and your Slack webhook URL into **URL** field.
4. Click **Test Connection** button.
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.
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.

5. Click **Save** button to complete the subscription.
7. Click **Save** button to complete the subscription.

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**.
5. Select **Slack** from the **Subscriber Type** drop-down list.
6. Enter **Name** field and your Slack webhook URL into **URL** field.
7. 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.

8. Click **Save** button to complete the subscription.
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.

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

Expand Down
31 changes: 8 additions & 23 deletions tidb-cloud/monitor-alert-zoom.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,34 +42,19 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via
>
> 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. On the **Alerts** page , click **Subscribe Alerts**.
2. Select **Zoom** from the **Subscriber Type** drop-down list.
3. Enter the **Name** field, the **URL** field and the verification token into the **Token** field.
- To make the notification content more structured and elegant, please append the `?format=full` suffix to the endpoint provided by the Zoom Incoming Webhook App. For example, if the endpoint is:
`https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX`,
enter the following in the **URL** field:
`https://integrations.zoom.us/chat/webhooks/incomingwebhook/XXXXXXXXXXXXXXXXXXXXXXXX?format=full`.
4. Click **Test Connection** button.
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.

5. Click **Save** button to complete the subscription.
7. Click **Save** button to complete the subscription.

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**
5. Select **Zoom** from the **Subscriber Type** drop-down list.
6. Enter the **Name** field, your Zoom webhook URL into the **URL** field and the verification token into the **Token** field.
7. 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.

8. Click **Save** button to complete the subscription.
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.

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

Expand Down

0 comments on commit 8b96a3d

Please sign in to comment.