Browse Source

[doc][fix] Add new alert doc Slack (#12567)

3.2.0-release
Tq 2 years ago committed by GitHub
parent
commit
4e2701b57e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      docs/configs/docsdev.js
  2. 47
      docs/docs/en/guide/alert/slack.md
  3. 2
      docs/docs/zh/guide/alert/feishu.md
  4. 44
      docs/docs/zh/guide/alert/slack.md
  5. BIN
      docs/img/new_ui/dev/alert/alert_slack.png
  6. BIN
      docs/img/new_ui/dev/alert/alert_slack_enable.png
  7. BIN
      docs/img/new_ui/dev/alert/alert_slack_new.png
  8. BIN
      docs/img/new_ui/dev/alert/alert_slack_webhook_addr.png

8
docs/configs/docsdev.js

@ -328,6 +328,10 @@ export default {
title: 'Feishu',
link: '/en-us/docs/dev/user_doc/guide/alert/feishu.html',
},
{
title: 'Slack',
link: '/en-us/docs/dev/user_doc/guide/alert/slack.html',
},
],
},
{
@ -952,6 +956,10 @@ export default {
title: '飞书告警',
link: '/zh-cn/docs/dev/user_doc/guide/alert/feishu.html',
},
{
title: 'Slack告警',
link: '/zh-cn/docs/dev/user_doc/guide/alert/slack.html',
},
],
},
{

47
docs/docs/en/guide/alert/slack.md

@ -0,0 +1,47 @@
# Slack
If you need to use `Slack` for alerting, create an alert instance in the alert instance management and select
the `Slack` plugin.
The following shows the `Slack` configuration example:
![alert-slack](../../../../img/new_ui/dev/alert/alert_slack.png)
## Parameter Configuration
* Webhook
> Copy the `Incoming Webhooks` address from the APP, check the image below:
![alert-slack-webhook](../../../../img/new_ui/dev/alert/alert_slack_webhook_addr.png)
* UserName
> (Deprecated) The sender name. Currently, Slack use APP as the sender name due to the Slack updates.
## How to Get Webhook
Please refer to the official article [Slack: Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) to create new webhooks.
### Create a new Slack APP
Visit [Slack Official Website](https://api.slack.com/apps/new) and create a new APP.
### Activate Incoming Webhooks Setting
When finish creating a new APP, select `Incoming Webhooks` of the column `Feature` on the left of the APP page, and switch `Activate Incoming Webhooks` to `ON`.
![alert-slack-webhook](../../../../img/new_ui/dev/alert/alert_slack_enable.png)
### Create a New Incoming Webhook
Click `Add New Webhook to Workspace` and select a group to post messages.
![select-post-group](../../../../img/new_ui/dev/alert/alert_slack_new.png)
### Acquire Incoming Webhooks Address
Copy the `Incoming Webhooks` address to DolphinScheduler, check the image below:
The default format of the `Incoming Webhooks`: `https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`
![alert-slack-webhook](../../../../img/new_ui/dev/alert/alert_slack_webhook_addr.png)
Reference:[Slack:Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks)

2
docs/docs/zh/guide/alert/feishu.md

@ -4,7 +4,7 @@
![alert-feishu](../../../../img/new_ui/dev/alert/alert_feishu.png)
参数配置
## 参数配置
* Webhook

44
docs/docs/zh/guide/alert/slack.md

@ -0,0 +1,44 @@
# Slack
如果您需要使用到Slack进行告警,请在告警实例管理里创建告警实例,选择 Slack 插件。Slack的配置样例如下:
![alert-slack](../../../../img/new_ui/dev/alert/alert_slack.png)
## 参数配置
* Webhook
> 复制APP的`Incoming Webhooks`地址,如下图所示:
![alert-slack-webhook](../../../../img/new_ui/dev/alert/alert_slack_webhook_addr.png)
* 用户名
> 发送人的昵称(已过时),由于Slack更新原因目前会使用APP名称作为发件人
## 如何获取Webhook地址
请参考官网文章[《Slack:如何通过Incoming Webhooks发送消息?》](https://api.slack.com/messaging/webhooks)进行创建。
### 新建一个Slack APP
打开[Slack官网](https://api.slack.com/apps/new)新建一个APP。
### 激活Incoming Webhooks设置
新建APP后,在APP页面左侧,选择`Feature`栏目下的`Incoming Webhooks`,点击激活`Activate Incoming Webhooks`到`ON`。
![alert-slack-webhook](../../../../img/new_ui/dev/alert/alert_slack_enable.png)
### 创建一个Incoming Webhook
创建一个新的`Incoming Webhook`,并选择消息的发送分组。
![select-post-group](../../../../img/new_ui/dev/alert/alert_slack_new.png)
### 获取Incoming Webhooks地址
复制APP的`Incoming Webhooks`地址,如下图所示:
`Incoming Webhooks`的格式为:`https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`
![alert-slack-webhook](../../../../img/new_ui/dev/alert/alert_slack_webhook_addr.png)
参考:[Slack:如何通过Incoming Webhooks发送消息?](https://api.slack.com/messaging/webhooks)

BIN
docs/img/new_ui/dev/alert/alert_slack.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
docs/img/new_ui/dev/alert/alert_slack_enable.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

BIN
docs/img/new_ui/dev/alert/alert_slack_new.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

BIN
docs/img/new_ui/dev/alert/alert_slack_webhook_addr.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Loading…
Cancel
Save