Configure monitoring alarms

Limitations

This feature is available only in the Professional Edition.

Configure monitoring alarms

Access

1. From a dashboard

   You can open the Metric Monitoring configuration page in the following ways:

   1. From the dashboard Edit page:

   2. From the dashboard's Preview after Publishing page:

      1. Directly click Create Monitor.

      2. Go to Chart > Metric Monitoring > Create Monitor.

      3. Go to Metric Monitoring, select the corresponding Chart, and then click Create Monitor.

      4. Go to Metric Monitoring, click Create Monitor, select the corresponding Chart, and then click OK.

      5. Go to Card Kanban and click Create Monitor.

         

• From a spreadsheet

  You can open the Metric Monitoring configuration page in the following ways:

  1. Click the icon to open the Preview view, or click the icon to open the spreadsheet preview in a new window.

     

  2. On the spreadsheet preview page, click Metric Monitoring > Create Monitor.

     

Monitoring metric settings

On the Metric Monitoring Configuration page, configure the monitoring metrics, alarm rules, and push notifications.

1. This example shows how to set a rule for a line chart. First, configure the monitoring metrics.

   

   1. Select a metric target (①) to monitor. To adjust the metric, click the icon (②) on the right side of the metric box to configure its data display format and field display name (③).

      

      Note

      When the monitored object is a details table or spreadsheet detail data, you can set the aggregation method.

      

   2. Click the icon to configure a filter condition. Monitoring, computation, and alarms will apply only to data that meets this condition. If the line chart is associated with a query control or has filters configured and is in a filtered state, the system automatically synchronizes the corresponding filter conditions. You can open the filter condition settings panel to add, edit, or delete filter conditions.

      

   3. You can monitor a metric target directly or split by dimension. Select the Dimension Split checkbox on the far right of the metric box to specify the dimensions to monitor. After you select a split dimension, by default, the system monitors all dimension values and dynamically loads new dimension values from the database.

      

      You can also manually select specific dimension values. For example, if you select region as the split dimension and choose East China and North China as the dimension values, the system monitors the metric values for East China and North China separately.

      

      Note

      • You can select dimensions from the chart and from query controls that have active filters.

      • You can add up to five split dimensions.

      • You cannot use date and time fields to split by dimension.

      • A maximum of 10,000 dimension value combinations are supported. Any combinations beyond this limit are not monitored.

   4. After setting the metric target, select a detection frequency. You can choose from Hourly, Daily, Weekly, and Monthly granularities. You can select multiple options for Daily, Weekly, and Monthly granularities.

      

   5. You can also enable fluctuation analysis, which is disabled by default. Fluctuation analysis is available when the aggregation method for the monitored metric is Sum or Count. Then, select a comparison object and an analysis dimension. When enabled, related data is displayed in the metric details.

      

2. After configuring the monitoring metrics, set the alarm rule for the corresponding metric.

   1. When the filter field is a metric target, you can add alarm filter conditions based on the metric value or YoY and PoP change.

      For example, if the metric target Profit Amount is monitored at a daily granularity, and you select Profit Amount as the filter field in the alarm rule, you can click the icon on the right to select an aggregation method. Options include Metric Value, day-over-day change, same-day-of-week comparison, and Day-over-month Comparison. After making a selection, configure the filter method and threshold value.

      

      Note

      The options for YoY and PoP change depend on the detection frequency and include the following:

      • hour-over-hour change: Compares with the previous hour.

      • same-time-of-previous-day comparison: Compares with the same time on the previous day. For example, 8:00 today is compared with 8:00 yesterday.

      • day-over-day change: Compares with the previous day.

      • week-over-week change: Compares with the previous week.

      • month-over-month change: Compares with the previous month.

      • same-day-of-week comparison: Compares a specific day of the week with the same day in the previous week. For example, this Wednesday is compared with last Wednesday.

      • day-over-month comparison: Compares a specific day of the month with the same day in the previous month. For example, the 15th of this month is compared with the 15th of last month.

   2. When the filter field is not a metric target, you can only add alarm filter conditions based on the metric value. The rule supports switching between AND/OR logical operators and adding multiple conditions under an operator.

      

Push notification settings

After you finish configuring the monitoring metrics, you can configure push notifications for alarms.

1. You can enable or disable Push Message Notification. If you select Enable, you can configure the following parameters:

Parameter	Description
Push Channel	Channel Click Add Push Channel to add one or more push channels. Supported channels include DingTalk, WeCom, Lark, Email, SMS, and Custom Channel. Before using DingTalk, WeCom, or Lark for alarms, make sure your account is bound to the corresponding mini app. For more information, see (Public Cloud) Enable a DingTalk mini app, (Public Cloud) Enable a WeCom mini app, and (Public Cloud) Enable a Lark self-built mini app. To use Email and SMS for alarms, bind an email address and phone number in Account Settings & Management > Account Binding. Before using the Custom Channel for alarms, make sure you have added a custom bot. Bot channels include Custom Channel and DingTalk Bot Channel: After configuring a custom channel, you can push messages to an external endpoint. For more information, see Custom Channel. After configuring a DingTalk bot channel, you can use a pre-configured DingTalk bot to receive messages. For more information, see DingTalk Bot Channel. Push to When the push channel is DingTalk, WeCom, or Lark, you can push notifications to an individual or a group. Recipient You can configure multiple recipients, including users and user groups. Important Monitoring alarms can only be sent to users within your organization. This parameter is displayed only when the alarm method is Email, SMS, DingTalk Work Notification, Lark Notification, or WeCom Notification. Recipient Group The "Recipient Group" setting is available for DingTalk, WeCom, and Lark groups. For Lark, after you search for and add the "Quick BI mini app" bot to a group, you can send alarm messages to the group without obtaining a webhook URL or secret key. Just select the group in the "Lark Group Bot" tab. If you have created a "DingTalk Group Webhook", "WeCom Group Webhook", or "Lark Group Webhook" in Organization Management > Push Channel Management, you only need to select it from the "Group Bot Webhook" tab under Recipient Group.
Webhook	You only need to configure this parameter if you select "Custom Webhook" on the "Group Bot Webhook" tab. To obtain a bot webhook URL, see DingTalk Bot Channel.
Secret Key	This parameter is required when the push channel is DingTalk and you send notifications to a group. The secret key is the signature key value obtained from the DingTalk Bot Channel.
Alarm Time	You can choose to send an alarm immediately upon detecting an anomaly or consolidate alarms at a custom interval. Note This option is displayed only when the detection frequency is set to an hourly or daily granularity. Consolidating alarms at a custom interval is not supported when the push channel is Custom Channel.
Message Content	You can select Default or Custom. In the Default mode, you cannot modify the message title and description. In the Custom mode, you can modify the Message Title (①) and Message Description (②), and preview the message in the Message Preview (③) pane. The Message Description supports adding parameters, configuring field settings, and using formatting options such as bold, italics, underline, font color, alignment, line spacing, unordered lists, ordered lists, inserting links, adding metrics, and using the @ mention feature. Add Parameter You can add the following parameters. Field Settings Select a metric value to set its data display format and calculation method. @ Mention Click @ or type @ directly to select a member to mention from the dropdown list. Note The @ mention feature is supported only for alarm messages sent to a Lark group through the "Quick BI mini app" bot. For all other channels, the @ symbol is parsed as plain text. Note The message description is limited to 100 characters. If you include SMS as a push channel, the limit is 25 characters. Custom message content is not supported for custom channels.
Message Attachment	By default, images are not attached. Enabling this option may cause a delivery delay of about 10 minutes. After you select Attach, you can choose to use a metric detail preview or upload a custom image for the thumbnail. For a custom image, you can upload an image from your local machine or by using an image link.
Report Link	You can select Default or Custom. The default is the link to the corresponding dashboard, which you can modify by selecting Custom.

2. After you finish configuring the push notification settings, you can select a recipient in the Message Sending Test section to perform a test.

   

Publish the monitoring rule

After configuring the monitoring metrics and push notification settings, you can configure the publish rule and set the historical data retention period.

• Exception Settings

  If an exception (such as an empty query result, a query error, or an invalid monitoring task) occurs five consecutive times, the system automatically stops the metric monitoring task.

  • Ignore empty query results: If enabled, the system does not treat empty query results as exceptions. For example, assume the primary monitored metric is Payment Amount, and the alarm rule is also set to monitor Number of Buyers or Per Customer Transaction. If the query for Payment Amount returns an empty result, the system still checks the alarm rules for Number of Buyers and Per Customer Transaction.

  • Notify owner of other exceptions: If enabled, the system notifies the monitor's owner if no data is retrieved, a query error occurs, or the monitoring task becomes invalid. The system stops the task after five consecutive failures.

• Publish Settings

  • Allow users other than recipients to view: If enabled, authorized users can view this metric monitoring rule and subscribe to its alarm messages.

• Advanced Settings

  • Historical data retention: Set the retention period for historical data. The default is 30 days. A maximum of 1,000 data records can be retained.

After you configure the settings, click Publish Immediately in the lower-right corner to publish the monitoring rule.