From 0cdae777ab02b4db14c3374b8b4a76f6ea206c74 Mon Sep 17 00:00:00 2001 From: sneh-wha <105436196+sneh-wha@users.noreply.github.com> Date: Fri, 1 Jul 2022 13:59:00 +0530 Subject: [PATCH] [doc] Modified alert doc files (#10714) --- .../en/guide/alert/alert_plugin_user_guide.md | 16 +++++--- docs/docs/en/guide/alert/dingtalk.md | 34 ++++++++------- docs/docs/en/guide/alert/email.md | 4 ++ .../en/guide/alert/enterprise-webexteams.md | 33 +++++++-------- docs/docs/en/guide/alert/enterprise-wechat.md | 4 +- docs/docs/en/guide/alert/http.md | 21 ++++------ docs/docs/en/guide/alert/script.md | 17 ++++---- docs/docs/en/guide/alert/telegram.md | 41 ++++++++----------- 8 files changed, 83 insertions(+), 87 deletions(-) diff --git a/docs/docs/en/guide/alert/alert_plugin_user_guide.md b/docs/docs/en/guide/alert/alert_plugin_user_guide.md index 6c41023c48..d8ceebefea 100644 --- a/docs/docs/en/guide/alert/alert_plugin_user_guide.md +++ b/docs/docs/en/guide/alert/alert_plugin_user_guide.md @@ -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: - -The steps to use are as follows: + -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. ![alert-instance01](../../../../img/new_ui/dev/alert/alert_instance01.png) + ![alert-instance02](../../../../img/new_ui/dev/alert/alert_instance02.png) + ![alert-instance03](../../../../img/new_ui/dev/alert/alert_instance03.png) -![alert-instance04](../../../../img/new_ui/dev/alert/alert_instance04.png) + +![alert-instance04](../../../../img/new_ui/dev/alert/alert_instance04.png) \ No newline at end of file diff --git a/docs/docs/en/guide/alert/dingtalk.md b/docs/docs/en/guide/alert/dingtalk.md index 950a75ae85..03f18b5c4b 100644 --- a/docs/docs/en/guide/alert/dingtalk.md +++ b/docs/docs/en/guide/alert/dingtalk.md @@ -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: ![alert-dingtalk](../../../../img/new_ui/dev/alert/alert_dingtalk.png) ## 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) \ No newline at end of file diff --git a/docs/docs/en/guide/alert/email.md b/docs/docs/en/guide/alert/email.md index aa3cf2ba73..d87b2964f1 100644 --- a/docs/docs/en/guide/alert/email.md +++ b/docs/docs/en/guide/alert/email.md @@ -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: + ![alert-email](../../../../img/alert/email-alter-setup1-en.png) + ![alert-email](../../../../img/alert/email-alter-setup2-en.png) + ![alert-email](../../../../img/alert/email-alter-setup3-en.png) \ No newline at end of file diff --git a/docs/docs/en/guide/alert/enterprise-webexteams.md b/docs/docs/en/guide/alert/enterprise-webexteams.md index 5c9228fd10..2427b1c626 100644 --- a/docs/docs/en/guide/alert/enterprise-webexteams.md +++ b/docs/docs/en/guide/alert/enterprise-webexteams.md @@ -1,27 +1,22 @@ # Webex Teams -If you need to use `Webex Teams` to alert, create an alert instance in the alert instance management, and choose the WebexTeams plugin. -You can pick private alert or room group chat alert. +If you need to use `Webex Teams` to alert, create an alert instance in the alert instance management, and choose the WebexTeams plugin. You can pick private alert or room group chat alert. The following is the `WebexTeams` configuration example: ![enterprise-webexteams-plugin](../../../../img/alert/enterprise-webexteams-plugin.png) ## Parameter Configuration -* botAccessToken - > The robot's access token -* roomID - > The ID of the room that receives message (only support one room ID) -* toPersonId - > The person ID of the recipient when sending a private 1:1 message -* toPersonEmail - > The email address of the recipient when sending a private 1:1 message -* atSomeoneInRoom - > If the message destination is room, the emails of the person being @, use `,` (eng commas) to separate multiple emails -* destination - > The destination of the message (one message only support one destination) - -## Create a Bot +| **Parameter** | **Description** | +| --- | --- | +| botAccessToken | The access token of robot. | +| roomID | The ID of the room that receives message (only support one room ID). | +| toPersonId | The person ID of the recipient when sending a private 1:1 message. | +| toPersonEmail | The email address of the recipient when sending a private 1:1 message. | +| atSomeoneInRoom | If the message destination is room, the emails of the person being @, use `,` (eng commas) to separate multiple emails. | +| destination |The destination of the message (one message only support one destination). | + +## Create Bot Create a bot visit [Official Website My-Apps](https://developer.webex.com/my-apps) to `Create a New APP` and select `Create a Bot`, fill in the bot information and acquire `bot username` and `bot ID` for further usage. @@ -60,5 +55,7 @@ The `Room ID` we can acquire it from the `id` of creating a new group chat room ![enterprise-webexteams-room-message-example](../../../../img/alert/enterprise-webexteams-room-msg.png) -[WebexTeams Application Bot Guide](https://developer.webex.com/docs/bots) -[WebexTeams Message Guide](https://developer.webex.com/docs/api/v1/messages/create-a-message) +## References: + +- [WebexTeams Application Bot Guide](https://developer.webex.com/docs/bots) +- [WebexTeams Message Guide](https://developer.webex.com/docs/api/v1/messages/create-a-message) \ No newline at end of file diff --git a/docs/docs/en/guide/alert/enterprise-wechat.md b/docs/docs/en/guide/alert/enterprise-wechat.md index 1fec0485e6..a4fdb84bd5 100644 --- a/docs/docs/en/guide/alert/enterprise-wechat.md +++ b/docs/docs/en/guide/alert/enterprise-wechat.md @@ -66,6 +66,6 @@ The following is the `create new group chat` API and `query userId` API example: ![enterprise-wechat-create-group](../../../../img/alert/enterprise-wechat-query-userid.png) -#### References +## Reference -Group Chat：https://work.weixin.qq.com/api/doc/90000/90135/90248 \ No newline at end of file +- Group Chat：https://work.weixin.qq.com/api/doc/90000/90135/90248 \ No newline at end of file diff --git a/docs/docs/en/guide/alert/http.md b/docs/docs/en/guide/alert/http.md index e69cc0f2e9..3725b516f7 100644 --- a/docs/docs/en/guide/alert/http.md +++ b/docs/docs/en/guide/alert/http.md @@ -4,29 +4,26 @@ If you need to use `Http script` for alerting, create an alert instance in the a ## Parameter Configuration -* URL - > The `Http` request URL needs to contain protocol, host, path and parameters if the method is `GET` -* Request Type - > Select the request type from `POST` or `GET` -* Headers - > The headers of the `Http` request in JSON format -* Body - > The request body of the `Http` request in JSON format, when using `POST` method to alert -* Content Field - > The field name to place the alert information +| **Parameter** | **Description** | +| --- | --- | +| URL | The `Http` request URL needs to contain protocol, host, path and parameters if the method is `GET`. | +| Request Type | Select the request type from `POST` or `GET`. | +| Headers | The headers of the `Http` request in JSON format. | +| Body | The request body of the `Http` request in JSON format, when using `POST` method to alert. | +| Content Field | The field name to place the alert information. | ## Send Type Using `POST` and `GET` method to send `Http` request in the `Request Type`. -### GET Http +### GET HTTP Send alert information by `Http` GET method. The following shows the `GET` configuration example: ![enterprise-wechat-app-msg-config](../../../../img/alert/http-get-example.png) -### POST Http +### POST HTTP Send alert information inside `Http` body by `Http` POST method. The following shows the `POST` configuration example: diff --git a/docs/docs/en/guide/alert/script.md b/docs/docs/en/guide/alert/script.md index 0e9b89440f..b87b4f5f82 100644 --- a/docs/docs/en/guide/alert/script.md +++ b/docs/docs/en/guide/alert/script.md @@ -1,4 +1,4 @@ -# DingTalk +# Script If you need to use `Shell script` for alerting, create an alert instance in the alert instance management and select the `Script` plugin. The following shows the `Script` configuration example: @@ -7,11 +7,12 @@ The following shows the `Script` configuration example: ## Parameter Configuration -* User Params - > User defined parameters will pass to the script. -* Script Path - > The file location path in the server. -* Type - > Support `Shell` script. +| **Parameter** | **Description** | +| --- | --- | +| User Params | User defined parameters will pass to the script. | +| Script Path |The file location path in the server. | +| Type | Support `Shell` script. | -**_Notice:_** please consider the script file access privileges with the executing tenant. \ No newline at end of file +### Note + +Consider the script file access privileges with the executing tenant. \ No newline at end of file diff --git a/docs/docs/en/guide/alert/telegram.md b/docs/docs/en/guide/alert/telegram.md index 49b11037a3..cdfb026ed4 100644 --- a/docs/docs/en/guide/alert/telegram.md +++ b/docs/docs/en/guide/alert/telegram.md @@ -7,26 +7,21 @@ The following shows the `Telegram` configuration example: ## Parameter Configuration -* WebHook: - > The WebHook of Telegram when use robot to send message -* botToken - > The robot's access token -* chatId - > Sub Telegram Channel -* parseMode - > Message parse type (support txt, markdown, markdownV2, html) -* EnableProxy - > Enable proxy sever -* 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 - -**NOTICE**：The webhook needs to be able to receive and use the same JSON body of HTTP POST that DolphinScheduler constructs and the following shows the JSON body: +| **Parameter** | **Description** | +| --- | --- | +| WebHook | The WebHook of Telegram when use robot to send message. | +| botToken | The access token of robot. | +| chatId | Sub Telegram Channel. | +| parseMode | Message parse type (support txt, markdown, markdownV2, html). | +| EnableProxy | Enable proxy sever. | +| 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. | + +### NOTE + +The webhook needs to be able to receive and use the same JSON body of HTTP POST that DolphinScheduler constructs and the following shows the JSON body: ```json { @@ -35,8 +30,8 @@ The following shows the `Telegram` configuration example: } ``` -References: +## References: + - [Telegram Application Bot Guide](https://core.telegram.org/bots) - [Telegram Bots Api](https://core.telegram.org/bots/api) -- [Telegram SendMessage Api](https://core.telegram.org/bots/api#sendmessage) - +- [Telegram SendMessage Api](https://core.telegram.org/bots/api#sendmessage) \ No newline at end of file