#Management of Notification

#Feature Overview

With notifications, you can integrate the platform's monitoring and alerting features to promptly send pre-warning information to notification recipients, reminding relevant personnel to take necessary measures to resolve issues or avoid failures.

#Key Features

• Notification Server: The notification server provides services for sending notification messages to notification contact groups on the platform, such as an email server.
• Notification Contact Group: A notification contact group is a set of notification recipients with similar logical characteristics, which can reduce your maintenance burden by allowing a categorization of entities that receive notification messages.
• Notification Template: A notification template is a standardized structure composed of custom content, content variables, and content format parameters. It is used to standardize the content and format of alert notification messages for notification strategies. For example, customizing the subject and content of email notifications.
• Notification rule: A notification rule is a collection of rules defining how to send notification messages to specific contacts. It is essential to use a notification rule for scenarios such as alerts, inspections, and login authentication that require notifying external services.

#Notification Server

The notification server provides services for sending notification messages to recipients on the platform. The platform currently supports the following notification servers:

• Corporate Communication Tool Server: Supports integration with WeChat Work, DingTalk, and Feishu built-in applications for sending notifications to individuals.
• Email Server: Sends notifications via email using an email server.
• Webhook Type Server: Supports integration with corporate WeChat group bots, DingTalk group bots, Feishu group bots, or sending WebHooks to your designated server.

#Corporate Communication Tool Server

WeChat Work

1. Configure the notification server parameters as per the example below. Once parameters are filled in, switch to the global cluster in Cluster Management > Resource Management and create the resource object.

   # WeChat Work corpId, corpSecret, agentId acquisition methods can be referenced in the official documentation: https://developer.work.weixin.qq.com/document/path/90665
   apiVersion: v1
   kind: Secret
   type: NotificationServer
   metadata:
     labels:
       cpaas.io/notification.server.type: CorpWeChat
       cpaas.io/notification.server.category: Corp
     name: platform-corp-wechat-server
     namespace: cpaas-system
   data:
     displayNameZh: 企业微信            # Server's Chinese display name, encoded in base64 by default
     displayNameEn: WeChat             # Server's English display name, encoded in base64 by default
     corpId:                           # Corporate ID, encoded in base64 by default
     corpSecret:                       # Application secret, encoded in base64 by default
     agentId:                          # Corporate application ID, encoded in base64 by default
   

2. After the creation, you need to update the user's WeChat Work ID in the platform's User Role Management > User Management or in the user's Personal Information to ensure the user can receive messages normally.

DingTalk

1. Configure the notification server parameters as per the example below. Once parameters are filled in, switch to the global cluster in Cluster Management > Resource Management and create the resource object.

   # DingTalk appKey, appSecret, agentId acquisition method: https://open-dev.dingtalk.com/fe/app#/corp/app
   apiVersion: v1
   kind: Secret
   type: NotificationServer
   metadata:
     labels:
       cpaas.io/notification.server.type: CorpDingTalk
       cpaas.io/notification.server.category: Corp
     name: platform-corp-dingtalk-server
     namespace: cpaas-system
   data:
     displayNameZh: 钉钉                # Server's Chinese display name, encoded in base64 by default
     displayNameEn: DingTalk           # Server's English display name, encoded in base64 by default
     appKey:                           # Application key, encoded in base64 by default
     appSecret:                        # Application secret, encoded in base64 by default
     agentId:                          # Application agent_id, encoded in base64 by default
   

2. After the creation, you need to update the user's DingTalk ID in the platform's User Role Management > User Management or in the user's Personal Information to ensure the user can receive messages normally.

Feishu

1. Configure the notification server parameters as per the example below. Once parameters are filled in, switch to the global cluster in Cluster Management > Resource Management and create the resource object.

   # Feishu appId, appSecret acquisition methods: https://open.feishu.cn/app/
   apiVersion: v1
   kind: Secret
   type: NotificationServer
   metadata:
     labels:
       cpaas.io/notification.server.type: CorpFeishu
       cpaas.io/notification.server.category: Corp
     name: platform-corp-feishu-server
     namespace: cpaas-system
   data:
     displayNameZh: 飞书                 # Server's Chinese display name, encoded in base64 by default
     displayNameEn: Feishu             # Server's English display name, encoded in base64 by default
     appId:                            # Application ID, encoded in base64 by default
     appSecret:                        # Application secret, encoded in base64 by default
   

2. After the creation, you need to update the user's Feishu ID in the platform's User Role Management > User Management or in the user's Personal Information to ensure the user can receive messages normally.

#Email Server

1. In the left navigation bar, click Platform Settings > Notification Server.

2. Click Configure Now.

3. Refer to the following instructions to configure the relevant parameters.

   Parameter	Description
   Service Address	The address of the notification server supporting the SMTP protocol, e.g., smtp.yeah.net.
   Port	The port number for the notification server. When Use SSL is checked, the SSL port number must be entered.
   Server Configuration	Use SSL: Secure Socket Layer (SSL) is a standard security technology. The SSL switch is used to control whether to establish an encrypted link between the server and client. Skip Insecure Verification: The insecureSkipVerify switch is used to control whether to verify the client certificate and server hostname. If enabled, certificates and the consistency between the hostname in the certificate and the server hostname will not be verified.
   Sender Email	The sender's email account in the notification server, used for sending notification emails.
   Enable Authentication	If authentication is required, please configure the username and authorization code for the email server.

4. Click OK.

#Webhook Type Server

Supports integration with corporate WeChat group bots, DingTalk group bots, Feishu group bots, or sending HTTP requests to your designated Webhook server.

Corporate WeChat Group Bot

1. In the left navigation bar, click Cluster Management > Cluster.

2. Click the operation button next to the global cluster > CLI Tool.

3. Execute the following command on the master node of the global cluster:

   kubectl patch secret -n cpaas-system platform-wechat-server -p '{"data":{"enable":"dHJ1ZQo="}}'
   

   Tip: dHJ1ZQo= is the base64 encoded value of true; to disable, replace dHJ1ZQo= with ZmFsc2UK, which is the base64 encoded value of false.

DingTalk Group Bot

1. In the left navigation bar, click Cluster Management > Cluster.

2. Click the operation button next to the global cluster > CLI Tool.

3. Execute the following command on the master node of the global cluster:

   kubectl patch secret -n cpaas-system platform-dingtalk-server -p '{"data":{"enable":"dHJ1ZQo="}}'
   

   Tip: dHJ1ZQo= is the base64 encoded value of true; to disable, replace dHJ1ZQo= with ZmFsc2UK, which is the base64 encoded value of false.

Feishu Group Bot

1. In the left navigation bar, click Cluster Management > Cluster.

2. Click the operation button next to the global cluster > CLI Tool.

3. Execute the following command on the master node of the global cluster:

   kubectl patch secret -n cpaas-system platform-feishu-server -p '{"data":{"enable":"dHJ1ZQo="}}'
   

   Tip: dHJ1ZQo= is the base64 encoded value of true; to disable, replace dHJ1ZQo= with ZmFsc2UK, which is the base64 encoded value of false.

Webhook Server

1. In the left navigation bar, click Cluster Management > Cluster.

2. Click the operation button next to the global cluster > CLI Tool.

3. Execute the following command on the master node of the global cluster:

   kubectl patch secret -n cpaas-system platform-webhook-server -p '{"data":{"enable":"dHJ1ZQo="}}'
   

   Tip: dHJ1ZQo= is the base64 encoded value of true; to disable, replace dHJ1ZQo= with ZmFsc2UK, which is the base64 encoded value of false.

#Notification Contact Group

A notification contact group is a set of notification recipients with similar logical characteristics. For example, you can set an operations and maintenance team as a notification contact group for easy selection and management when configuring notification strategies.

1. In the left navigation bar, click Operations Center > Notifications.

2. Switch to the Notification Contact Group tab.

3. Click Create Notification Contact Group and configure the relevant parameters as per the instructions below.

   Parameter	Description
   Email	Add an email to the entire notification contact group. The platform will send notifications to this email and all contacts' emails in the group.
   Webhook URL/WeChat Group Bot/DingTalk Group Bot/Feishu Group Bot	Please fill in the corresponding notification method URL based on the configured notification server. Once configured, contacts in this group will be notified using this method.
   Contact Configuration	Click Add Contact to add existing platform users to the contact group. Ensure the accuracy of the selected contacts' contact information (phone, email, interface callback) to avoid missing message notifications.

4. Click Add.

#Notification Template

A notification template is a standardized structure composed of custom content, content variables, and content format parameters. It is used to standardize the content and format of alert notification messages for notification strategies.

Platform administrators or operations personnel can set notification templates to customize the content and format of notification messages based on different alert notification methods, helping users quickly get critical alert information and improve operational efficiency.

#Create Notification Template

1. In the left navigation bar, click Operations Center > Notifications.

2. Switch to the Notification Template tab.

3. Click Create Notification Template.

4. In the Basic Information section, configure the following parameters.

   Parameter	Description
   Message Type	Select the type of message according to the purpose of the notification. Alert Message: Sends alert messages triggered by alert rules, in conjunction with the platform's alerting functionality; Component Exception Message: Sends notification information triggered by exceptions in certain components.

5. In the Template Configuration section, reference different template types to configure variables and content formatting parameters.

6. Click Create.

#Reference Variables

Variables are the keys of labels or annotations in notification messages (NotificationMessage), formatted as {{.labelKey}}. To facilitate users in quickly obtaining key information, custom display names can be assigned to variables; for example: Alert Level: {{ .externalLabels.severity }}.

When a notification rule sends notification messages to users based on a notification template, the variables in the template will reference the corresponding label values in the notification message (actual monitoring data). Ultimately, monitoring data will be sent to users in a standardized content format.

The platform provides the following basic variables by default:

Display Name	Variable	Description
Alert Status	{{ .externalLabels.status }}	For example: Alerting.
Alert Level	{{ .externalLabels.severity }}	For example: Critical.
Alert Cluster	{{ .labels.alert_cluster }}	For example: Cluster 1 where the alert occurred.
Alert Object	{{ .externalLabels.object }}	The type and name of the resource where the alert occurred, e.g., node 192.168.16.53.
rule Name	{{ .labels.alert_resource }}	The name of the alert rule, e.g., cpaas-node-rules.
Alert Description	{{ .externalLabels.summary }}	Description of the alert rule.
Trigger Value	{{ .externalLabels.currentValue }}	The monitored value that triggered the alert.
Alert Time	{{ dateFormatWithZone .startsAt "2006-01-02 15:04:05" "Asia/Chongqing" }}	The start time of the alert.
Recovery Time	{{ dateFormatWithZone .endsAt "2006-01-02 15:04:05" "Asia/Chongqing" }}	The end time of the alert.
Metric Name	{{ .labels.alert_indicator }}	Name of the monitoring metric.

#Special Formatting Markup Language in Emails

In email notifications, common HTML format tags and their instructions are referenced in the table below:

Content Element	Tag	Description
Text	-	Supports input of Chinese/English text content.
Font	<font color="#FF0000">Set Font Color</font> <b>Bold Font</b>	Set font format.
Title	<h1>Level 1 Title</h1>, supports up to h6 (header 6).	Set title level.
Paragraph	<p>Paragraph</p>	Insert regular paragraph text.
Quote	<q>Quote</q>	Insert short quoted content.
Hyperlink	<a href="//www.example.com">Hyperlink</a>	Insert a hyperlink.

#Notification rule

A notification rule is a collection of rules defining how to send notification messages to specific contacts. It is essential to use notification strategies for scenarios requiring notification to external services, such as alerts, inspections, and login authentication.

#Prerequisites

To use the Corporate Communication Tool Server to notify contacts, users must first modify their contact information in Personal Information by entering their WeChat Work ID.

#Operation Procedures

1. In the left navigation bar, click Operations Center > Notifications.

2. Click Create Notification rule and configure the relevant parameters as per the following instructions.

   Parameter	Description
   Notification Contact Group	A notification contact group is a logical set of notification recipients, which the platform will notify using the specified notification method.
   Notification Recipients	Choose to add one or more notification recipients, and the platform will send notifications according to the recipients' Personal Information contact methods.
   Notification Method	Supports multiple methods including WeChat Work, DingTalk, Feishu, Corporate WeChat Group Bot, DingTalk Group Bot, Feishu Group Bot, WebHook URL, and supports multiple selections. Note: Some parameters will be displayed after configuring the notification server.
   Notification Template	Select the notification template to display notification information.

3. Click Create.

#Set Notification Rule for Projects

The platform's notification strategies, notification templates, and notification contact groups are tenant-isolated. As a project administrator, you will not be able to view or use notification strategies, notification templates, or notification contact groups configured by other projects or platform administrators. Therefore, you need to refer to this document to configure suitable notification strategies for your project.

#Prerequisites

1. You have contacted the platform administrator to complete the notification server setup.

2. If you need to notify through corporate communication tools, you also need to ensure that the contacts to be notified have correctly configured their communication tool IDs in Personal Information.

#Operation Procedures

1. In the Project Management view, click Project Name.

2. In the left navigation bar, click Notifications.

3. Switch to the Notification Contact Group tab, refer to Notification Contact Group to create a notification contact group.

4. Switch to the Notification Template tab, refer to Notification Template to create a notification template.

5. Switch to the Notification rule tab, refer to Notification rule to create a notification rule.