Alarms and Notifications
ZSphere supports alarms for resource utilization, capacity usage, and predefined platform events. When core resources become abnormal, the platform can push alarm messages to specified endpoints so that administrators can identify and handle issues in time.
Alarm Service Infrastructure
- Monitoring System
- Provides time-series monitoring and alarms for resource utilization and capacity usage, collects predefined platform events and triggers event alarms, and supports custom alarms and alarm message templates.
- Notification Service
- Pushes alarm messages to system endpoints, email, DingTalk, Lark, WeCom, HTTP applications, Microsoft Teams, SNMP Trap receivers, and other endpoints.
Configuration Path
- Prepare management node resources and notification channels required by the Alarm Service.
- Create endpoints to receive alarm messages.
- Create or adjust message templates to standardize alarm message formats.
- Create resource alarms or event alarms and bind endpoints.
- View, acknowledge, silence, or restore alarm messages.
Prepare the Alarm Service
The Alarm Service depends on monitoring data collection, storage, and notification channels. Before enabling a large number of monitoring and alarm configurations, plan management node resources and alarm message delivery channels in advance.
Resource Planning Recommendations
- Plan a dedicated physical server as the management node for the platform.
- Because monitoring data may periodically consume system disk I/O resources, use an SSD as the system disk of the management node.
- To avoid high system disk utilization caused by large amounts of monitoring data, plan more than 1 TB of system disk space.
- If the system disk space is less than 500 GB, shorten the monitoring data retention period and set an appropriate monitoring data retention size in system parameters.
Notification Channel Preparation
Before creating alarms, prepare external message receivers based on the required notification method, such as email servers, group chat robots, HTTP applications, SMS services, Microsoft Teams, or SNMP Trap receivers.
Create an Email Endpoint
Before you begin
An email server has been added. For more information, see Add an Email Server.
Procedure
- In the navigation pane, choose .
- On the Endpoint page, click New Endpoint.
-
Configure the email endpoint.
Option Description Name Set the endpoint name. Description Enter a brief description for the endpoint. Type Select Email. Email Server Select an email server that has been added. Email Address Enter the email address that receives alarm messages. Message Language Set the notification language for alarm messages. Simplified Chinese and English are supported. - Review the configuration and click OK.
What to do next
After creating an endpoint, you can continue to configure message templates and alarms.Create a DingTalk Endpoint
Before you begin
- An Advanced license has been installed and is valid.
- A DingTalk group bot has been added and its webhook URL has been obtained.
Procedure
- In the navigation pane, choose .
- On the Endpoint page, click New Endpoint.
-
Configure the DingTalk endpoint.
Option Description Name Set the endpoint name. Description Enter a brief description for the endpoint. Type Select DingTalk. Address Enter the webhook URL of the DingTalk bot. Security Settings Select the security settings configured for the DingTalk bot, including Signature or Other (keywords or IP addresses). - Custom Keywords: Alarm messages must contain at least one custom keyword to be sent successfully. If you choose this method, make sure you add "Alarm" as the keyword. Otherwise, alarm messages will fail to send.
- IP Address: Only requests from within the specified IP address range will be processed by third-party applications. If you choose this method, add the management node IP address and VIP of the platform to the bot's IP allowlist to ensure that third-party applications receive alert messages correctly.
Mention Member Specify whether to mention group members after the alarm message is pushed. Options include Nobody, All, or Specified Members. When choosing Specified Members, add the mobile phone numbers of the group members. Message Language Set the notification language for alarm messages. Simplified Chinese and English are supported. - Review the configuration and click OK.
Create a Lark Endpoint
Before you begin
- An Advanced license has been installed and is valid.
- A Lark group bot has been added and its webhook URL has been obtained.
Procedure
- In the navigation pane, choose .
- On the Endpoint page, click New Endpoint.
-
Configure the Lark endpoint.
Option Description Name Set the endpoint name. Description Enter a description for the endpoint. Type Select Lark. URL Enter the webhook URL of the Lark bot. Security Settings Select the security settings configured for the Lark bot, including Signature or Other (keywords or IP addresses). - Custom Keywords: Alarm messages must contain at least one custom keyword to be sent successfully. If you choose this method, make sure you add "Alarm" as the keyword. Otherwise, alarm messages will fail to send.
- IP Address: Only requests from within the specified IP address range will be processed by third-party applications. If you choose this method, add the management node IP address and VIP of the platform to the bot's IP allowlist to ensure that third-party applications receive alert messages correctly.
Mention Member Specify whether to mention members when sending alarm messages through the bot. Options include Nobody, All, or Specified Members. When choosing Specified Members, add the user IDs of the designated members. Message Language Set the notification language for alarm messages. Simplified Chinese and English are supported. - Review the configuration and click OK.
Create a WeCom Endpoint
Before you begin
- An Advanced license has been installed and is valid.
- A WeCom group bot has been added and its webhook URL has been obtained.
Procedure
- In the navigation pane, choose .
- On the Endpoint page, click New Endpoint.
-
Configure the WeCom endpoint.
Option Description Name Set the endpoint name. Description Enter a brief description for the endpoint. Type Select WeCom. URL Enter the webhook URL of the WeCom bot. Mention Member Specify whether to mention members when sending alarm messages through the bot. Options include Nobody, All, or Specified Members. When choosing Specified Members, add the user IDs of the designated members. Message Language Set the notification language for alarm messages. Simplified Chinese and English are supported. - Review the configuration and click OK.
Create an SMS Endpoint
Before you begin
An AccessKey that includes the SMS service has been requested from the third-party platform.Procedure
- In the navigation pane, choose .
- On the Endpoint page, click New Endpoint.
-
Configure the SMS endpoint.
Option Description Name Set the endpoint name. Description Enter a brief desctiption for the endpoint. Type Select SMS. AccessKey ID Enter the AccessKey ID that identifies the user. AccessKey Secret Enter the secret key used to authenticate the user. SMS Address Enter the mobile phone number that receives SMS messages. - Review the configuration and click OK.
Create an HTTP Application Endpoint
Before you begin
The webhook URL of the HTTP application has been prepared, and the username and password have been configured as needed.Procedure
- In the navigation pane, choose .
- On the Endpoint page, click New Endpoint.
-
Configure the HTTP application endpoint.
Option Description Name Set the endpoint name. Description Enter a brief description for the endpoint. Type Select HTTP Application. URL Enter the HTTP service URL. Username Enter the username configured for the HTTP application. Password Enter the password for the username. - Review the configuration and click OK.
Create a Microsoft Teams Endpoint
Before you begin
- An Advanced license has been installed and is valid.
- The Incoming Webhook app has been added in Microsoft Teams and its webhook URL has been obtained.
Procedure
- In the navigation pane, choose .
- On the Endpoint page, click New Endpoint.
-
Configure the Microsoft Teams endpoint.
Option Description Name Set the endpoint name. Description Enter a brief description for the endpoint. Type Select Microsoft Teams. URL Enter the webhook URL obtained from Microsoft Teams. Message Language Set the notification language for alarm messages. Simplified Chinese and English are supported. - Review the configuration and click OK.
Create an SNMP Trap Receiver Endpoint
Before you begin
- An Advanced license has been installed and is valid.
- SNMP Management has been enabled and an SNMP Trap receiver has been added.
Procedure
- In the navigation pane, choose .
- On the Endpoint page, click New Endpoint.
-
Configure the SNMP Trap receiver endpoint.
Option Description Name Set the endpoint name. Description Enter a brief description for the endpoint. Type Select SNMP Trap Receiver. SNMP Trap Receiver Select an SNMP Trap receiver that has been added. - Review the configuration and click OK.
Manage Endpoints
About this task
After creating an endpoint, you can modify the endpoint, control its enabled state, adjust associated alarms, or delete the endpoint as needed.
Create a Message Template
A message template defines the text format used when an alarm pushes alarm messages to endpoints.
Before you begin
Before creating DingTalk, Lark, WeCom, or Microsoft Teams message templates, make sure an Advanced license has been installed and is valid.Procedure
- In the navigation pane, choose .
- On the Message Template page, click New Message Template.
-
Configure basic information for the message template.
Option Description Name Set the message template name. Description Enter a brief description for the message template. -
Configure template information.
Email, DingTalk, Lark, WeCom, HTTP application, and Microsoft Teams templates support the following options.
Option Description Type Select Email, DingTalk, Lark, WeCom, HTTP Application, or Microsoft Teams. Alarm Type Select resource alarm or event alarm. Alarm Message Title Set the title displayed in alarm messages. Alarm Message Text Set the text displayed in alarm messages. Recovery Message Title Set the recovery message title sent when a resource recovers from the alarm state. This option is supported only for resource alarms. Recovery Message Text Set the text displayed in recovery messages. This option is supported only for resource alarms. Default Template Select this option to set the current message template as the default template. SMS templates support the following options.
Option Description Signature Name Enter the SMS signature name requested from the third-party platform. Resource Alarm Template Set the resource alarm message template and enter the resource alarm template CODE. Event Alarm Template Set the event alarm message template and enter the event alarm template CODE. Default Template Set this template as the default template. After this is configured, all SMS messages are sent in this template format.
Note:
- Email and Lark alarm message templates must comply with Text syntax requirements.
- DingTalk and WeCom alarm message templates must comply with Markdown syntax requirements.
- HTTP application alarm message templates must comply with JSON syntax requirements.
- Microsoft Teams alarm message templates must comply with Microsoft Teams official webhook syntax requirements.
- For SMS alarm message templates, third-party SMS signatures and SMS templates must be requested in advance. Currently, only Alibaba Cloud SMS Service integration is supported. Any template changes require re-applying through the third-party service.
- Review the configuration and click OK.
Manage Message Templates
About this task
After creating a message template, you can modify its basic information, set or unset the default template, or delete the template as needed.
Alarm Rules
Resource Alarm Rules
| Option | Description | Example |
|---|---|---|
| Resource Type | The resource type monitored by the alarm. | VM |
| Metric Item | The monitoring metric type and name. | CPU Utilization |
| Resource | The resource object monitored by the alarm. | / |
| Operator | The comparison relationship between the detected metric value and the threshold, including >, ≥, <, and ≤. | > |
| Threshold | The threshold and unit for triggering the alarm. | 85% |
| Duration | Sends an alarm message after the alarm is continuously triggered for the specified time. Valid values include 30 seconds, 1 minute, 5 minutes, 10 minutes, 30 minutes, 1 hour, and custom. | 5 minutes |
| Alarm Interval | The interval for repeated notifications after an alarm is generated, including Only Once, Every 1 Hour, and custom. | Every 1 Hour |
| Severity | The alarm message level, including Emergent, Major, and Minor. | Major |
| Recovery Notification | Sends one recovery notification when the monitored resource recovers from the alarm state to normal state. | / |
Event Alarm Rules
| Option | Description | Example |
|---|---|---|
| Resource Type | The resource type monitored by the alarm. | Data Storage |
| Metric Item | The monitoring metric name. | Data Storage Disconnected |
| Severity | The alarm message level, including Emergent, Major, and Minor. | Emergent |
Create a Resource Alarm
Resource alarms monitor time-series data of resources in the platform.
Before you begin
- You can use system parameters to control default alarm behavior.
- Some alarm items require VMTools to be installed on VMs before monitoring and alarming can be performed.
Procedure
- In the navigation pane, choose .
- On the Resource Alarm page, click New Resource Alarm.
-
Configure the resource alarm.
Option Description Name Set the resource alarm name. Description Enter a brief description for the resource alarm. Resource Type Select a resource type that supports alarms. Metric Item Select an alarm item based on the resource type. Some alarm items require you to select resources and set alarm trigger rules. Alarm Interval Select an alarm interval type, including Only Once and Repeat. Severity Set the alarm message level, including Emergent, Major, and Minor. Alarm Recovery Notification After this option is enabled, the system sends one recovery notification when any resource monitored by the alarm recovers from the alarm state. Endpoint Select the endpoint that receives alarm messages. A system alarm endpoint is provided by default, and custom endpoints can also be selected. - Review the configuration and click OK.
Create an Event Alarm
Event alarms monitor predefined events in the platform.
Procedure
- In the navigation pane, choose .
- On the Event Alarm page, click New Event Alarm.
-
Configure the event alarm.
Option Description Resource Type Select a resource type that supports event alarms. Metric Item Select an event alarm item based on the resource type. Severity Set the alarm message level, including Emergent, Major, and Minor. Endpoint Select the endpoint that receives alarm messages. - Review the configuration and click OK.
Manage Alarms
About this task
After creating an alarm, you can modify, enable, disable, adjust endpoints, or delete the alarm as needed.
View Alarm Messages
About this task
Triggered alarm messages can be viewed on the unified Alarm Message page, on specific resource details pages, and in the bottom task and alarm pane. The Alarm Message page displays overall platform alarm information in a dashboard view, making it easier to compare alarms across different dimensions.
Procedure
- In the navigation pane, choose .
-
View triggered alarm messages.
- Alarm Statistics in Recent 1 Week: Displays alarm statistics from the last seven days in a bar chart. The sampling interval is 8 hours. Hover over the bar chart to view the number of alarms at different levels.
- Alarm Distribution in Recent 1 Week: Displays the proportion of resource alarms from the last seven days in a bar chart. Hover over the bar chart to view the number of alarms for different resource types.
- Alarm Message List: Displays up to 1,000 alarm messages. You can filter alarm messages by resource type and time.
Acknowledge Alarm Messages
Acknowledging an alarm message indicates that the administrator has noticed the alarm.
Procedure
- In the navigation pane, choose .
-
In the Triggered Alarms list, select an alarm message and click Acknowledge.
- Acknowledged alarm messages are not displayed in Triggered Alarms. You can view them in all alarm messages.
- After acknowledgement, if the alarm issue is not handled in time, the alarm continues to trigger and push messages according to its rules. To prevent repeated alarm message pushes, set a silence period as needed.
Set a Silence Period
A silence period temporarily pauses the push of a specific alarm message.
Procedure
- In the navigation pane, choose .
- In the Triggered Alarms or All Alarms list, select an alarm message and click .
- In the Set Silence Period dialog, choose a silence period.
Restore Alarm Messages
After you manually restore an alarm message, alarm messages in a silence period can continue to be pushed.
Procedure
- In the navigation pane, choose .
- In the Triggered Alarms or All Alarms list, select an alarm message and click .
