You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by zh...@apache.org on 2022/01/25 09:12:49 UTC

[dolphinscheduler-website] branch master updated: [plugin] Add DingTalk alert plugin documentation (#650)

This is an automated email from the ASF dual-hosted git repository.

zhongjiajie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git


The following commit(s) were added to refs/heads/master by this push:
     new ca2ec03  [plugin] Add DingTalk alert plugin documentation (#650)
ca2ec03 is described below

commit ca2ec03b2e40e2e38ba8d84050ab25188b691aa8
Author: Kerwin <37...@users.noreply.github.com>
AuthorDate: Tue Jan 25 17:12:42 2022 +0800

    [plugin] Add DingTalk alert plugin documentation (#650)
---
 docs/en-us/dev/user_doc/guide/alert/dingtalk.md |  25 ++++++++++++++++++++++++
 docs/zh-cn/dev/user_doc/guide/alert/dingtalk.md |  25 ++++++++++++++++++++++++
 img/alert/dingtalk-plugin.png                   | Bin 0 -> 48163 bytes
 3 files changed, 50 insertions(+)

diff --git a/docs/en-us/dev/user_doc/guide/alert/dingtalk.md b/docs/en-us/dev/user_doc/guide/alert/dingtalk.md
new file mode 100644
index 0000000..633d513
--- /dev/null
+++ b/docs/en-us/dev/user_doc/guide/alert/dingtalk.md
@@ -0,0 +1,25 @@
+# DingTalk
+
+If you need to use DingTalk for alerting, please create an alert instance in the alert instance management and select the DingTalk plugin. The configuration example of DingTalk is as follows:
+
+![dingtalk-plugin](/img/alert/dingtalk-plugin.png)
+
+parameter configuration
+
+* Webhook
+  > The format is as follows: https://oapi.dingtalk.com/robot/send?access_token=XXXXXX
+* Keyword
+  > Custom keywords for security settings
+* Secret
+  > Signature of security settings
+
+When a custom bot sends a message, you can specify the "@person list" by your mobile phone number. When the people in the "@people list" receive the message, there will be a @ message reminder. Do not disturb conversations still notify reminders, and "someone @ you" appears on the fold
+* @Mobiles
+  > The mobile phone number of the "@person"
+* @UserIds
+  > The userid by "@person"
+* @All
+  > Is @Everyone
+
+[DingTalk Custom Robot Access Development Documentation](https://open.dingtalk.com/document/robots/custom-robot-access),
+Use message type as text
\ No newline at end of file
diff --git a/docs/zh-cn/dev/user_doc/guide/alert/dingtalk.md b/docs/zh-cn/dev/user_doc/guide/alert/dingtalk.md
new file mode 100644
index 0000000..85c6ce7
--- /dev/null
+++ b/docs/zh-cn/dev/user_doc/guide/alert/dingtalk.md
@@ -0,0 +1,25 @@
+# 钉钉
+
+如果您需要使用到钉钉进行告警,请在告警实例管理里创建告警实例,选择 DingTalk 插件。钉钉的配置样例如下:
+
+![dingtalk-plugin](/img/alert/dingtalk-plugin.png)
+
+参数配置
+
+* Webhook
+  > 格式如下:https://oapi.dingtalk.com/robot/send?access_token=XXXXXX
+* Keyword
+  > 安全设置的自定义关键词
+* Secret
+  > 安全设置的加签
+
+自定义机器人发送消息时,可以通过手机号码指定“被@人列表”。在“被@人列表”里面的人员收到该消息时,会有@消息提醒。免打扰会话仍然通知提醒,首屏出现“有人@你”
+* @Mobiles
+  > 被@人的手机号
+* @UserIds
+  > 被@人的用户userid
+* @All
+  > 是否@所有人
+
+[钉钉自定义机器人接入开发文档](https://open.dingtalk.com/document/robots/custom-robot-access),
+采用消息类型为text
\ No newline at end of file
diff --git a/img/alert/dingtalk-plugin.png b/img/alert/dingtalk-plugin.png
new file mode 100644
index 0000000..e9407e9
Binary files /dev/null and b/img/alert/dingtalk-plugin.png differ