DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›User GuideZCF

Cloud Monitoring

Performance Analysis

Performance Analysis displays the performance metrics of key resources monitored externally or internally in the Cloud. You can view the performance analysis or export the analysis report as needed to improve the O&M efficiency.

View Performance Analysis

On the main menu of ZStack Cloud, choose Platform O&M > Cloud Monitoring > Monitoring Chart > Performance Analysis. Then, the Performance Analysis page is displayed.

Figure 1. View Performance Analysis


The Performance Analysis page consists of filters and analysis reports.
  • Filters: Supports basic filtering and advanced filtering.
    • Basic filtering: Allows you to filter by resource, monitoring methods, and time spans.
      • Resource: Supports VM instances, VPC vRouters, hosts, backup storages, L3 networks, and virtual IPs.
      • Monitoring method: Supports external monitoring and internal monitoring.
        • External monitoring: Obtains the VM performance data, such as the CPU, memory, disk I/O, and NIC data from the host by using libvirt.
        • Internal monitoring: Obtains the VM performance data, such as the CPU, memory, and disk capacity directly by using the agent and pushes the data to the host. To using internal monitoring, install the agent first.
        Note: The memory data obtained by using internal monitoring is more accurate than that obtained by external monitoring. Therefore, we recommend that you use internal monitoring to monitor the memory data.
      • Time span: You can select a time span to view the monitoring data. Available time spans: 15 minutes, 1 hour, 1 week, and custom.
    • Advanced filtering: Allows you to further filter by filter item, resource scope, and owner scope.
      • Filter item: Allows you to sort and view resources based on monitoring metrics and metric values (for example, CPU utilization >= 75%).
      • Resource range: Allows you to view the monitoring information of all resources on the Cloud or specify a resource to view its own monitoring information.
      • Owner range: Allows you to view the monitoring information of all owners in the Cloud or specify an owner to view the monitoring information.
  • Analysis report: Generates an analysis report based on the filter conditions.
    • Allows you to sort the items by resource name or monitoring metric.
    • Allows you to export all the report information or export the information on the current page in CSV format.
    • Allows you to customize the number of items to be displayed on each page. By default, 10 items are displayed per page.
    Note:
    • The VM analysis report page allows you to stop a VM instance.
    • The VM analysis report page allows you to filter VM instances based on the VM state.
    • The VM/VPC vRouter analysis report allows you to customize the columns to be displayed.
    • When you export a VM or VPC vRouter analysis report, you can choose to export the average, maximum, or minimum values of the metrics as needed.
The following table lists the monitoring metrics of each resources.
Resource Type Monitoring Method Monitoring Metric Destription
VM Instance/VPC vRouter External Monitoring Default IPv4 Displays the default IPv4 address of each VM instance in the current zone by default.
Note: This metric does not apply to VPC vRouters currently.
Volume Actual Size Displays the volume actual size of each VM instance in the current zone by default.
Note: This metric does not apply to VPC vRouters currently.
Total Volume Capacity Displays the total volume capacity of each VM instance in the current zone by default.
Note: This metric does not apply to VPC vRouters currently.
CPU Utilization Displays the average CPU utilization of all the VM instances/VPC vRouters in the current zone by default.
Note: If a VM instance or VPC vRouter has more than one CPU, the CPU utilization might be greater than 100%.
Memory Utilization Displays the average memory utilization of all the VM instances/VPC vRouters in the current zone by default.
Disk Read Rate Displays the average disk read speed of all the VM instances/VPC vRouters in the current zone by default.
Disk Write Rate Displays the average disk write speed of all the VM instances/VPC vRouters in the current zone by default.
NIC In Rate Displays the average NIC in rate of all the VM instances/VPC vRouters in the current zone by default.
NIC Out Rate Displays the average NIC out rate of all the VM instances/VPC vRouters in the current zone by default.
Disk Read IOPS Displays the average disk read IOPS of all the VM instances/VPC vRouters in the current zone by default.
Disk Write IOPS Displays the average disk write IOPS of all the VM instances/VPC vRouters in the current zone by default.
NIC In Packets Displays the average number of received NIC packets of all the VM instances/VPC vRouters in the current zone by default.
NIC Out Packets Displays the average number of sent NIC packets of all the VM instances/VPC vRouters in the current zone by default.
NIC In Errors Rate Displays the average rate of received NIC errors of all the VM instances/VPC vRouters in the current zone by default.
NIC Out Errors Rate Displays the average rate of sent NIC errors of all the VM instances/VPC vRouters in the current zone by default.
Internal Monitoring Default IPv4 Displays the default IPv4 address of each VM instance in the current zone by default.
Note: This metric does not apply to VPC vRouters currently.
Volume Actual Size Displays the volume actual size of each VM instance in the current zone by default.
Note: This metric does not apply to VPC vRouters currently.
Volume Actual Size Displays the volume actual size of each VM instance in the current zone by default.
Note: This metric does not apply to VPC vRouters currently.
CPU Utilization Displays the average CPU utilization of all the VM instances/VPC vRouters in the current zone by default.
CPU Occupancy Rate (System Process) Displays the average CPU occupancy rate (system process) of all the VM instances/VPC vRouters in the current zone by default.
CPU Occupancy Rate (User Process) Displays the average CPU occupancy rate (user process) of all the VM instances/VPC vRouters in the current zone by default.
CPU Occupancy Rate (Waiting) Displays the average CPU occupancy rate (waiting) of all the VM instances/VPC vRouters in the current zone by default.
CPU Idle Rate Displays the average CPU idle rate of all the VM instances/VPC vRouters in the current zone by default.
Memory Utilization Displays the average memory utilization of all the VM instances/VPC vRouters in the current zone by default.
Memory Idle Rate Displays the average memory idle rate of all the VM instances/VPC vRouters in the current zone by default.
Disk Utilization Displays the average disk utilization of all the VM instances/VPC vRouters in the current zone by default.
Disk Idle Rate Displays the average disk idle rate of all the VM instances/VPC vRouters in the current zone by default.
Host / Disk Read IOPS Displays the disk read IOPS of all the hosts in the current zone by default.
/ Disk Write IOPS SDisplays the write read IOPS of all the hosts in the current zone by default.
/ Used Disk Storage Percentage Displays the used disk storage percentage of all the hosts in the current zone by default.
/ Disk Usage Displays the disk usage of all the hosts in the current zone by default.
/ NIC In Rate Displays the NIC in rate of all the hosts in the current zone by default.
/ NIC Out Rate Displays the NIC out rate of all the hosts in the current zone by default.
/ NIC In Errors Rate Displays the NIC in erros rate of all the hosts in the current zone by default.
/ NIC Out Errors Rate Displays the NIC out errors rate of all the hosts in the current zone by default.
/ CPU Utilization Average Displays the average CPU utilization of all the hosts in the current zone by default.
/ Memory Utilization Displays the memory utilization of all the hosts in the current zone by default.
/ Disk Read Speed Displays the disk read speed of all the hosts in the current zone by default.
/ Disk Write Speed Displays the disk write speed of all the hosts in the current zone by default.
/ NIC In Speed Displays the NIC in speed of all the hosts in the current zone by default.
/ NIC Out Speed Displays the NIC out speed of all the hosts in the current zone by default.
Backup Storage / Backup Storage Capacity Available Percent Displays the percentage of available capacity of all the backup storages in the current zone by default.
L3 Network / Used IPs (IPv4) Displays the number of used IPv4 IPs of all L3 networks in the current zone by default.
/ Used IP Percentage (IPv4) Displays the percentage of used IPv4 IPs of all L3 networks in the current zone by default.
/ Available IPs (IPv4) Displays the number of available IPv4 IPs of all L3 networks in the current zone by default.
/ Available IP Percentage (IPv4) Displays the percentage of available IPv4 IPs of all L3 networks in the current zone by default.
Virtual IP / Inbound Traffic Displays the inbound traffic of all virtual IP addresses in the current zone by default.
/ Inbound Traffic Rate Displays the inbound traffic rate of all virtual IP addresses in the current zone by default.
/ Outbound Traffic Displays the outbound traffic of all virtual IP addresses in the current zone by default.
/ Outbound Traffic Rate Displays the outbound traffic rate of all virtual IP addresses in the current zone by default.

Export Analysis Report

You can export all the analysis information of a resource or only information on the current page based on the filter conditions. For VM instance and VPC vRouters, you can customize the monitoring metrics to be exported and choose to export their average values, maximum values, or minimum values as needed.

On the main menu of ZStack Cloud, choose Platform O&M > Cloud Monitoring > Monitoring Chart > Performance Analysis. Then, the Performance Analysis page is displayed. Taking VM instance as an example, on the analysis report area, click Export CSV and choose Current Page or All. Then, the export page is displayed.

Figure 2. Export Analysis Information on the Current Page


  • The export page displays the selected resource, monitoring method, time span, and all the monitoring metrics of the resource.
  • By default, metrics displayed in the VM/VPC vRouter list are automatically selected. You can deselect them or select the average, maximum, or minimum value of other metrics.
  • You can select all the average, maximum, and minimum values or empty your selections with one click.

Capacity Management

Capacity Management visualizes the capacities and usages of key resources in the Cloud. You can use this feature to improve O&S efficiency.

Capacity Management displays the physical capacities and usages of key resources by using cards, and displays Top 10 resource capacities and usages, providing you a commanding view of your resource usages and greatly improving O&S efficiency.

Management Node Monitoring

Management Node (MN) monitoring allows you to view the health status of each management node when you use multiple management nodes to achieve high availability.

Monitoring and Alarm

The Monitoring and Alarm feature monitors time-series data and events and sends alarm messages to specified endpoints by using SNS. Resource alarms, event alarms, and extended alarms are supported. The supported endpoints include the system, emails, DingTalk, HTTP applications, text messages, and Microsoft Teams. For some resource alarms, you need to install the agent before they can work as expected.

Concepts

  • Monitoring System:
    A monitoring system provides the following features:
    • Monitor the following two types of time-series data:
      • Resource utilizations such as CPU utilization of VM instances and memory utilization of hosts
      • Resource capacities such as available number of IP addresses and total number of running VM instances
    • Event collection: collects events predefined on the Cloud, such as host disconnection and VM HA enabling.
    • Alarm: triggers alarms on time-series data or events.
    • Audit: records all operations and allows queries.
    • Customization: allows you to customize alarms and message templates and use predefined alarm templates and resource groups.
      • The following three types of alarms are supported:
        • Resource alarm: triggers alarms on time-series data. For example, you can configure an alarm for VM instances. If the CPU utilization of a VM instance exceeds 80% by five consecutive minutes, send an alarm message to an email address.
        • Event alarm: triggers alarms on events, also called event subscription. For example, you can configure an alarm for host disconnection. If a host is disconnected, an alarm message is sent to DingTalk.
        • Extended alarm: receives alarm messages from message sources. For example, if a Ceph Enterprise storage pool is downgraded, an alarm message is sent to the system of the Cloud.
      • A message template specifies the text template of a resource alarm message or event alarm message sent to an SNS system.
        • A message template and message recovery template are provided by the system. If you do not create a template, the system uses the predefined templates.
        • You can create multiple message templates and can set only one template as the default template. Messages are formatted by using the default template.
        • You can use ${} in a template to quote variables configured in an alarm or event.
        • You can configure email, DingTalk, text message, and Microsoft Teams as an endpoint in a message template. Messages sent by using email, DingTalk, text message, or Microsoft Teams are sent in the specified format.
      • A message source is used to take over extended alarm messages. If you configure alarms for message sources, extended alarm messages can be sent to various endpoints. This enables centralized management of alarm messages and improves O&M efficiencies. You can configure a message source to take over alarm messages of Ceph Enterprise.
      • An alarm template is a template of alarm rules. If you associate an alarm template with a resource group, an alarm is created to monitor the resources in the group.
      • A resource group consists of resources grouped based on your business needs. If you associate an alarm template with a resource group, the alarm rules specified by the template take effect on all the resources in the group.
  • SNS:

    SNS sends alarm messages to the specified endpoints. The supported types of endpoints include the system, emails, DingTalk, HTTP applications, text messages, and Microsoft Teams.

    Endpoints:
    • The system provides the system-type endpoint. If you associate an alarm with this endpoint, alarm messages will be displayed below the Recent Message button in the top right corner of the UI.
    • You can also create an endpoint of the email, DingTalk, HTTP application, text message, or Microsoft Teams type.

Characteristics

ZStack Cloud monitoring and alarm has the following characteristics:
  • Provides rich metric items to comprehensively monitor and alarm the core resources as well as events of the Cloud platform.
  • Supports types of endpoints including system, emails, DingTalk, HTTP application, text messages, and Microsoft Teams for subscription topics. You can choose an appropriate endpoint to receive alarm messages according to the actual situation.
  • One alarm can monitor multiple resources at the same time.
  • Emails, DingTalk, text messages, and Microsoft Teams support customized alarm message templates. You can set alarm message templates on demand and quickly locate key information from alarm messages.
  • Supports for creating a template of alarm rules. If you associate an alarm template with a resource group, an alarm is created to monitor the resources in the group.

Scenarios

The function of monitoring and alarm monitors the core resources and events of the Cloud platform and sets up an alarm receiving mechanism. When core resources are abnormal, the monitoring and alarm will make real-time responses according to the alarm level to help O&M personnel quickly locate and solve the problem.

Global Setting

  • Monitoring data is retained locally for 6 months by default, and you can customize the monitoring data retention period in the basic settings as follows:

    On the main menu of ZStack Cloud, choose Settings > Global Setting > Basic. Then, the Basic tab is displayed. You can set Monitoring Data Retention Period. Enter an integer between 1 and 12. Default: 6. Unit: month.

  • Monitoring data is retained locally in a size of 50GB by default, and you can customize the monitoring data retention size in the basic settings as follows:

    On the main menu of ZStack Cloud, choose Settings > Global Setting > Basic. Then, the Basic tab is displayed. You can set Monitoring Data Retention Size based on your needs. Default: 50 GB.

  • ZStack Cloud supports receiving extended alarm messages. On the main menu, choose Settings > Global Setting > Advanced. Then, the Advanced tab is displayed. You need to turn on the Extended Alarm Notification switch to use the extended alarm function.

Alarm

Create an Alarm

On the main menu of ZStack Cloud, choose Platform O&M > Cloud Monitoring > Alarm Service > Alarm. Then, the Alarm page is displayed.

The following lists the three alarm creation scenarios:
  • Create a resource alarm
  • Create an event alarm
  • Create an extended alarm

Create Resource Alarm

The system provides default resource alarms. In addition, you can customize resource alarms based on your needs. On the Resource Alarm tab, click Create Resource Alarm. Then, the Create Resource Alarm page is displayed.

On the displayed page, set the following parameters:
  • Name: Enter a name for the resource alarm.
  • Description: Optional. Enter a description for the resource alarm.
  • Resource Type: Select a resource type. Valid values: VM Instance, Baremetal Instance, Elastic Baremetal Instance, VPC vRouter, Image, Backup Storage, System Data Directory, Host, L3 Network, Volume, VIP, Primary Storage, Listener, Management Node, Project Resource, and CDP Task.

    Note that you can select Project Resource and CDP Task only after you have purchased Tenant Management License and Continuous Data Protection (CDP) License, respectively.

  • Metric Item: Select a metric item of the selected resource type.
    Note:
    • Multiple metric items are available for every type of resources. You can select a metric item based on your business needs.
    • Some metric items are associated with additional parameter settings. If you select such metric items, you need to configure the additional parameter settings.
    • Some metrics items are available only after the agent is installed on the related resource. .
    • If you need to monitor memory data, we recommend that you use internal monitoring for this purpose. This is because internal monitoring yields a more accurate memory data than external monitoring.
    • You can create resource alarms for key cloud resources such as VM instances, hosts, and primary storage on the details page of the resources.
  • Alarm Coverage: Select one or more resources on which the alarm takes effect.
    • If you select multiple resources of the specified type, all the resources for which the alarm is configured are monitored. If the trigger condition of a resource is met, the alarm is triggered.
    • If you select only one resource of the specified type, the resource for which the alarm is configured is monitored. If the trigger condition of the resource is met, the alarm is triggered.
      Note:
      • You can configure fine-grained alarms for a resource.
      • For example, you can configure an alarm to monitor the utilization of a CPU of a VM instance.
  • Alarm Trigger Rule: Select a comparison symbol and specify a threshold and duration.
  • Alarm Interval: Select an alarm interval.
    • Only 1 time:
      • Alarm is triggered only once for a resource.
        For example,
        • Assume that you configure an alarm for multiple resources. If the trigger condition of a resource is met, the alarm is triggered. After that, even if the trigger condition of this resource is met again, the alarm is no longer triggered.

          Assume that you configure an alarm for a resource. If the trigger condition of the resource is met, the alarm is triggered. After that, even if the trigger condition of the resource is met again, the alarm is no longer triggered.

      • The alarm message is sent to the endpoint (if specified) for only once. In addition, the alarm message is displayed on Message Center only once.
      • If the resource recovers but later meets the trigger condition again, the one-time alarm is triggered again.
    • Repetitive Alarm：
      • Alarm is triggered multiple times for a resource.
        For example,
        • Assume that you configure an alarm for multiple resources. If the trigger condition of a resource is met, the alarm is triggered. If the resource keeps meeting the trigger condition, the alarm is repetitively triggered based on the alarm interval.

          Assume that you configure an alarm for a resource. If the trigger condition of the resource is met, the alarm is triggered. If the resource keeps meeting the trigger condition, the alarm is repetitively triggered based on the alarm interval.

      • Each time the alarm is triggered, the alarm message is sent to the endpoint (if specified). In addition, every alarm message is displayed on Message Center.
  • Emergency Level: Set an emergency level. Valid values: Emergent, Major, and Info. Alarms of different emergency levels correspond to alarm messages of different emergency levels.
  • Alarm Recovery Notification: Optional. If enabled, when a resource monitored by a resource alarm recovers from alarmed status, the system receives a notification. The recovery notification is sent according to the default recovery message template. You can customize the message content on the Message Template page.
  • Endpoint: Optional. If specified, alarm messages are sent to the specified endpoint.
    Note:
    • You can specify multiple endpoints.
    • You can specify the system endpoint or customize an endpoint.
Figure 3. Create Resource Alarm


Create Event Alarm

The system provides default event alarms. In addition, you can customize event alarms based on your needs. On the Event Alarm tab, click Create Event Alarm. Then, the Create Event Alarm page is displayed.

On the displayed page, set the following parameters:
  • Resource Type: Select a resource type. Valid values: VM Instance, VPC vRouter, Backup Storage, Management Node, Host, Primary Storage, vCenter, Backup Job, Project Resource, and CDP Task.

    Note that you can select Project Resource and CDP Task only after you have purchased Tenant Management License and Continuous Data Protection (CDP) License, respectively.

  • Metric Item: Select a metric item of the selected resource type.
  • Emergency Level: Set an emergency level. Valid values: Emergent, Major, and Info. Alarms of different emergency levels correspond to alarm messages of different emergency levels.
  • Endpoint: Optional. If specified, alarm messages are sent to the specified endpoint.
    Note:
    • You can specify multiple endpoints.
    • You can specify the system endpoint or customize an endpoint.
Figure 4. Create Event Alarm


Note:
  • An event alarm is triggered only when the configured event occurs. The repetitive alarm mechanism is not available for event alarms.
  • When a resource monitored by an event alarm recovers from alarmed status, the system receives a notification. The recovery notification is sent according to the default recovery message template. You can customize the message content on the Message Template page.
  • If the configured event occurs again, the event alarm is triggered again.

Create Extended Alarm

Before you can create an extended alarm, you need to enable the extended alarm feature. To do this, choose Settings > Platform Setting > Global Setting > Advanced and turn on the Extended Alarm Notification switch.

Then you can create an extended alarm to receive extended alarm messages. On the Extended Alarm tab, click Create Extended Alarm. Then the Create Extended Alarm page is displayed. On the displayed page, set the following parameters:
  • Name: Enter a name for the extended alarm.
  • Message Source: Select a source where you need to receive alarm messages.
  • Endpoint: Optional. If specified, alarm messages are sent to the specified endpoint.
    Note:
    • You can specify multiple endpoints.
    • You can specify the system endpoint or customize an endpoint.
Figure 5. Create Extended Alarm


One-click Alarm

A one-click alarm integrates multiple metrics of a resource. You can create one-click alarms for multiple resources to monitor these resources.

Alarm Template

Create an Alarm Template

On the main menu of ZStack Cloud, choose Platform O&M > Cloud Monitoring > Alarm Service > Alarm Template. On the Alarm Template page, click Create Alarm Template. Then, the Create Alarm Template page is displayed.

On the displayed page, set the following parameters:
  • Name: Enter a name for the alarm template.
  • Description: Optional. Enter a description for the alarm template.
  • Resource Type: add an alarm rule to the template.
    • Alarm Type: Select resource alarm or event alarm.
    • Resource Type: Select a resource type.
      • If you create a resource alarm rule, you can select the following resource types: VM Instance, Baremetal Instance, Elastic Baremetal Instance, VPC vRouter, Backup Storage, Host, L3 Network, VIP, Primary Storage, Listener, and License.
      • If you create an event alarm rule, you can select the following resource types: VM Instance, VPC vRouter, Backup Storage, Host, and Primary Storage.
    • Add Rule: Add an alarm rule for the selected resource.
Figure 6. Create Alarm Rule


Resource Group

Create a Resource Group

On the main menu of ZStack Cloud, choose Platform O&M > Cloud Monitoring > Alarm Service > Resource Group. On the Resource Group page, click Create Resource Group. Then, the Create Resource Group page appears.

On the displayed page, set the following parameters:
  • Name: Enter a name for the resource group.
  • Description: Optional. Enter a description for the resource group.
  • Resource: Add a resource to the resource group.
  • Alarm Template: Optional. Associate a resource group with an alarm template. Then the alarm template applies to all resources in the group. You can also associate an alarm template after the resource group is created.
    Note: You can associate a resource group with only one alarm template.
  • Endpoint: Optional. If specified, alarm messages are sent to the specified endpoint.
    Note:
    • You can specify multiple endpoints.
    • You can specify the system endpoint or customize an endpoint.
Figure 7. Create Resource Group


Message Template

Create a Message Template

On the main menu of ZStack Cloud, choose Platform O&M > Cloud Monitoring > Alarm Configuration > Message Template. On the Message Template page, click Create Message Template. Then, the Create Message Template page appears.

On the displayed page, set the following parameters:
  • Name: Enter a name for the message template.
  • Description: Optional. Enter a description for the message template.
  • Type: Select the platform type of an endpoint. Valid values: Email, DingTalk, Microsoft Teams, and SMS.
  • Alarm Type: Select an alarm type. Valid values: Resource Alarm and Event Alarm.
  • Alarm Message Title: Set the title of alarm messages. You can customize a title or use the sytstem template. Currently, you cannot set a message title for SMS messages.

    The following is a message title template:

    Resource Alarm:
    Alarm ${ALARM_METRIC} ${ALARM_COMPARISON_OPERATOR} ${ALARM_THRESHOLD} ${ALARM_CURRENT_STATUS}
    Event Alarm:
    ${EVENT_NAME} alarm occurs.
  • Alarm Message Text: Customize an alarm message text template or use the system template.

    The following is a message template for endpoints of the email and DingTalk types:

    Resource Alarm:
    Alarm ${ALARM_NAME} State Changes To ${ALARM_CURRENT_STATUS}

Alarm Details
UUID: ${ALARM_UUID}
Resource Namespace: ${ALARM_NAMESPACE}
Trigger Condition: ${ALARM_METRIC} ${ALARM_COMPARISON_OPERATOR} ${ALARM_THRESHOLD}
Trigger Condition Duration: ${ALARM_DURATION} seconds
Previous Status: ${ALARM_PREVIOUS_STATUS}
Current Value: ${ALARM_CURRENT_VALUE}
Tag: ${ALARM_LABELS.join(",")}
    Event Alarm:
    Event Details:
Name:${EVENT_NAME}
Resource Type: ${EVENT_NAMESPACE}
Emergency Level:${EVENT_EMERGENCY_LEVEL}
Resource UUID:${EVENT_RESOURCE_ID}
Name:${EVENT_RESOURCE_NAME}
Alarm Trigger Time:${EVENT_TIME}
Event Subscription UUID:${EVENT_SUBSCRIPTION_UUID}
Error:${EVENT_ERROR}
    Note: Message templates for DingTalk-type endpoints must follow the Markdown syntax. DingTalk supports the subset of Markdown syntax. For more information, see DingTalk official website.
    The following is a message template for endpoints of the Microsoft Teams type:
    • Resource alarm:
      {
  "activityTitle": "Alarm ${ALARM_NAME} ${TITLE_ALARM_RESOURCE_NAME} State Changes To ${ALARM_CURRENT_STATUS}",
  "facts": [
    {
      "name": "Alarm Details",
      "value": null
    },
    {
      "name": "UUID",
      "value": "${ALARM_UUID}"
    },
    {
      "name": "Resource Type",
      "value": "${ALARM_NAMESPACE}"
    },
    {
      "name": "Trigger Condition",
      "value": "${ALARM_METRIC} ${ALARM_COMPARISON_OPERATOR} ${ALARM_THRESHOLD}"
    },
    {
      "name": "Trigger Condition Duration",
      "value": "${ALARM_DURATION} seconds"
    },
    {
      "name": "Previous Status",
      "value": "${ALARM_PREVIOUS_STATUS}"
    },
    {
      "name": "Current Value",
      "value": "${ALARM_CURRENT_VALUE}"
    },
    {
      "name": "Alarm Resource UUID",
      "value": "${ALARM_RESOURCE_ID}"
    },
    {
      "name": "Alarm Trigger Time",
      "value": "${ALARM_TIME}"
    },
    {
      "name": "Alarm Resource Name",
      "value": "${ALARM_RESOURCE_NAME}"
    },
    {
      "name": "Emergency Level",
      "value": "${ALARM_EMERGENCY_LEVEL}"
    },
    {
      "name": "Tag",
      "value": "${ALARM_LABELS.join(\",\")}"
    }
  ]
}
    • Even alarm:
      {
  "activityTitle": "Event ${EVENT_NAME} Happened",
  "facts": [
    {
      "name": "Event Details",
      "value": null
    },
    {
      "name": "Name",
      "value": "${EVENT_NAME}"
    },
    {
      "name": "Resource Type",
      "value": "${EVENT_NAMESPACE}"
    },
    {
      "name": "Emergency Level",
      "value": "${EVENT_EMERGENCY_LEVEL}"
    },
    {
      "name": "Alarm Resource UUID",
      "value": "${EVENT_RESOURCE_ID}"
    },
    {
      "name": "Alarm Resource Name",
      "value": "${EVENT_RESOURCE_NAME}"
    },
    {
      "name": "Alarm Trigger Time",
      "value": "${EVENT_TIME}"
    },
    {
      "name": "Event Subscription UUID",
      "value": "${EVENT_SUBSCRIPTION_UUID}"
    },
    {
      "name": "Error",
      "value": "${EVENT_ERROR}"
    }
  ]
}
    Note: Message template for endpoints of the Microsoft Teams type must follow the Webhook syntax of Microsoft Teams. For more information, see Microsoft Teams official website.
    The following is a message template for endpoints of the SMS type:
    • Resource alarm:
      Alarm: ${ALARM_NAME}, Name: ${ALARM_RESOURCE_NAME}, Trigger Condition: ${ALARM_CONDITION}, Emergency Level: ${ALARM_EMERGENCY_LEVEL}, Current Value: ${ALARM_CURRENT_VALUE}
    • Event alarm:
      Event Name: ${EVENT_NAME}, Name: ${EVENT_RESOURCE_NAME}, Emergency Level: ${EVENT_EMERGENCY_LEVEL}, Error: ${EVENT_ERROR}
    Note: Before you can customize a message template for SMS endpoint, you need to apply for and obtain a third-party SMS signature and SMS template. Currently, only Alibaba Cloud SMS is supported. If you need to modify a template, you need to modify on the third-party side. In addition, you need to apply for the signature and template again.
  • Recovery Message Title: When a monitored resource recovers from an alarm status, the Cloud sends alarm recovery messages to the selected endpoint. You can customize the title of the recovery messages as needed. SMS-type endpoints do not support recovery messages.
  • Recovery Message Text: Set the text content of the recovery meassage.
  • Make Default: Optional. Set the current message template as the default template.
Figure 8. Create Message Template




Message Source

Create a Message Source

Before you can create a message source, you need to enable the extended alarm feature. To do this, choose Settings > Platform Setting > Global Setting > Advanced and turn on the Extended Alarm Notification switch.

On the main menu of ZStack Cloud, choose Platform O&M > Cloud Monitoring > Alarm Configuration > Message Source. On the Message Source page, click Create Message Source. Then, the Create Message Source page appears.

On the displayed page, set the following parameters:
  • Name: Enter a name for the message source.
  • Description: Optional. Enter a description for the message source.
  • Message Source Type: Select the type of message source. Currently, only Ceph Enterprise is supported.
  • Login Address and Token: Enter the login address of the message source and the access token obtained on the message source page, in the format of http://{Message Source IP Address}:{Port}/v1/alerts/?token={Access Token}
  • Alarm Message Conversion Template: Convert third-party alarm messages into alarm messages that conform to the format required on the Cloud. The system provides a conversion template that you can use to customize the parameters.
    Example:
    {
    "product":"Ceph Enterprise",
    "service":"Ceph Enterprise",
    "message":"${resource_type + '[' + resource_name+'] ' + group + ' ' + alert_value}",
    "metric":"${resource_type + '::' + group}",
    "alertLevel":"${level == 'info' ? 'Normal' : level == 'warning' ? 'Important' : 'Emergent'}",
    "alertTime":"${create}",
    "dimensions":"{'resource_name':'${resource_name}'}",
    "dataSource":"Ceph Enterprise"
}

Endpoint

Create an Endpoint

On the main menu of ZStack Cloud, choose Platform O&M > Cloud Monitoring > Alarm Configuration > Endpoint. On the Endpoint page, click Create Endpoint. Then, the Create Endpoint page appears.

The following lists the four endpoint creation scenarios:
  • Create an endpoint of the email type
  • Create an endpoint of the DingTalk type
  • Create an endpoint of the HTTP application type
  • Create an endpoint of the SMS type
  • Create an endpoint of the Microsoft Teams type

Create Endpoint of Email Type

  • Messages sent to topics are sent to the specified email address via an email server.
  • You can customize a message template or use the system message template to send email messages in a unified format.
  • You need to add an email server to the Cloud and test the availability of the server before you can use the email server to send messages.
On the displayed page, set the following parameters:
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Type: Select Email.
  • Email Address: Enter one or more email addresses. You can enter a maximum of 100 email addresses.
  • Email Server: Enter an email server that is added to the Cloud.
    • Test: Test the availability of the email server.
  • Message Language: Select a language for alarm messages. Valid values: Simplified Chinese and English.
Figure 9. Create Endpoint of Email Type


Create Endpoint of DingTalk Type

  • Messages sent to topics are sent to the specified DingTalk robot address via DingTalk. If you specify a contact, the DingTalk user that owns the phone number will be notified of the messages.
  • You can customize a message template or use the system message template to send email messages in a unified format.
  • You need to create an alarm message template of DingTalk type that follows the Markdown syntax. DingTalk supports the subset of Markdown syntax. For more information, see DingTalk official website.
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Type: Select DingTalk.
  • Address: Enter a DingTalk robot address.
  • Contact: Optional. Specify all members or specific members in the group.
    Note: If you need to specify a member, enter the phone number of the member, for example, +86-13800000000.
  • Message Language: Select a language for alarm messages. Valid values: Simplified Chinese and English.
Figure 10. Create Endpoint of DingTalk Type


Create Endpoint of HTTP Application Type

  • Messages sent to topics are sent to the specified HTTP address by using the HTTP POST method.
  • If you set a username and password for the specified HTTP application, enter the username and password for the endpoint.
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Type: Select HTTP Application.
  • Address: Enter the address of an HTTP application.
    Note:
    • If the HTTP application is managed by a single management node, the IP address is 127.0.0.1 by default.
    • If the HTTP application is managed in a dual-MN environment, the IP address is a VIP.
  • User Name: Optional. Enter the username of the HTTP application.
  • Password: Optional. Enter the password of the HTTP application.
Figure 11. Create Endpoint of HTTP Application Type


Create Endpoint of SMS Type

  • Messages sent to topics are sent to the specified phone numbers via text messages.
  • You need to create a message template and set it as the default template. Then text alarm messages are sent according to the template.
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Type: Select SMS.
  • AccessKey: Enter a third-party AccessKey pair.
  • Phone Number: Enter the phone numbers that receive text messages.
Figure 12. Create Endpoint of SMS Type


Create Endpoint of Microsoft Teams Type

  • Messages sent to topics are sent to the specified Microsoft Teams via Webhook.
  • You can create a message template or use the system template for alarm messages to be sent in a unified format.
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Type: Select Microsoft Teams.
  • Address: Enter the Webhook address obtained in the Microsoft Teams.
  • Message Language: Select a language for alarm messages. Valid values: Simplified Chinese and English.
Figure 13. Create Endpoint of Microsoft Teams Type


PreviousNetwork TopologyNextOne-Click Inspection