You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2020/07/08 04:54:09 UTC
[shardingsphere-elasticjob-lite] branch master updated: Update
config-manual.md (#982) (#983)
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-lite.git
The following commit(s) were added to refs/heads/master by this push:
new 0e118ee Update config-manual.md (#982) (#983)
0e118ee is described below
commit 0e118eefb24a76588b5cd1cf136f62c7769baae0
Author: Tboy <gu...@immomo.com>
AuthorDate: Wed Jul 8 12:53:57 2020 +0800
Update config-manual.md (#982) (#983)
---
docs/content/guide/config-manual.cn.md | 82 ++++++++-------------------------
docs/content/guide/config-manual.en.md | 84 +++++++++-------------------------
2 files changed, 41 insertions(+), 125 deletions(-)
diff --git a/docs/content/guide/config-manual.cn.md b/docs/content/guide/config-manual.cn.md
index d0706e8..c8d27cc 100644
--- a/docs/content/guide/config-manual.cn.md
+++ b/docs/content/guide/config-manual.cn.md
@@ -26,11 +26,7 @@ chapter = true
### b. 作业配置
-作业配置分为 3 级，分别是 JobCoreConfiguration，JobTypeConfiguration 和 JobConfiguration。
-JobConfiguration 使用 JobTypeConfiguration，JobTypeConfiguration 使用 JobCoreConfiguration，层层嵌套。
-JobTypeConfiguration 根据不同实现类型分为 SimpleJobConfiguration，DataflowJobConfiguration 和 ScriptJobConfiguration。
-
-#### JobCoreConfiguration 属性详细说明
+#### JobConfiguration 属性详细说明
| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
| ------------------------------|:--------|:---------|:-------|:--------|
@@ -39,44 +35,19 @@ JobTypeConfiguration 根据不同实现类型分为 SimpleJobConfiguration，Dat
| shardingTotalCount | int | 是 | | 作业分片总数 |
| shardingItemParameters | String | 否 | | 分片序列号和参数用等号分隔，多个键值对用逗号分隔<br />分片序列号从0开始，不可大于或等于作业分片总数<br />如：<br/>0=a,1=b,2=c |
| jobParameter | String | 否 | | 作业自定义参数<br />作业自定义参数，可通过传递该参数为作业调度的业务方法传参，用于实现带参数的作业<br />例：每次获取的数据量、作业实例从数据库读取的主键等 |
+| monitorExecution | boolean | 否 |true | 监控作业运行时状态<br />每次作业执行时间和间隔时间均非常短的情况，建议不监控作业运行时状态以提升效率。因为是瞬时状态，所以无必要监控。请用户自行增加数据堆积监控。并且不能保证数据重复选取，应在作业中实现幂等性。<br />每次作业执行时间和间隔时间均较长的情况，建议监控作业运行时状态，可保证数据不会重复选取。 |
| failover | boolean | 否 | false | 是否开启任务执行失效转移，开启表示如果作业在一次任务执行中途宕机，允许将该次未完成的任务在另一作业节点上补偿执行 |
| misfire | boolean | 否 | true | 是否开启错过任务重新执行 |
+| maxTimeDiffSeconds | int | 否 |-1 | 最大允许的本机与注册中心的时间误差秒数<br />如果时间误差超过配置秒数则作业启动时将抛异常<br />配置为-1表示不校验时间误差 |
+| reconcileIntervalMinutes | int | 否 |10 | 修复作业服务器不一致状态服务调度间隔时间，配置为小于1的任意值表示不执行修复<br />单位：分钟 |
+| jobShardingStrategyType | String | 否 |-1 | 作业分片策略实现类全路径<br />默认使用平均分配策略<br />详情参见：[作业分片策略](/02-guide/job-sharding-strategy) |
| jobExecutorServiceHandlerType | String | 否 | | 配置作业线程池处理策略 |
| jobErrorHandlerType | String | 否 | | 配置作业异常处理策略 |
| description | String | 否 | | 作业描述信息 |
+| props | Properties | 否 | | 作业属性配置信息，对于Dataflow类型任务，配置streaming.process=true开启流式处理任务。 对于Script类型任务，配置script.command.line,指定运行脚本|
+| disabled | boolean | 否 | false | 作业是否禁止启动<br />可用于部署作业时，先禁止启动，部署结束后统一启动 |
+| overwrite | boolean | 否 | false | 本地配置是否可覆盖注册中心配置<br />如果可覆盖，每次启动作业都以本地配置为准 |
-#### SimpleJobConfiguration 属性详细说明
-
-| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
-| -----------|:---------------------|:---------|:-------|:------------------------------|
-| coreConfig | JobCoreConfiguration | 是 | | |
-| jobClass | String | 是 | | 作业实现类，需实现ElasticJob接口 |
-
-#### DataflowJobConfiguration属性详细说明
-
-| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
-| -----------------|:---------------------|:---------|:--------------|:------------------------------|
-| coreConfig | JobCoreConfiguration | 是 | | |
-| jobClass | String | 是 | | 作业实现类，需实现ElasticJob接口 |
-| streamingProcess | boolean | 否 | false | 是否流式处理数据<br />如果流式处理数据, 则fetchData不返回空结果将持续执行作业<br />如果非流式处理数据, 则处理数据完成后作业结束 |
-
-#### ScriptJobConfiguration 属性详细说明
-
-| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
-| ------------------|:---------------------|:---------|:-------|:------------------|
-| coreConfig | JobCoreConfiguration | 是 | | |
-| scriptCommandLine | String | 是 | | 脚本型作业执行命令行 |
-
-#### JobConfiguration 属性详细说明
-
-| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
-| -------------------------|:---------------------|:---------|:----------------|:-------------------------------------------------------|
-| jobConfig | JobTypeConfiguration | 是 | | |
-| monitorExecution | boolean | 否 |true | 监控作业运行时状态<br />每次作业执行时间和间隔时间均非常短的情况，建议不监控作业运行时状态以提升效率。因为是瞬时状态，所以无必要监控。请用户自行增加数据堆积监控。并且不能保证数据重复选取，应在作业中实现幂等性。<br />每次作业执行时间和间隔时间均较长的情况，建议监控作业运行时状态，可保证数据不会重复选取。 |
-| maxTimeDiffSeconds | int | 否 |-1 | 最大允许的本机与注册中心的时间误差秒数<br />如果时间误差超过配置秒数则作业启动时将抛异常<br />配置为-1表示不校验时间误差 |
-| jobShardingStrategyType | String | 否 |-1 | 作业分片策略实现类全路径<br />默认使用平均分配策略<br />详情参见：[作业分片策略](/02-guide/job-sharding-strategy) |
-| reconcileIntervalMinutes | int | 否 |10 | 修复作业服务器不一致状态服务调度间隔时间，配置为小于1的任意值表示不执行修复<br />单位：分钟 |
-| eventTraceRdbDataSource | String | 否 | | 作业事件追踪的数据源Bean引用 |
## 2. Spring 命名空间配置
@@ -92,7 +63,7 @@ Spring 命名空间与 Java Code 方式配置类似，大部分属性只是将
### a. 注册中心配置
-#### reg:zookeeper命名空间属性详细说明
+#### elasticjob:zookeeper命名空间属性详细说明
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ------------------------------- |:-------|:-------|:------|:--------------------------------------------------------------------------------------------------|
@@ -109,7 +80,7 @@ Spring 命名空间与 Java Code 方式配置类似，大部分属性只是将
### b. 作业配置
-#### job:simple命名空间属性详细说明
+#### elasticjob:job命名空间属性详细说明
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ----------------------------------|:--------|:--------|:----------------|:---------------------------------------------------------------------------|
@@ -131,48 +102,35 @@ Spring 命名空间与 Java Code 方式配置类似，大部分属性只是将
| job-executor-service-handler-type | String | 否 | | 扩展作业处理线程池类 |
| job-error-handler-type | String | 否 | | 扩展异常处理类 |
| description | String | 否 | | 作业描述信息 |
+| props | Properties | 否 | | 作业属性配置信息，对于Dataflow类型任务，配置streaming.process=true开启流式处理任务。对于Script类型任务，配置script.command.line,指定运行脚本|
| disabled | boolean | 否 | false | 作业是否禁止启动<br />可用于部署作业时，先禁止启动，部署结束后统一启动 |
| overwrite | boolean | 否 | false | 本地配置是否可覆盖注册中心配置<br />如果可覆盖，每次启动作业都以本地配置为准 |
-### c. 监控配置
+### c. 任务快照配置
-#### monitor:monitor 命名空间属性详细说明
+#### elasticjob:snapshot 命名空间属性详细说明
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ------------------------------- |:-------|:-------|:------|:--------------------------------------------------------------------------------------------------|
| id | String | 是 | | 监控服务在Spring容器中的主键 |
| registry-center-ref | String | 是 | | 注册中心Bean的引用，需引用reg:zookeeper的声明 |
-| monitor-port | int | 否 | -1 | 作业监控端口<br />建议配置作业监控端口, 方便开发者dump作业信息。<br />使用方法: echo "dump@jobName" \| nc 127.0.0.1 9888|
-
-#### job:dataflow命名空间属性详细说明
-
-job:dataflow命名空间拥有job:simple命名空间的全部属性，以下仅列出特有属性
-
-| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
-| ----------------- |:--------|:-------|:----------|:-------------------------------------------------------------------------------------------------------------------|
-| streaming-process | boolean | 否 | false | 是否流式处理数据<br />如果流式处理数据, 则fetchData不返回空结果将持续执行作业<br />如果非流式处理数据, 则处理数据完成后作业结束 |
-
-#### job:script命名空间属性详细说明，基本属性参照job:simple命名空间属性详细说明
+| dump-port | int | 否 | -1 | dump数据端口<br />建议配置作业dump端口, 方便开发者dump作业信息。<br />使用方法: echo "dump@jobName" \| nc 127.0.0.1 9888|
-job:script命名空间拥有job:simple命名空间的全部属性，以下仅列出特有属性
-| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
-| -------------------------------- |:-------|:--------|:------|:------------------|
-| script-command-line | String | 否 | | 脚本型作业执行命令行 |
+### d. 作业监听配置
-#### job:listener命名空间属性详细说明
+#### elasticjob:listener命名空间属性详细说明
-job:listener必须配置为job:bean的子元素，并且在子元素中只允许出现一次
+elasticjob:listener必须配置为elasticjob:job的子元素，并且在子元素中只允许出现一次
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ------------------------------ |:-------|:-------|:--------------|:--------------------------------------------------|
-| class | String |是 | | 前置后置任务监听实现类，需实现ElasticJobListener接口 |
+| class | String |是 | | 前置后置任务监听实现类，需实现ElasticJobListener接口 |
-### c. 作业监听配置
-#### job:distributed-listener命名空间属性详细说明
+#### elasticjob:distributed-listener命名空间属性详细说明
-job:distributed-listener必须配置为job:bean的子元素，并且在子元素中只允许出现一次
+elasticjob:distributed-listener必须配置为elasticjob:job的子元素，并且在子元素中只允许出现一次
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ------------------------------ |:-------|:-------|:---------------|:--------------------------------------------------------------------------|
diff --git a/docs/content/guide/config-manual.en.md b/docs/content/guide/config-manual.en.md
index a2b1f8b..2a834ac 100644
--- a/docs/content/guide/config-manual.en.md
+++ b/docs/content/guide/config-manual.en.md
@@ -26,11 +26,7 @@ chapter = true
### b. 作业配置
-作业配置分为 3 级，分别是 JobCoreConfiguration，JobTypeConfiguration 和 JobConfiguration。
-JobConfiguration 使用 JobTypeConfiguration，JobTypeConfiguration 使用 JobCoreConfiguration，层层嵌套。
-JobTypeConfiguration 根据不同实现类型分为 SimpleJobConfiguration，DataflowJobConfiguration 和 ScriptJobConfiguration。
-
-#### JobCoreConfiguration 属性详细说明
+#### JobConfiguration 属性详细说明
| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
| ------------------------------|:--------|:---------|:-------|:--------|
@@ -39,44 +35,19 @@ JobTypeConfiguration 根据不同实现类型分为 SimpleJobConfiguration，Dat
| shardingTotalCount | int | 是 | | 作业分片总数 |
| shardingItemParameters | String | 否 | | 分片序列号和参数用等号分隔，多个键值对用逗号分隔<br />分片序列号从0开始，不可大于或等于作业分片总数<br />如：<br/>0=a,1=b,2=c |
| jobParameter | String | 否 | | 作业自定义参数<br />作业自定义参数，可通过传递该参数为作业调度的业务方法传参，用于实现带参数的作业<br />例：每次获取的数据量、作业实例从数据库读取的主键等 |
+| monitorExecution | boolean | 否 |true | 监控作业运行时状态<br />每次作业执行时间和间隔时间均非常短的情况，建议不监控作业运行时状态以提升效率。因为是瞬时状态，所以无必要监控。请用户自行增加数据堆积监控。并且不能保证数据重复选取，应在作业中实现幂等性。<br />每次作业执行时间和间隔时间均较长的情况，建议监控作业运行时状态，可保证数据不会重复选取。 |
| failover | boolean | 否 | false | 是否开启任务执行失效转移，开启表示如果作业在一次任务执行中途宕机，允许将该次未完成的任务在另一作业节点上补偿执行 |
| misfire | boolean | 否 | true | 是否开启错过任务重新执行 |
+| maxTimeDiffSeconds | int | 否 |-1 | 最大允许的本机与注册中心的时间误差秒数<br />如果时间误差超过配置秒数则作业启动时将抛异常<br />配置为-1表示不校验时间误差 |
+| reconcileIntervalMinutes | int | 否 |10 | 修复作业服务器不一致状态服务调度间隔时间，配置为小于1的任意值表示不执行修复<br />单位：分钟 |
+| jobShardingStrategyType | String | 否 |-1 | 作业分片策略实现类全路径<br />默认使用平均分配策略<br />详情参见：[作业分片策略](/02-guide/job-sharding-strategy) |
| jobExecutorServiceHandlerType | String | 否 | | 配置作业线程池处理策略 |
| jobErrorHandlerType | String | 否 | | 配置作业异常处理策略 |
| description | String | 否 | | 作业描述信息 |
+| props | Properties | 否 | | 作业属性配置信息，对于Dataflow类型任务，配置streaming.process=true开启流式处理任务。 对于Script类型任务，配置script.command.line,指定运行脚本|
+| disabled | boolean | 否 | false | 作业是否禁止启动<br />可用于部署作业时，先禁止启动，部署结束后统一启动 |
+| overwrite | boolean | 否 | false | 本地配置是否可覆盖注册中心配置<br />如果可覆盖，每次启动作业都以本地配置为准 |
-#### SimpleJobConfiguration 属性详细说明
-
-| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
-| -----------|:---------------------|:---------|:-------|:------------------------------|
-| coreConfig | JobCoreConfiguration | 是 | | |
-| jobClass | String | 是 | | 作业实现类，需实现ElasticJob接口 |
-
-#### DataflowJobConfiguration属性详细说明
-
-| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
-| -----------------|:---------------------|:---------|:--------------|:------------------------------|
-| coreConfig | JobCoreConfiguration | 是 | | |
-| jobClass | String | 是 | | 作业实现类，需实现ElasticJob接口 |
-| streamingProcess | boolean | 否 | false | 是否流式处理数据<br />如果流式处理数据, 则fetchData不返回空结果将持续执行作业<br />如果非流式处理数据, 则处理数据完成后作业结束 |
-
-#### ScriptJobConfiguration 属性详细说明
-
-| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
-| ------------------|:---------------------|:---------|:-------|:------------------|
-| coreConfig | JobCoreConfiguration | 是 | | |
-| scriptCommandLine | String | 是 | | 脚本型作业执行命令行 |
-
-#### JobConfiguration 属性详细说明
-
-| 属性名 | 类型 | 构造器注入 | 缺省值 | 描述 |
-| -------------------------|:---------------------|:---------|:----------------|:-------------------------------------------------------|
-| jobConfig | JobTypeConfiguration | 是 | | |
-| monitorExecution | boolean | 否 |true | 监控作业运行时状态<br />每次作业执行时间和间隔时间均非常短的情况，建议不监控作业运行时状态以提升效率。因为是瞬时状态，所以无必要监控。请用户自行增加数据堆积监控。并且不能保证数据重复选取，应在作业中实现幂等性。<br />每次作业执行时间和间隔时间均较长的情况，建议监控作业运行时状态，可保证数据不会重复选取。 |
-| maxTimeDiffSeconds | int | 否 |-1 | 最大允许的本机与注册中心的时间误差秒数<br />如果时间误差超过配置秒数则作业启动时将抛异常<br />配置为-1表示不校验时间误差 |
-| jobShardingStrategyType | String | 否 |-1 | 作业分片策略实现类全路径<br />默认使用平均分配策略<br />详情参见：[作业分片策略](/02-guide/job-sharding-strategy) |
-| reconcileIntervalMinutes | int | 否 |10 | 修复作业服务器不一致状态服务调度间隔时间，配置为小于1的任意值表示不执行修复<br />单位：分钟 |
-| eventTraceRdbDataSource | String | 否 | | 作业事件追踪的数据源Bean引用 |
## 2. Spring 命名空间配置
@@ -92,7 +63,7 @@ Spring 命名空间与 Java Code 方式配置类似，大部分属性只是将
### a. 注册中心配置
-#### reg:zookeeper命名空间属性详细说明
+#### elasticjob:zookeeper命名空间属性详细说明
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ------------------------------- |:-------|:-------|:------|:--------------------------------------------------------------------------------------------------|
@@ -109,7 +80,7 @@ Spring 命名空间与 Java Code 方式配置类似，大部分属性只是将
### b. 作业配置
-#### job:simple命名空间属性详细说明
+#### elasticjob:job命名空间属性详细说明
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ----------------------------------|:--------|:--------|:----------------|:---------------------------------------------------------------------------|
@@ -131,51 +102,38 @@ Spring 命名空间与 Java Code 方式配置类似，大部分属性只是将
| job-executor-service-handler-type | String | 否 | | 扩展作业处理线程池类 |
| job-error-handler-type | String | 否 | | 扩展异常处理类 |
| description | String | 否 | | 作业描述信息 |
+| props | Properties | 否 | | 作业属性配置信息，对于Dataflow类型任务，配置streaming.process=true开启流式处理任务。对于Script类型任务，配置script.command.line,指定运行脚本|
| disabled | boolean | 否 | false | 作业是否禁止启动<br />可用于部署作业时，先禁止启动，部署结束后统一启动 |
| overwrite | boolean | 否 | false | 本地配置是否可覆盖注册中心配置<br />如果可覆盖，每次启动作业都以本地配置为准 |
-### c. 监控配置
+### c. 任务快照配置
-#### monitor:monitor 命名空间属性详细说明
+#### elasticjob:snapshot 命名空间属性详细说明
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ------------------------------- |:-------|:-------|:------|:--------------------------------------------------------------------------------------------------|
| id | String | 是 | | 监控服务在Spring容器中的主键 |
| registry-center-ref | String | 是 | | 注册中心Bean的引用，需引用reg:zookeeper的声明 |
-| monitor-port | int | 否 | -1 | 作业监控端口<br />建议配置作业监控端口, 方便开发者dump作业信息。<br />使用方法: echo "dump@jobName" \| nc 127.0.0.1 9888|
-
-#### job:dataflow命名空间属性详细说明
-
-job:dataflow命名空间拥有job:simple命名空间的全部属性，以下仅列出特有属性
-
-| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
-| ----------------- |:--------|:-------|:----------|:-------------------------------------------------------------------------------------------------------------------|
-| streaming-process | boolean | 否 | false | 是否流式处理数据<br />如果流式处理数据, 则fetchData不返回空结果将持续执行作业<br />如果非流式处理数据, 则处理数据完成后作业结束 |
-
-#### job:script命名空间属性详细说明，基本属性参照job:simple命名空间属性详细说明
+| dump-port | int | 否 | -1 | dump数据端口<br />建议配置作业dump端口, 方便开发者dump作业信息。<br />使用方法: echo "dump@jobName" \| nc 127.0.0.1 9888|
-job:script命名空间拥有job:simple命名空间的全部属性，以下仅列出特有属性
-| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
-| -------------------------------- |:-------|:--------|:------|:------------------|
-| script-command-line | String | 否 | | 脚本型作业执行命令行 |
+### d. 作业监听配置
-#### job:listener命名空间属性详细说明
+#### elasticjob:listener命名空间属性详细说明
-job:listener必须配置为job:bean的子元素，并且在子元素中只允许出现一次
+elasticjob:listener必须配置为elasticjob:job的子元素，并且在子元素中只允许出现一次
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ------------------------------ |:-------|:-------|:--------------|:--------------------------------------------------|
-| class | String |是 | | 前置后置任务监听实现类，需实现ElasticJobListener接口 |
+| class | String |是 | | 前置后置任务监听实现类，需实现ElasticJobListener接口 |
-### c. 作业监听配置
-#### job:distributed-listener命名空间属性详细说明
+#### elasticjob:distributed-listener命名空间属性详细说明
-job:distributed-listener必须配置为job:bean的子元素，并且在子元素中只允许出现一次
+elasticjob:distributed-listener必须配置为elasticjob:job的子元素，并且在子元素中只允许出现一次
| 属性名 | 类型 | 是否必填 | 缺省值 | 描述 |
| ------------------------------ |:-------|:-------|:---------------|:--------------------------------------------------------------------------|
| class | String | 是 | | 前置后置任务分布式监听实现类，需继承AbstractDistributeOnceElasticJobListener类 |
| started-timeout-milliseconds | long | 否 | Long.MAX_VALUE | 最后一个作业执行前的执行方法的超时时间<br />单位：毫秒 |
-| completed-timeout-milliseconds | long | 否 | Long.MAX_VALUE | 最后一个作业执行后的执行方法的超时时间<br />单位：毫秒 |
+| completed-timeout-milliseconds | long | 否 | Long.MAX_VALUE | 最后一个作业执行后的执行方法的超时时间<br />单位：毫秒 |
\ No newline at end of file