Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
10 changes: 10 additions & 0 deletions TOC-tidb-cloud-premium.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,12 @@
- Monitor and Alert
- [Overview](/tidb-cloud/monitor-tidb-cluster.md)
- [Built-in Metrics](/tidb-cloud/premium/built-in-monitoring-premium.md)
- [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md)
- [Integrate TiDB Cloud with Prometheus and Grafana](/tidb-cloud/prometheus-grafana-integration.md)
- Subscribe to Alert Notifications
- [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)
- Tune Performance
- [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md)
- [Analyze Performance](/tidb-cloud/tune-performance.md)
Expand Down Expand Up @@ -566,6 +571,11 @@
- [Connected Care Details](/tidb-cloud/connected-care-detail.md)
- Connected Care Support Service Features
- [Connected: AI Chat in IM](/tidb-cloud/connected-ai-chat-in-im.md)
- Connected: IM Subscription for TiDB Cloud Alerts
- [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md)
- [Subscribe via Zoom](/tidb-cloud/monitor-alert-zoom.md)
- [Subscribe via Flashduty](/tidb-cloud/monitor-alert-flashduty.md)
- [Subscribe via PagerDuty](/tidb-cloud/monitor-alert-pagerduty.md)
- Connected: IM Ticket Creation and Update Subscription
- [Create Tickets and Subscribe to Ticket Updates via Slack](/tidb-cloud/connected-slack-ticket-creation.md)
- [Create Tickets and Subscribe to Ticket Updates via Lark](/tidb-cloud/connected-lark-ticket-creation.md)
Expand Down
51 changes: 47 additions & 4 deletions tidb-cloud/monitor-alert-email.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,22 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

> **Note:**
>
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential), [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.

## Prerequisites

<CustomContent plan="essential,dedicated">

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

</CustomContent>

<CustomContent plan="premium">

- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target {{{ .premium }}} instance in TiDB Cloud.

</CustomContent>

## Subscribe to alert notifications

To receive alert notifications, take the following steps. The steps vary by cluster plan.
Expand All @@ -36,7 +46,9 @@ To receive alert notifications, take the following steps. The steps vary by clus
- If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and then retry the connection.

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


Alternatively, you can also click **Subscribe** in the upper-right corner of the [**Alert**](/tidb-cloud/monitor-built-in-alerting.md#view-alerts) page of the cluster. You will be directed to the **Alert Subscription** page.

</CustomContent>

<CustomContent plan="essential">
Expand All @@ -56,11 +68,33 @@ To receive alert notifications, take the following steps. The steps vary by clus
- If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and then retry the connection.

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

</CustomContent>

Alternatively, you can also click **Subscribe** in the upper-right corner of the [**Alert**](/tidb-cloud/monitor-built-in-alerting.md#view-alerts) page of the cluster. You will be directed to the **Alert Subscription** page.

</CustomContent>

<CustomContent plan="premium">

> **Tip:**
>
> The alert subscription is for all alerts in the current {{{ .premium }}} instance. If you have multiple {{{ .premium }}} instances, you need to subscribe to each {{{ .premium }}} instance individually.

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target {{{ .premium }}} instance 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 **Email** from the **Subscriber Type** drop-down list.
5. Enter your email address.
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 then retry the connection.

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

Alternatively, you can also click **Subscribe** in the upper-right corner of the [**Alert**](/tidb-cloud/monitor-built-in-alerting.md#view-alerts) page of the {{{ .premium }}} instance. You will be directed to the **Alert Subscription** page.

</CustomContent>

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

## Unsubscribe from alert notifications
Expand All @@ -84,3 +118,12 @@ If you no longer want to receive alert notifications, please take the following
4. Click **Unsubscribe** to confirm the unsubscription.

</CustomContent>

<CustomContent plan="premium">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target {{{ .premium }}} instance 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.

</CustomContent>
49 changes: 46 additions & 3 deletions tidb-cloud/monitor-alert-flashduty.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,27 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

> **Note:**
>
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential), [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.

## Prerequisites

- The subscribing via Flashduty feature is only available for organizations that subscribe to the **Enterprise** or **Premium** [support plan](/tidb-cloud/connected-care-overview.md).

<CustomContent plan="essential,dedicated">

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

</CustomContent>

<CustomContent plan="premium">

- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target {{{ .premium }}} instance in TiDB Cloud.

</CustomContent>

## Subscribe to alert notifications

To receive alert notifications of clusters, take the following steps:
To receive alert notifications, take the following steps:

### Step 1. Generate a Flashduty webhook URL

Expand Down Expand Up @@ -48,6 +58,8 @@ Alert notification subscriptions vary by cluster plan.

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.

</CustomContent>

<CustomContent plan="essential">
Expand All @@ -68,9 +80,31 @@ Alert notification subscriptions vary by cluster plan.

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.

</CustomContent>

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.
<CustomContent plan="premium">

> **Tip:**
>
> The alert subscription is for all alerts in the current {{{ .premium }}} instance. If you have multiple {{{ .premium }}} instances, you need to subscribe to each {{{ .premium }}} instance individually.

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target {{{ .premium }}} instance 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 **Flashduty** from the **Subscriber Type** drop-down list.
5. Enter a name in the **Name** field and your Flashduty webhook URL in the **Webhook 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 {{{ .premium }}} instance. You will be directed to the **Alert Subscription** page.

</CustomContent>

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

Expand All @@ -95,3 +129,12 @@ If you no longer want to receive alert notifications, take the following steps.
4. Click **Unsubscribe** to confirm the unsubscription.

</CustomContent>

<CustomContent plan="premium">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target {{{ .premium }}} instance 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.

</CustomContent>
47 changes: 45 additions & 2 deletions tidb-cloud/monitor-alert-pagerduty.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,24 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

> **Note:**
>
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential), [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.

## Prerequisites

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

<CustomContent plan="essential,dedicated">

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

</CustomContent>

<CustomContent plan="premium">

- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target {{{ .premium }}} instance in TiDB Cloud.

</CustomContent>

## Subscribe to alert notifications

To receive alert notifications, take the following steps:
Expand Down Expand Up @@ -48,6 +58,8 @@ Alert notification subscriptions vary by cluster plan.

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.

</CustomContent>

<CustomContent plan="essential">
Expand All @@ -68,9 +80,31 @@ Alert notification subscriptions vary by cluster plan.

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.

</CustomContent>

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.
<CustomContent plan="premium">

> **Tip:**
>
> The alert subscription is for all alerts in the current {{{ .premium }}} instance. If you have multiple {{{ .premium }}} instances, you need to subscribe to each {{{ .premium }}} instance individually.

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target {{{ .premium }}} instance 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 {{{ .premium }}} instance. You will be directed to the **Alert Subscription** page.

</CustomContent>

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

Expand All @@ -95,3 +129,12 @@ If you no longer want to receive alert notifications, take the following steps.
4. Click **Unsubscribe** to confirm the unsubscription.

</CustomContent>

<CustomContent plan="premium">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target {{{ .premium }}} instance 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.

</CustomContent>
47 changes: 45 additions & 2 deletions tidb-cloud/monitor-alert-slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,24 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via

> **Note:**
>
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential), [TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium), and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.

## Prerequisites

- The subscribing via Slack feature is only available for organizations that subscribe to the **Enterprise** or **Premium** support plan.

<CustomContent plan="essential,dedicated">

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

</CustomContent>

<CustomContent plan="premium">

- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Instance Manager` access to the target {{{ .premium }}} instance in TiDB Cloud.

</CustomContent>

## Subscribe to alert notifications

### Step 1. Generate a Slack webhook URL
Expand Down Expand Up @@ -51,6 +61,8 @@ Alert notification subscriptions vary by cluster plan.

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.

</CustomContent>

<CustomContent plan="essential">
Expand All @@ -71,9 +83,31 @@ Alert notification subscriptions vary by cluster plan.

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.

</CustomContent>

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.
<CustomContent plan="premium">

> **Tip:**
>
> The alert subscription is for all alerts in the current {{{ .premium }}} instance. If you have multiple {{{ .premium }}} instances, you need to subscribe to each {{{ .premium }}} instance individually.

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target {{{ .premium }}} instance 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 **Slack** from the **Subscriber Type** drop-down list.
5. Enter a name in the **Name** field and your Slack 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 {{{ .premium }}} instance. You will be directed to the **Alert Subscription** page.

</CustomContent>

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

Expand All @@ -98,3 +132,12 @@ If you no longer want to receive alert notifications, take the following steps.
4. Click **Unsubscribe** to confirm the unsubscription.

</CustomContent>

<CustomContent plan="premium">

1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target {{{ .premium }}} instance 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.

</CustomContent>
Loading
Loading