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 2021/12/27 06:46:24 UTC
[dolphinscheduler-website] branch master updated: [Feature-7465][Alert] Modifiy alert docs (#594)
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 5a063d5 [Feature-7465][Alert] Modifiy alert docs (#594)
5a063d5 is described below
commit 5a063d52590502de706d92d72e81448b76475fc3
Author: xiangzihao <46...@qq.com>
AuthorDate: Mon Dec 27 14:46:20 2021 +0800
[Feature-7465][Alert] Modifiy alert docs (#594)
* feature_7465
* feature_7465
* remove date+1 when complement data
* remove date+1 when complement data
* feature_7465
Co-authored-by: SbloodyS <sb...@qq.com>
---
.../dev/user_doc/guide/alert/enterprise-wechat.md | 30 +++++----------------
.../en-us/dev/user_doc/guide/parameter/built-in.md | 6 ++---
.../dev/user_doc/guide/alert/enterprise-wechat.md | 30 +++++----------------
.../zh-cn/dev/user_doc/guide/parameter/built-in.md | 6 ++---
img/alert/enterprise-wechat-plugin.png | Bin 0 -> 16944 bytes
5 files changed, 18 insertions(+), 54 deletions(-)
diff --git a/docs/en-us/dev/user_doc/guide/alert/enterprise-wechat.md b/docs/en-us/dev/user_doc/guide/alert/enterprise-wechat.md
index a7d2569..4113892 100644
--- a/docs/en-us/dev/user_doc/guide/alert/enterprise-wechat.md
+++ b/docs/en-us/dev/user_doc/guide/alert/enterprise-wechat.md
@@ -1,29 +1,11 @@
# Enterprise WeChat
-If you need to use Enterprise WeChat to alert, please modify the `alert.properties` file after the installation is complete, and then restart the alert service. The configuration example of enterprise WeChat is as follows
+If you need to use Enterprise WeChat to alert, please create an alarm Instance in warning instance manage, and then choose the wechat plugin. The configuration example of enterprise WeChat is as follows
-```shell
-# Enable enterprise WeChat alarm or not: ``true`` or ``false``
-enterprise.wechat.enable="true"
+
-# Enterprise WeChat corpid, each enterprise has a unique corpid, to obtain this information, you can view the "enterprise ID" under "My Company"-"Enterprise Information" in the management background (administrator rights are required)
-enterprise.wechat.corp.id="xxx"
+Where send type corresponds to app and appchat respectively:
+APP: https://work.weixin.qq.com/api/doc/90000/90135/90236
+APPCHAT: https://work.weixin.qq.com/api/doc/90000/90135/90248
-# Secret for Enterprise WeChat, secret is the "key" used to ensure data security in enterprise applications, and each application has an independent access key
-enterprise.wechat.secret="xxx"
-
-# Enterprise WeChat agentid, each application has a unique agentid. In the management background -> "Apps and applets" -> "Apps", click on an application, you can see the agentid
-enterprise.wechat.agent.id="xxxx"
-
-# Userid when notification send to Enterprise WeChat, multiple separated by commas. Each member has a unique userid, the so-called "account". In the management background -> "Contacts" -> click on a member's details page, you can see
-enterprise.wechat.users=zhangsan,lisi
-
-# Get the address of access_token, modify if you need
-enterprise.wechat.token.url=https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid={corpId}&corpsecret={secret}
-
-# Send application message address, modify if you need
-enterprise.wechat.push.url=https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token={token}
-
-# Message format
-enterprise.wechat.user.send.msg={\"touser\":\"{toUser}\",\"agentid\":\"{agentId}\",\"msgtype\":\"markdown\",\"markdown\":{\"content\":\"{msg}\"}}
-```
+user.send.msg corresponds to the content in the document. The variable of the corresponding value is {msg}
\ No newline at end of file
diff --git a/docs/en-us/dev/user_doc/guide/parameter/built-in.md b/docs/en-us/dev/user_doc/guide/parameter/built-in.md
index 751a4c9..2c88bed 100644
--- a/docs/en-us/dev/user_doc/guide/parameter/built-in.md
+++ b/docs/en-us/dev/user_doc/guide/parameter/built-in.md
@@ -7,17 +7,17 @@
<tr>
<td>system.biz.date</td>
<td>${system.biz.date}</td>
- <td>The day before the scheduled time of the daily scheduling instance, the format is yyyyMMdd, when the data is supplemented, the date is +1</td>
+ <td>The day before the scheduled time of the daily scheduling instance, the format is yyyyMMdd</td>
</tr>
<tr>
<td>system.biz.curdate</td>
<td>${system.biz.curdate}</td>
- <td>The timing time of the daily scheduling instance, the format is yyyyMMdd, when the data is supplemented, the date is +1</td>
+ <td>The timing time of the daily scheduling instance, the format is yyyyMMdd</td>
</tr>
<tr>
<td>system.datetime</td>
<td>${system.datetime}</td>
- <td>The timing time of the daily scheduling instance, the format is yyyyMMddHHmmss, when the data is supplemented, the date is +1</td>
+ <td>The timing time of the daily scheduling instance, the format is yyyyMMddHHmmss</td>
</tr>
</table>
diff --git a/docs/zh-cn/dev/user_doc/guide/alert/enterprise-wechat.md b/docs/zh-cn/dev/user_doc/guide/alert/enterprise-wechat.md
index a4af004..a98b918 100644
--- a/docs/zh-cn/dev/user_doc/guide/alert/enterprise-wechat.md
+++ b/docs/zh-cn/dev/user_doc/guide/alert/enterprise-wechat.md
@@ -1,29 +1,11 @@
# 企业微信
-如果您需要使用到企业微信进行告警，请在安装完成后，修改 `alert.properties` 文件，然后重启 alert 服务即可。企业微信的配置样例如下
+如果您需要使用到企业微信进行告警，请在告警实例管理里创建告警实例，选择 WeChat 插件。企业微信的配置样例如下
-```shell
-# 设置企业微信告警功能是否开启：开启为 true，否则为 false
-enterprise.wechat.enable="true"
+
-# 设置 corpid，每个企业都拥有唯一的 corpid，获取此信息可在管理后台 “我的企业” － “企业信息” 下查看 “企业 ID”（需要有管理员权限）
-enterprise.wechat.corp.id="xxx"
+其中 send.type 分别对应企微文档：
+应用：https://work.weixin.qq.com/api/doc/90000/90135/90236
+群聊：https://work.weixin.qq.com/api/doc/90000/90135/90248
-# 设置 secret，secret 是企业应用里面用于保障数据安全的 “钥匙”，每一个应用都有一个独立的访问密钥
-enterprise.wechat.secret="xxx"
-
-# 设置 agentid，每个应用都有唯一的 agentid。在管理后台 -> “应用与小程序” -> “应用”，点进某个应用，即可看到 agentid
-enterprise.wechat.agent.id="xxxx"
-
-# 设置 userid，多个用逗号分隔。每个成员都有唯一的 userid，即所谓 “帐号”。在管理后台 -> “通讯录” -> 点进某个成员的详情页，可以看到
-enterprise.wechat.users=zhangsan,lisi
-
-# 获取 access_token 的地址，使用如下例子无需修改
-enterprise.wechat.token.url=https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid={corpId}&corpsecret={secret}
-
-# 发送应用消息地址，使用如下例子无需改动
-enterprise.wechat.push.url=https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token={token}
-
-# 发送消息格式，无需改动
-enterprise.wechat.user.send.msg={\"touser\":\"{toUser}\",\"agentid\":\"{agentId}\",\"msgtype\":\"markdown\",\"markdown\":{\"content\":\"{msg}\"}}
-```
+user.send.msg 对应文档中的 content，与此相对应的值的变量为 {msg}
\ No newline at end of file
diff --git a/docs/zh-cn/dev/user_doc/guide/parameter/built-in.md b/docs/zh-cn/dev/user_doc/guide/parameter/built-in.md
index bbab190..2b97e91 100644
--- a/docs/zh-cn/dev/user_doc/guide/parameter/built-in.md
+++ b/docs/zh-cn/dev/user_doc/guide/parameter/built-in.md
@@ -7,17 +7,17 @@
<tr>
<td>system.biz.date</td>
<td>${system.biz.date}</td>
- <td>日常调度实例定时的定时时间前一天，格式为 yyyyMMdd，补数据时，该日期 +1</td>
+ <td>日常调度实例定时的定时时间前一天，格式为 yyyyMMdd</td>
</tr>
<tr>
<td>system.biz.curdate</td>
<td>${system.biz.curdate}</td>
- <td>日常调度实例定时的定时时间，格式为 yyyyMMdd，补数据时，该日期 +1</td>
+ <td>日常调度实例定时的定时时间，格式为 yyyyMMdd</td>
</tr>
<tr>
<td>system.datetime</td>
<td>${system.datetime}</td>
- <td>日常调度实例定时的定时时间，格式为 yyyyMMddHHmmss，补数据时，该日期 +1</td>
+ <td>日常调度实例定时的定时时间，格式为 yyyyMMddHHmmss</td>
</tr>
</table>
diff --git a/img/alert/enterprise-wechat-plugin.png b/img/alert/enterprise-wechat-plugin.png
new file mode 100644
index 0000000..e0d069e
Binary files /dev/null and b/img/alert/enterprise-wechat-plugin.png differ