sneh-wha
3 years ago
committed by
GitHub
8 changed files with 83 additions and 87 deletions
@ -1,18 +1,22 @@
|
||||
# Alert Component User Guide |
||||
|
||||
## How to Create Alert Plugins and Alert Groups |
||||
## Alert Plugins and Alert Groups Creation |
||||
|
||||
In version 2.0.0, users need to create alert instances, and needs to choose an alarm policy when defining an alarm instance, there are three options: send if the task succeeds, send on failure, and send on both success and failure. when the workflow or task is executed, if an alarm is triggered, calling the alarm instance send method needs a logical judgment, which matches the alarm instance with the task status, executes the alarm instance sending logic if it matches, and filters if it does not match. When create alert instances then associate them with alert groups. Alert group can use multiple alert instances. |
||||
The alarm module supports the following scenarios: |
||||
<img src="../../../../img/alert/alert_scenarios_en.png"> |
||||
|
||||
The steps to use are as follows: |
||||
<img src="../../../../img/alert/alert_scenarios_en.png"> |
||||
|
||||
First, go to the Security Center page. Select Alarm Group Management, click Alarm Instance Management on the left and create an alarm instance. Select the corresponding alarm plug-in and fill in the relevant alarm parameters. |
||||
Steps to be used are as follows: |
||||
|
||||
Then select Alarm Group Management, create an alarm group, and choose the corresponding alarm instance. |
||||
- Go to `Security -> Alarm Group Management -> Alarm Instance Management -> Alarm Instance`. |
||||
- Select the corresponding alarm plug-in and fill in the relevant alarm parameters. |
||||
- Select `Alarm Group Management`, create an alarm group, and choose the corresponding alarm instance. |
||||
|
||||
 |
||||
|
||||
 |
||||
|
||||
 |
||||
 |
||||
|
||||
 |
||||
@ -1,27 +1,25 @@
|
||||
# DingTalk |
||||
|
||||
If you need to use `DingTalk` for alerting, create an alert instance in the alert instance management and select the DingTalk plugin. |
||||
The following shows the `DingTalk` configuration example: |
||||
If you need to use `DingTalk` for alerting, create an alert instance in the alert instance management and select the `DingTalk` plugin. The following shows the `DingTalk` configuration example: |
||||
|
||||
 |
||||
|
||||
## Parameter Configuration |
||||
|
||||
* Webhook |
||||
> The format is: https://oapi.dingtalk.com/robot/send?access_token=XXXXXX |
||||
* Keyword |
||||
> Custom keywords for security settings |
||||
* Secret |
||||
> Signature of security settings |
||||
* MessageType |
||||
> Support both text and markdown types |
||||
| **Parameter** | **Description** | |
||||
| --- | --- | |
||||
| Warning Type | Alert on success or failure or both. | |
||||
| WebHook | The format is: [https://oapi.dingtalk.com/robot/send?access\_token=XXXXXX](https://oapi.dingtalk.com/robot/send?access_token=XXXXXX) | |
||||
| Keyword | Custom keywords for security settings. | |
||||
| Secret | Signature of security settings | |
||||
| Msg Type | Message parse type (support txt, markdown, markdownV2, html). | |
||||
| At User Mobile | When a custom bot sends a message, you can specify the "@person list" by their mobile phone number. When the selected people in the "@people list" receive the message, there will be a `@` message reminder. `No disturb` mode always receives reminders, and "someone @ you" appears in the message. The "At User Mobile" represents mobile phone number of the "@person" | |
||||
| At User Ids | The user ID by "@person" | |
||||
| Proxy | The proxy address of the proxy server. | |
||||
| Port | The proxy port of Proxy-Server. | |
||||
| User | Authentication(Username) for the proxy server. | |
||||
| Password | Authentication(Password) for the proxy server. | |
||||
|
||||
When a custom bot sends a message, you can specify the "@person list" by their mobile phone number. When the selected people in the "@people list" receive the message, there will be a `@` message reminder. `No disturb` mode always receives reminders, and "someone @ you" appears in the message. |
||||
* @Mobiles |
||||
> The mobile phone number of the "@person" |
||||
* @UserIds |
||||
> The user ID by "@person" |
||||
* @All |
||||
> @Everyone |
||||
## Reference |
||||
|
||||
[DingTalk Custom Robot Access Development Documentation](https://open.dingtalk.com/document/robots/custom-robot-access) |
||||
- [DingTalk Custom Robot Access Development Documentation](https://open.dingtalk.com/document/robots/custom-robot-access) |
||||
@ -1,6 +1,10 @@
|
||||
# Email |
||||
If you need to use `Email` for alerting, create an alert instance in the alert instance management and select the Email plugin. |
||||
|
||||
The following shows the `Email` configuration example: |
||||
|
||||
 |
||||
|
||||
 |
||||
|
||||
 |
||||
Loading…
Reference in new issue