任务调度系统需求规格说明书

1、统一任务调度系统需求规格说明书文件编号：生效日期： 版本号：V0.1修改状态：0密级：编制：李晓海日期：2013/04/08审核：日期：批准： 日期： 北京联动优势科技有限公司版本控制信息版本日期描述作者V0.12013-04-08创建李晓海本文档中的所有内容为北京联动优势科技有限公司的机密和专属所有。未经北京联动优势科技有限公司的明确书面许可，任何组织或个人不得以任何目的、任何形式及任何手段复制或传播本文档部分或全部内容。本规范解释权属北京联动优势科技有限公司所有。1前言51.1文档目的51.2阅读对象51.3名词解释52需求概述62.1系统结构62.2角色分析62.3总体用例73任务管理用

2、例分析73.1维护节点83.1.1新建节点83.1.2修改节点83.1.3删除节点83.2维护应用93.2.1新增应用93.2.2修改应用93.2.3删除应用103.3维护任务组103.3.1新增任务组103.3.2修改任务组113.3.3删除任务组113.3.4配置调度规则113.4维护任务123.4.1新增任务123.4.2修改任务123.4.3删除任务133.4.4配置依赖关系133.4.5卸载任务133.4.6停止/恢复任务144任务调度用例分析144.1.1运行任务145任务监控用例分析155.1查看任务155.1.1查看任务执行统计信息155.1.2查看任务执行信息155.2查看日

3、志165.2.1查看执行日志165.2.2查看重跑日志165.2.3查看业务日志176任务干涉用例分析176.1重跑任务176.2暂停/恢复任务176.2.1暂停顶级任务组176.2.2恢复顶级任务组186.2.3暂停任务186.2.4回复任务186.3跳过任务197非功能需求191 前言1.1 文档目的该文档主要对公司内部统一任务调度系统（UMPAY-JSM）的相关需求进行了分析，为之后概要设计和详细设计提供依据。1.2 阅读对象参与统一调度系统的设计人员参与统一调度系统的产品负责人和业务人员。参与统一调度系统的开发人员。参与统一调度系统的测试人员。1.3 名词解释n UMPAY-JSM：统

4、一任务调度系统。为公司内部管理类系统和业务系统提供统一的任务注册管理，运行监控和任务干涉等相关功能。 n 分布式：任务调度系统为分布式系统，增加、维护新的调度任务的时候不影响正在运行的其他调度任务。n 服务器端：负责节点、应用、任务组以及任务的注册维护和任务执行情况的监控。n 节点端：任务真正执行处，多个应用部署在某个节点。负责任务的部署，卸载和执行。n JOBLET：最小的任务执行单元，一个Joblet代表一个完整的任务执行逻辑。 n 应用 ：一组任务组或者任务的逻辑分组，代表一个应用系统，归属于某个业务系统的需要定时调度的任务组成一个应用。如OA系统、账户管理系统等。 n 任务组：任务的逻

5、辑分组，包含多个任务组或者任务。是某个任务调度的逻辑单元。任务规则配置在任务组中。在进行任务调度的时候根据调度规则启动任务组。n 任务：在服务器端注册的最小任务单元，代表需要执行的最小单位。对应一个Joblet。n 调度规则：指定任务执行的时间，间隔、周期等信息。2 需求概述2.1 系统结构系统总体架构为分布式系统，分为服务器端和任务运行节点服务器（任务节点）。服务器端负责任务信息配置、任务调度、任务权限配置以及日志查看。任务节点运行具体任务，产生和保存业务日志。双方通过http或者TCP等协议进行远程通讯。任务调度支持自动执行和手动干预。l 根据任务调度规则配置，在指定的时间点，调度服务器就

6、把任务请求发送请求到相应的任务节点，各个任务节点上接到请求后，先返回一个响应，通知服务器是否能够启动任务，接着处理相应的任务，并根据执行的情况会返回执行结果，如有异常，可以返回异常结果，记录日志，运维人员前端进行日志下载，方便查找问题。l 手工调度：根据权限，业务任务可以手动干预任务，包括重跑任务、暂停任务、停止任务、安装、卸载任务、重新安装任务等。2.2 角色分析角色名称说明管理员负责1：节点，应用、任务等注册维护工作2：负责节点、应用、任务的停用、卸载重新安装工作3：监控任务的执行情况，查看执行日志4：干预任务，对任务进行暂停，重跑恢复等。时间根据调度规则，启动执行任务。开发人员使用系统框

7、架，开发部署任务joblet。2.3 总体用例总体需求分为任务管理、任务调度、任务监控和任务干预四个模块，具体需求描述如下：l 任务管理：管理员对需要调度的任务进行注册维护，包括注册维护基本信息以及任务的调度规则和任务依赖关系。另外管理员可以卸载、停用或者重新安装指定的任务。l 任务调度：根据调度规则，系统定时执行任务并且记录任务的执行日志。l 任务监控：管理员在任务控制台查看任务的执行情况，包括任务的总体执行统计信息或者指定某个具体的任务，查看任务历史执行情况。l 任务干预：根据需要，管理员可以对某个正在执行的任务进行干预，包括暂停某个任务，跳过任务以及重新运行某个任务等。3 任务管理用例分

8、析在任务能够被调度执行之前需要将任务注册到服务器端，管理员负责注册任务，配置任务调度规则。并且管理员能够对任务进行卸载，重新安装等。具体分为：3.1 维护节点管理员对节点基本信息进行维护。节点的核心属性包括：名称，IP地址，协议（如http、cm20等），端口号、上下文等。3.1.1 新建节点用例编号01-01用例名称新建节点用例描述新建节点参与者管理员前置条件后置条件基本流程管理员系统1，输入节点信息2，保存节点信息3，提示处理结果信息说明3.1.2 修改节点用例编号01-02用例名称修改节点用例描述修改节点参与者管理员前置条件节点信息保存完毕后置条件基本流程管理员系统1， 选择节点2，输入

9、节点信息3，保存节点信息4，提示处理结果信息说明3.1.3 删除节点用例编号01-03用例名称删除节点用例描述删除节点参与者管理员前置条件节点信息保存完毕后置条件基本流程管理员系统1， 选择节点2，保存节点信息3，提示处理结果信息说明同时级联删除节点下的应用、任务以及任务组信息3.2 维护应用管理员在指定节点下，对应用信息进行维护。核心属性包括：名称，上下文。应用必须归属与具体的节点，一个节点可以包括多个应用。3.2.1 新增应用用例编号02-01用例名称新增应用用例描述新增应用参与者管理员前置条件节点信息保存完毕后置条件基本流程管理员系统1， 输入应用信息2，保存应用信息3，提示处理结果信息

10、说明必须选择某个节点。3.2.2 修改应用用例编号02-02用例名称新增应用用例描述新增应用参与者管理员前置条件节点信息保存完毕后置条件基本流程管理员系统1,输入应用信息2，保存应用信息3，提示处理结果信息说明3.2.3 删除应用用例编号02-03用例名称新增应用用例描述新增应用参与者管理员前置条件节点信息保存完毕后置条件基本流程管理员系统1,输入应用信息2，保存应用信息3，提示处理结果信息说明级联删除应用下的任务组。3.3 维护任务组任务组指的是任务的逻辑划分单元，必须归属于某个应用。任务组fenweu顶级任务组和普通任务组。一个任务组包含多个任务组或者多个任务。任务组核心属性包括名称，上级

11、任务组，是否顶级任务组，调度规则等。维护任务组指的是管理员对任务组进行注册，维护删除操作。3.3.1 新增任务组用例编号03-01用例名称新增任务组用例描述新增任务组参与者管理员前置条件应用信息保存完毕后置条件基本流程管理员系统1,输入任务组信息2，保存任务组信息3，提示处理结果信息说明必须选择某个应用或者指定上级任务组3.3.2 修改任务组用例编号03-02用例名称修改任务组用例描述修改任务组参与者管理员前置条件任务组信息保存完毕后置条件基本流程管理员系统1,输入任务组信息2,保存任务组信息3，提示处理结果信息说明3.3.3 删除任务组用例编号03-03用例名称删除任务组用例描述删除任务组参

12、与者管理员前置条件任务组信息保存完毕后置条件基本流程管理员系统1,选择任务组2，删除任务组3，提示处理结果信息说明级联删除子任务组和任务3.3.4 配置调度规则用例编号03-04用例名称配置调度规则用例描述配置调度规则，可以选择是轮训方式或者cronTab方式，两者是互斥的。参与者管理员前置条件任务组信息保存完毕后置条件基本流程管理员系统1,输入调度规则信息2,保存任务组信息3，提示处理结果信息说明3.4 维护任务管理员对任务进行注册，维护，删除或者卸载，重新启动，停止等操作。3.4.1 新增任务用例编号04-01用例名称新增任务用例描述新增任务参与者管理员前置条件任务组信息保存完毕后置条件基

13、本流程管理员系统1， 输入任务信息2，保存任务信息4，提示处理结果信息说明3.4.2 修改任务用例编号04-02用例名称修改任务用例描述修改任务参与者管理员前置条件任务信息保存完毕后置条件基本流程管理员系统1， 输入任务信息2，保存应用信息3，提示处理结果信息说明3.4.3 删除任务用例编号04-03用例名称删除任务用例描述删除任务参与者管理员前置条件任务信息保存完毕后置条件基本流程管理员系统1， 选择任务2，保存任务信息3，提示处理结果信息说明级联删除任务参数和任务日志信息3.4.4 配置依赖关系用例编号04-04用例名称配置依赖关系用例描述配置任务和任务，任务和任务组之间的依赖关系，在任务

14、调度的时候需要根据依赖关系依次调用任务。参与者管理员前置条件任务信息保存完毕后置条件基本流程管理员系统1， 输入应用依赖信息2，保存任务信息3，提示处理结果信息说明3.4.5 卸载任务用例编号04-05用例名称卸载任务用例描述将任务进行卸载，下次任务调度的时候将不会启动此任务。参与者管理员前置条件任务信息保存完毕后置条件基本流程管理员系统1， 选择任务2，保存任务信息3，提示处理结果信息说明3.4.6 停止/恢复任务用例编号04-06用例名称停止/恢复任务用例描述将任务进行停止或者恢复。一般是在任务joblet发生变更或者出现严重错误，需要重新开发joblet的时候，可以将任务进行停止，修复完

15、毕后再将任务恢复、下次任务调度的时候将不会启动此任务。参与者管理员前置条件任务信息保存完毕后置条件基本流程管理员系统1,选择任务2，保存任务信息3，提示处理结果信息说明4 任务调度用例分析任务调度是根据调度规则（定时扫描或者cronTab），系统定时启动任务组或者任务（单独任务不能独立启动，至少需要包含在某个任务组中）。任务执行完毕后，系统收集任务执行的参数并且记录任务执行日志供管理员查看。4.1.1 运行任务用例编号05-01用例名称运行任务用例描述系统自动启动任务参与者时间前置条件以上配置信息配置完毕后置条件基本流程时间系统1， 获得需要启动的任务信息2，发送任务启动请求3，启动任务4，发

16、送任务执行结果5，记录任务执行相关信息6记录任务日志说明5 任务监控用例分析5.1 查看任务5.1.1 查看任务执行统计信息用例编号06-01用例名称查看任务执行统计信息用例描述管理员在任务控制台可以查看当前系统任务的执行情况总体信息，包括正在运行的任务数，执行成功的任务数，执行失败的任务数等。参与者管理员前置条件后置条件基本流程管理员系统1， 进入任务控制台2，查询任务执行总体信息3，显示任务执行统计信息说明5.1.2 查看任务执行信息用例编号06-02用例名称查看任务执行信息用例描述查看某个具体任务或者任务组的执行情况，包括任务本身的执行状态，所属任务组的执行状态等。参与者管理员前置条件后

17、置条件基本流程管理员系统1， 选择任务或者任务组2，查询任务执行信息4，显示任务执行信息说明5.2 查看日志日志为任务执行的情况记录，分为执行日志，重跑日志和业务日志。1， 执行日志记录任务的开始时间，结束时间，执行结果，错误信息等2， 重跑日志记录在执行重新运行任务的时候的日志信息。3， 业务日志记录具体任务执行发生的业务相关信息。其中执行日志和重跑日志由调度服务器端统一维护保存，业务日志因为涉及到具体的业务逻辑，由节点端具体的joblet产生，管理员通过任务控制台可以查看上述三种日志。5.2.1 查看执行日志用例编号06-03用例名称查看执行日志用例描述查看执行日志参与者管理员前置条件后置

18、条件基本流程管理员系统1， 查询任务或者任务组2， 选择任务或者任务组3，查询执行日志4，显示任务执行日志信息说明5.2.2 查看重跑日志用例编号06-04用例名称查看重跑日志用例描述查看重跑日志。参与者管理员前置条件后置条件基本流程管理员系统1，查询任务任务或者任务组2， 选择任务或者任务组3，查询任务重跑日志信息4，显示任务重跑日志信息说明5.2.3 查看业务日志用例编号06-05用例名称查看业务日志信息用例描述查看某个具体任务或者任务组的业务日志。因为业务日志的发生依赖于执行日志，所以需要根据执行日志获得业务日志信息。参与者管理员前置条件查看执行日志后置条件基本流程管理员系统1， 选择执

19、行日志2，查询任务业务日志信息4，显示任务业务日志信息说明6 任务干涉用例分析任务干涉指的是管理员可以在任务配置完毕或者运行过程中对任务执行进行干预，包括暂停某个任务，重新运行任务，强制立即执行某个任务等。6.1 重跑任务用例编号07-01用例名称重跑任务用例描述重新运行指定的任务参与者管理员前置条件后置条件基本流程管理员系统1， 选择任务2，重新运行任务3，提示处理结果信息说明6.2 暂停/恢复任务6.2.1 暂停顶级任务组用例编号07-02用例名称暂停顶级任务组用例描述将指定的顶级任务组暂停，同时暂停此任务组下的所有子任务组和任务。参与者管理员前置条件任务组信息保存完毕后置条件基本流程管理员系统1， 选择顶级任务组2，保存任务组信息3，提示处理结果信息说明6.2.2 恢复顶级任务组用例编号07-03用例名称恢复顶级任务组用例描述将已经暂停的顶级任务组恢复，同时恢复此任务组下的任务组和任务。参与者管