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.

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

View alerts

In TiDB Cloud, you can view both active and closed alerts on the Alerts page.

1. In the TiDB Cloud console, navigate to the Clusters page of your project.

   Tip

   If you have multiple projects, you can switch to the target project from the ☰ hover menu in the upper-left corner.

2. Click the name of the target cluster. The cluster overview page is displayed.

3. Click Alerts in the left navigation pane.

4. The Alerts page displays the active alerts by default. You can view the information of each active alert such as the alert name, trigger time, and duration.

5. If you also want to view the closed alerts, just click the Status drop-down list and select Closed or All.

Edit alert rules

In TiDB Cloud, you can edit the alert rules by disabling or enabling the alerts or updating the alert threshold.

1. On the Alerts page, click Edit Rules.

2. Disable or enable alert rules as needed.

3. Click Edit to update the threshold of an alert rule.

   Tip

   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, consider using a third-party monitoring and alerting integration.

Subscribe to alert notification emails

To get alert notification emails of clusters in your project, take the following steps:

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.

2. In the left navigation pane of the Clusters page, do one of the following:

   • If you have multiple projects, switch to the target project, and then click Admin > Alert Subscription.
   • If you only have one project, click Admin > Alert Subscription.

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

2. In the left navigation pane of the Clusters page, do one of the following:

   • If you have multiple projects, switch to the target project, and then click Admin > Alert Subscription.
   • If you only have one project, click Admin > Alert Subscription.

3. Locate your email address and click Unsubscribe.

4. Click Delete to confirm the unsubscription.

TiDB Cloud built-in alert conditions

The following table provides the TiDB Cloud built-in alert conditions and the corresponding recommended actions.