Create an alert item

OceanBase Cloud Platform (OCP) provides built-in alert items to meet your basic business monitoring requirements. You can also customize alert items by referring to this topic. For more information about the built-in alert items, see Alert Reference.

Prerequisites

The logged-on user in the OCP console uses the ADMIN or ALARM_MANAGER role.

Procedure

1. Log on to the OCP console.

2. In the left-side navigation pane, choose System Management > Alerts .

3. On the Alert Item Configuration tab, click Create Alert Item in the upper-right corner.

4. Specify fields in the Rule Information section of the alert item.

   1. Specify Alert Item Scope and Matched Object .

   2. Specify Trigger Condition of alerts.

      • Operation Rules

        For alerts triggered based on monitoring expressions, you must configure operation rules for alert reporting.

        • Alert Metrics: Select a metric from the drop-down list. For more information about specific metrics, see Alert Reference.

        • Operation Rules: You can configure multiple operation rules as needed. The system reports alerts of different levels based on the configured operation rules. You can configure at most five rules because the threshold and level in a rule cannot overlap with those in another rule.

      • No Operation Rules

        For alerts not triggered based on monitoring expressions, you must configure the alert level.

   3. Specify Alert Cycle .

      Alert Cycle is a detection cycle, in which the system detects whether the trigger condition is met. The following uses the default detection cycle of 10 seconds as an example:

      • The system detects whether the trigger condition is met once every 10 seconds. If so, the alert is reported.

      • After the alert is reported, the system continues detecting whether the trigger condition is met once every alert cycle . If so, the alert will not be eliminated.

   4. Specify Elimination Cycle .

5. Specify fields in the Basic Information section of the alert item.

   1. Specify Alert Item Name .

      Third-party applications identify and connect to alert items in OCP through their names specified in Alert Item Name . An alert item name can contain only letters, digits, and underscores (_). We recommend the following rules for naming alerts:

      • Use ob_cluster_ as the prefix for alerts related to OceanBase clusters.

      • Use ob_tenant_ as the prefix for alerts related to OceanBase Database tenants.

      • Use ob_proxy_ as the prefix for alerts related to OBProxy.

   2. Specify Description .

      Briefly describe the purpose of the alert.

   3. Specify Alert Overview Template as prompted.

      The alert overview template is referenced by the template field of the channel, and corresponds to the alarm_summary variable.

   4. Specify Alert Details Template as prompted.

      The alert details template is referenced by the template field of the channel, and corresponds to the alarm_description variable.

6. Click Submit .