This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere-elasticjob.git
The following commit(s) were added to refs/heads/master by this push:
new 5737f1e Update document for error-handler configuration (#1629)
5737f1e is described below
commit 5737f1ec5f3ca1f5ce050b49ae6b94bbde5398b9
Author: Liang Zhang <[email protected]>
AuthorDate: Wed Oct 21 22:17:53 2020 +0800
Update document for error-handler configuration (#1629)
---
.../built-in-strategy/error-handler.cn.md | 50 +++++++++++-----------
.../built-in-strategy/error-handler.en.md | 50 +++++++++++-----------
2 files changed, 50 insertions(+), 50 deletions(-)
diff --git
a/docs/content/user-manual/elasticjob-lite/configuration/built-in-strategy/error-handler.cn.md
b/docs/content/user-manual/elasticjob-lite/configuration/built-in-strategy/error-handler.cn.md
index 446c47c..f2bc0e1 100644
---
a/docs/content/user-manual/elasticjob-lite/configuration/built-in-strategy/error-handler.cn.md
+++
b/docs/content/user-manual/elasticjob-lite/configuration/built-in-strategy/error-handler.cn.md
@@ -47,19 +47,19 @@ Maven 坐标：
可配置属性：
-| 属性名 | 说明 | 默认值 |
-| -------- |:-------------------- |:------------------------ |
-| host | 邮件服务主机地址 | 无 |
-| port | 邮件服务主机端口 | 无 |
-| username | 用户名 | 无 |
-| password | 密码 | 无 |
-| useSsl | 是否启用ssl加密传输 | true |
-| subject | 邮件主题 | ElasticJob error message |
-| from | 发送方邮箱地址 | 无 |
-| to | 接收方邮箱地址 | 无 |
-| cc | 抄送邮箱地址 | 无 |
-| bcc | 密送邮箱地址 | 无 |
-| debug | 是否开启debug | false |
+| 属性名 | 说明 | 是否必填 | 默认值 |
+| -------------- |:------------------- |:-------- |:------------------------ |
+| email.host | 邮件服务器地址 | 是 | - |
+| email.port | 邮件服务器端口 | 是 | - |
+| email.username | 邮件服务器用户名 | 是 | - |
+| email.password | 邮件服务器密码 | 是 | - |
+| email.useSsl | 是否启用 SSL 加密传输 | 否 | true |
+| email.subject | 邮件主题 | 否 | ElasticJob error message |
+| email.from | 发送方邮箱地址 | 是 | - |
+| email.to | 接收方邮箱地址 | 是 | - |
+| email.cc | 抄送邮箱地址 | 否 | null |
+| email.bcc | 密送邮箱地址 | 否 | null |
+| email.debug | 是否开启调试模式 | 否 | false |
## 企业微信通知策略
@@ -81,11 +81,11 @@ Maven 坐标：
可配置属性：
-| 属性名 | 说明 | 默认值 |
-| ------------------------- |:----------------------------------- |:-------- |
-| webhook | 企业微信机器人的webhook地址 | 无 |
-| connectTimeoutMillisecond | 与企业微信服务器建立连接的超时时间 | 3000 毫秒 |
-| readTimeoutMillisecond | 从企业微信服务器读取到可用资源的超时时间 | 5000 毫秒 |
+| 属性名 | 说明 | 是否必填
| 默认值 |
+| -------------------------------- |:-----------------------------------
|:--------- |:--------- |
+| wechat.webhook | 企业微信机器人的 webhook 地址 | 是 |
- |
+| wechat.connectTimeoutMillisecond | 与企业微信服务器建立连接的超时时间 | 否 | 3000
毫秒 |
+| wechat.readTimeoutMillisecond | 从企业微信服务器读取到可用资源的超时时间 | 否 | 5000
毫秒 |
## 钉钉通知策略
@@ -107,10 +107,10 @@ Maven 坐标：
可配置属性：
-| 属性名 | 说明 | 默认值 |
-| ------------------------- |:----------------------------------|:-------- |
-| webhook | 钉钉机器人的webhook地址 | 无 |
-| keyword | 自定义关键词 | 无 |
-| secret | 签名的密钥 | 无 |
-| connectTimeoutMillisecond | 与钉钉服务器建立连接的超时时间 | 3000 毫秒 |
-| readTimeoutMillisecond | 从钉钉服务器读取到可用资源的超时时间 | 5000 毫秒 |
+| 属性名 | 说明 | 是否必填 |
默认值 |
+| ----------------------------------
|:----------------------------------|:------- |:-------- |
+| dingtalk.webhook | 钉钉机器人的 webhook 地址 | 是 |
- |
+| dingtalk.keyword | 自定义关键词 | 否
| null |
+| dingtalk.secret | 签名的密钥 | 否
| null |
+| dingtalk.connectTimeoutMillisecond | 与钉钉服务器建立连接的超时时间 | 否 | 3000
毫秒 |
+| dingtalk.readTimeoutMillisecond | 从钉钉服务器读取到可用资源的超时时间 | 否 | 5000 毫秒
|
diff --git
a/docs/content/user-manual/elasticjob-lite/configuration/built-in-strategy/error-handler.en.md
b/docs/content/user-manual/elasticjob-lite/configuration/built-in-strategy/error-handler.en.md
index 87c87b1..50943e9 100644
---
a/docs/content/user-manual/elasticjob-lite/configuration/built-in-strategy/error-handler.en.md
+++
b/docs/content/user-manual/elasticjob-lite/configuration/built-in-strategy/error-handler.en.md
@@ -47,19 +47,19 @@ Maven POM:
Configuration:
-| Name | Description | Default Value
|
-| -------- |:------------------------------------------------
|:------------------------ |
-| host | Email service host address | None
|
-| port | Email service port | None
|
-| username | Username | None
|
-| password | Password | None
|
-| useSsl | Whether to enable ssl encrypted transmission | true
|
-| subject | Email Subject | ElasticJob
error message |
-| from | Sender email address | None
|
-| to | Recipient's email address | None
|
-| cc | Carbon copy email address | None
|
-| bcc | Blind carbon copy email address | None
|
-| debug | Whether to enable debug | false
|
+| Name | Description | Required |
Default Value |
+| -------------- |:-------------------------------------------- |:--------
|:------------------------ |
+| email.host | Email server host address | Yes | -
|
+| email.port | Email server port | Yes | -
|
+| email.username | Email server username | Yes | -
|
+| email.password | Email server password | Yes | -
|
+| email.useSsl | Whether to enable SSL encrypted transmission | No |
true |
+| email.subject | Email Subject | No |
ElasticJob error message |
+| email.from | Sender email address | Yes | -
|
+| email.to | Recipient's email address | Yes | -
|
+| email.cc | Carbon copy email address | No |
null |
+| email.bcc | Blind carbon copy email address | No |
null |
+| email.debug | Whether to enable debug mode | No |
false |
## Wechat Enterprise Notification Strategy
@@ -81,11 +81,11 @@ Maven POM:
Configuration:
-| Name | Description
| Default Value |
-| -------------------------
|:---------------------------------------------------------------------------|:-----------------
|
-| webhook | The webhook address of the wechat robot
| None |
-| connectTimeoutMillisecond | The timeout period for establishing a connection
with the wechat server | 3000 milliseconds |
-| readTimeoutMillisecond | The timeout period for reading available
resources from the wechat server | 5000 milliseconds |
+| Name | Description
| Required | Default Value |
+| --------------------------------
|:-------------------------------------------------------------------------
|:-------- |:----------------- |
+| wechat.webhook | The webhook address of the wechat robot
| Yes | - |
+| wechat.connectTimeoutMillisecond | The timeout period for establishing a
connection with the wechat server | No | 3000 milliseconds |
+| wechat.readTimeoutMillisecond | The timeout period for reading available
resources from the wechat server | No | 5000 milliseconds |
## Dingtalk Notification Strategy
@@ -107,10 +107,10 @@ Maven POM:
Configuration:
-| Name | Description
| Default Value |
-| -------------------------
|:---------------------------------------------------------------------------
|:------------------|
-| webhook | The webhook address of the dingtalk robot
| None |
-| keyword | Custom keywords
| None |
-| secret | Secret for dingtalk robot
| None |
-| connectTimeoutMillisecond | The timeout period for establishing a connection
with the dingtalk server | 3000 milliseconds |
-| readTimeoutMillisecond | The timeout period for reading available
resources from the dingtalk server | 5000 milliseconds |
+| Name | Description
| Required | Default Value |
+| ----------------------------------
|:---------------------------------------------------------------------------
|:-------- |:----------------- |
+| dingtalk.webhook | The webhook address of the dingtalk
robot | Yes | - |
+| dingtalk.keyword | Custom keywords
| No | null |
+| dingtalk.secret | Secret for dingtalk robot
| No | null |
+| dingtalk.connectTimeoutMillisecond | The timeout period for establishing a
connection with the dingtalk server | No | 3000 milliseconds |
+| dingtalk.readTimeoutMillisecond | The timeout period for reading
available resources from the dingtalk server | No | 5000 milliseconds |
