Browse Source

[Docs] enhance alert doc (#9534)

Co-authored-by: Jiajie Zhong <zhongjiajie955@gmail.com>
wangyang 3 years ago
parent
commit
6155dc3dab

+ 27 - 1
docs/docs/en/development/backend/spi/alert.md

@@ -22,7 +22,7 @@ If you don't care about its internal design, but simply want to know how to deve
 
 * dolphinscheduler-alert-plugins
 
-  This module is currently a plug-in provided by us, such as Email, DingTalk, Script, etc.
+  This module is currently a plug-in provided by us, and now we have supported dozens of plug-ins, such as Email, DingTalk, Script, etc.
 
 
 #### Alert SPI Main class information.
@@ -59,6 +59,8 @@ The specific design of alert_spi can be seen in the issue: [Alert Plugin Design]
 * DingTalk
 
      Alert for DingTalk group chat bots
+  
+     Related parameter configuration can refer to the DingTalk robot document.
 
 * EnterpriseWeChat
 
@@ -73,3 +75,27 @@ The specific design of alert_spi can be seen in the issue: [Alert Plugin Design]
 * SMS
 
      SMS alerts
+* FeiShu
+
+  FeiShu alert notification
+* Slack
+
+  Slack alert notification
+* PagerDuty
+
+  PagerDuty alert notification
+* WebexTeams
+
+  WebexTeams alert notification
+
+  Related parameter configuration can refer to the WebexTeams document.
+
+* Telegram
+
+  Telegram alert notification
+  
+  Related parameter configuration can refer to the Telegram document.
+
+* Http
+
+  We have implemented a Http script for alerting. And calling most of the alerting plug-ins end up being Http requests, if we not support your alert plug-in yet, you can use Http to realize your alert login. Also welcome to contribute your common plug-ins to the community :)

File diff suppressed because it is too large
+ 6 - 2
docs/docs/en/guide/alert/alert_plugin_user_guide.md


+ 23 - 1
docs/docs/zh/development/backend/spi/alert.md

@@ -22,7 +22,7 @@ DolphinScheduler 正在处于微内核 + 插件化的架构更改之中,所有
 
 * dolphinscheduler-alert-plugins
 
-  该模块是目前我们提供的插件,如 Email、DingTalk、Script等。
+  该模块是目前我们提供的插件,目前我们已经支持数十种插件,如 Email、DingTalk、Script等。
 
 
 #### Alert SPI 主要类信息:
@@ -61,6 +61,7 @@ alert_spi 具体设计可见 issue:[Alert Plugin Design](https://github.com/ap
 
   钉钉群聊机器人告警
 
+  相关参数配置可以参考钉钉机器人文档。
 * EnterpriseWeChat
 
   企业微信告警通知
@@ -69,3 +70,24 @@ alert_spi 具体设计可见 issue:[Alert Plugin Design](https://github.com/ap
 * Script
 
   我们实现了 Shell 脚本告警,我们会将相关告警参数透传给脚本,你可以在 Shell 中实现你的相关告警逻辑,如果你需要对接内部告警应用,这是一种不错的方法。
+* FeiShu
+
+  飞书告警通知
+* Slack
+
+  Slack告警通知
+* PagerDuty
+
+  PagerDuty告警通知
+* WebexTeams
+
+  WebexTeams告警通知
+  相关参数配置可以参考WebexTeams文档。
+* Telegram
+
+  Telegram告警通知
+  相关参数配置可以参考Telegram文档。
+* Http
+
+  我们实现了Http告警,调用大部分的告警插件最终都是Http请求,如果我们没有支持你常用插件,可以使用Http来实现你的告警需求,同时也欢迎将你常用插件贡献到社区。
+

File diff suppressed because it is too large
+ 6 - 2
docs/docs/zh/guide/alert/alert_plugin_user_guide.md


BIN
docs/img/alert/alert_scenarios_en.png


BIN
docs/img/alert/alert_scenarios_zh.png


BIN
docs/img/alert/alert_step_2.png


BIN
docs/img/alert/alert_step_3.png


BIN
docs/img/alert/alert_step_4.png