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

统一任务调度系统统一任务调度系统 需求规格说明书需求规格说明书 文件编号 生效日期 版本号 V0 1修改状态 0密级 编制 李晓海 日期 2013 04 08 审核 日期 批准 日期 北京联动优势科技有限公司 版本控制信息版本控制信息 版本日期描述作者 V0 12013 04 08创建李晓海 本文档中的所有内容为北京联动优势科技有限公司的机密和专属所有 未 经北京联动优势科技有限公司的明确书面许可 任何组织或个人不得以任何目 的 任何形式及任何手段复制或传播本文档部分或全部内容 本规范解释权属北京联动优势科技有限公司所有 1前言前言 5 1 1文档目的文档目的 5 1 2阅读对象阅读对象 5 1 3名词解释名词解释 5 2需求概述需求概述 6 2 1系统结构系统结构 6 2 2角色分析角色分析 6 2 3总体用例总体用例 7 3任务管理用例分析任务管理用例分析 7 3 1维护节点维护节点 8 3 1 1新建节点新建节点 8 3 1 2修改节点修改节点 8 3 1 3删除节点删除节点 8 3 2维护应用维护应用 9 3 2 1新增应用新增应用 9 3 2 2修改应用修改应用 9 3 2 3删除应用删除应用 10 3 3维护任务组维护任务组 10 3 3 1新增任务组新增任务组 10 3 3 2修改任务组修改任务组 11 3 3 3删除任务组删除任务组 11 3 3 4配置调度规则配置调度规则 11 3 4维护任务维护任务 12 3 4 1新增任务新增任务 12 3 4 2修改任务修改任务 12 3 4 3删除任务删除任务 13 3 4 4配置依赖关系配置依赖关系 13 3 4 5卸载任务卸载任务 13 3 4 6停止停止 恢复任务恢复任务 14 4任务调度用例分析任务调度用例分析 14 4 1 1运行任务运行任务 14 5任务监控用例分析任务监控用例分析 15 5 1查看任务查看任务 15 5 1 1查看任务执行统计信息查看任务执行统计信息 15 5 1 2查看任务执行信息查看任务执行信息 15 5 2查看日志查看日志 16 5 2 1查看执行日志查看执行日志 16 5 2 2查看重跑日志查看重跑日志 16 5 2 3查看业务日志查看业务日志 17 6任务干涉用例分析任务干涉用例分析 17 6 1重跑任务重跑任务 17 6 2暂停暂停 恢复任务恢复任务 17 6 2 1暂停顶级任务组暂停顶级任务组 17 6 2 2恢复顶级任务组恢复顶级任务组 18 6 2 3暂停任务暂停任务 18 6 2 4回复任务回复任务 18 6 3跳过任务跳过任务 19 7非功能需求非功能需求 19 1 前言前言 1 1 文档目的文档目的 该文档主要对公司内部统一任务调度系统 UMPAY JSM 的相关需求进 行了分析 为之后概要设计和详细设计提供依据 1 2 阅读对象阅读对象 参与统一调度系统的设计人员 参与统一调度系统的产品负责人和业务人员 参与统一调度系统的开发人员 参与统一调度系统的测试人员 1 3 名词解释名词解释 UMPAY JSM 统一任务调度系统 为公司内部管理类系统和业务系统 提供统一的任务注册管理 运行监控和任务干涉等相关功能 分布式 任务调度系统为分布式系统 增加 维护新的调度任务的时候 不影响正在运行的其他调度任务 服务器端 负责节点 应用 任务组以及任务的注册维护和任务执行情 况的监控 节点端 任务真正执行处 多个应用部署在某个节点 负责任务的部署 卸载和执行 JOBLET 最小的任务执行单元 一个 Joblet 代表一个完整的任务执行 逻辑 应用 一组任务组或者任务的逻辑分组 代表一个应用系统 归属于 某个业务系统的需要定时调度的任务组成一个应用 如 OA 系统 账户 管理系统等 任务组 任务的逻辑分组 包含多个任务组或者任务 是某个任务调度 的逻辑单元 任务规则配置在任务组中 在进行任务调度的时候根据调 度规则启动任务组 任务 在服务器端注册的最小任务单元 代表需要执行的最小单位 对 应一个 Joblet 调度规则 指定任务执行的时间 间隔 周期等信息 2 需求概述需求概述 2 1 系统结构系统结构 系统总体架构为分布式系统 分为服务器端和任务运行节点服务器 任务 节点 服务器端负责任务信息配置 任务调度 任务权限配置以及日志查看 任务节点运行具体任务 产生和保存业务日志 双方通过 http 或者 TCP 等协议 进行远程通讯 任务调度支持自动执行和手动干预 根据任务调度规则配置 在指定的时间点 调度服务器就把任务请求发送请求到 相应的任务节点 各个任务节点上接到请求后 先返回一个响应 通知服务器是 否能够启动任务 接着处理相应的任务 并根据执行的情况会返回执行结果 如 有异常 可以返回异常结果 记录日志 运维人员前端进行日志下载 方便查找 问题 手工调度 根据权限 业务任务可以手动干预任务 包括重跑任务 暂停任务 停止任务 安装 卸载任务 重新安装任务等 2 2 角色分析角色分析 角色名称说明 管理员负责 1 节点 应用 任务等注册维护工作 2 负责节点 应用 任务的停用 卸 载重新安装工作 3 监控任务的执行情况 查看执行日 志 4 干预任务 对任务进行暂停 重跑 恢复等 时间根据调度规则 启动执行任务 开发人员使用系统框架 开发部署任务 joblet 2 3 总体用例总体用例 总体需求分为任务管理 任务调度 任务监控和任务干预四个模块 具体需求 描述如下 任务管理 管理员对需要调度的任务进行注册维护 包括注册维护基本信 息以及任务的调度规则和任务依赖关系 另外管理员可以卸载 停用或者 重新安装指定的任务 任务调度 根据调度规则 系统定时执行任务并且记录任务的执行日志 任务监控 管理员在任务控制台查看任务的执行情况 包括任务的总体执 行统计信息或者指定某个具体的任务 查看任务历史执行情况 任务干预 根据需要 管理员可以对某个正在执行的任务进行干预 包括 暂停某个任务 跳过任务以及重新运行某个任务等 3 任务管理用例分析任务管理用例分析 在任务能够被调度执行之前需要将任务注册到服务器端 管理员负责注册任务 配置任务调度规则 并且管理员能够对任务进行卸载 重新安装等 具体分为 3 1 维护节点维护节点 管理员对节点基本信息进行维护 节点的核心属性包括 名称 IP 地址 协议 如 http cm20 等 端口号 上下文等 3 1 1 新建节点新建节点 用例编号用例编号 01 01 用例名称用例名称新建节点 用例描述用例描述新建节点 参与者参与者管理员 前置条件前置条件 后置条件后置条件 管理员系统基本流程基本流程 1 输入节点信息 2 保存节点信息 3 提示处理结果信息 说明说明 3 1 2 修改节点修改节点 用例编号用例编号 01 02 用例名称用例名称修改节点 用例描述用例描述修改节点 参与者参与者管理员 前置条件前置条件节点信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 选择节点 2 输入节点信息 3 保存节点信息 4 提示处理结果信息 说明说明 3 1 3 删除节点删除节点 用例编号用例编号 01 03 用例名称用例名称删除节点 用例描述用例描述删除节点 参与者参与者管理员 前置条件前置条件节点信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 选择节点 2 保存节点信息 3 提示处理结果信息 说明说明同时级联删除节点下的应用 任务以及任务组信息 3 2 维护应用维护应用 管理员在指定节点下 对应用信息进行维护 核心属性包括 名称 上下文 应用必须归属与具体的节点 一个节点可以包括多个应用 3 2 1 新增应用新增应用 用例编号用例编号 02 01 用例名称用例名称新增应用 用例描述用例描述新增应用 参与者参与者管理员 前置条件前置条件节点信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 输入应用信息 2 保存应用信息 3 提示处理结果信息 说明说明必须选择某个节点 3 2 2 修改应用修改应用 用例编号用例编号 02 02 用例名称用例名称新增应用 用例描述用例描述新增应用 参与者参与者管理员 前置条件前置条件节点信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 输入应用信息 2 保存应用信息 3 提示处理结果信息 说明说明 3 2 3 删除应用删除应用 用例编号用例编号 02 03 用例名称用例名称新增应用 用例描述用例描述新增应用 参与者参与者管理员 前置条件前置条件节点信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 输入应用信息 2 保存应用信息 3 提示处理结果信息 说明说明级联删除应用下的任务组 3 3 维护任务组维护任务组 任务组指的是任务的逻辑划分单元 必须归属于某个应用 任务组 fenweu 顶级任务组和普通任务组 一个任务组包含多个任务组或者多个任务 任务组核心属性包括名称 上级任务组 是否顶级任务组 调度规则等 维护任务组指的是管理员对任务组进行注册 维护删除操作 3 3 1 新增任务组新增任务组 用例编号用例编号 03 01 用例名称用例名称新增任务组 用例描述用例描述新增任务组 参与者参与者管理员 前置条件前置条件应用信息保存完毕 后置条件后置条件 基本流程基本流程管理员系统 1 输入任务组信息 2 保存任务组信息 3 提示处理结果信息 说明说明必须选择某个应用或者指定上级任务组 3 3 2 修改任务组修改任务组 用例编号用例编号 03 02 用例名称用例名称修改任务组 用例描述用例描述修改任务组 参与者参与者管理员 前置条件前置条件任务组信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 输入任务组信息 2 保存任务组信息 3 提示处理结果信息 说明说明 3 3 3 删除任务组删除任务组 用例编号用例编号 03 03 用例名称用例名称删除任务组 用例描述用例描述删除任务组 参与者参与者管理员 前置条件前置条件任务组信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 选择任务组 2 删除任务组 3 提示处理结果信息 说明说明级联删除子任务组和任务 3 3 4 配置调度规则配置调度规则 用例编号用例编号 03 04 用例名称用例名称配置调度规则 用例描述用例描述配置调度规则 可以选择是轮训方式或者 cronTab 方式 两者是互斥的 参与者参与者管理员 前置条件前置条件任务组信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 输入调度规则信息 2 保存任务组信息 3 提示处理结果信息 说明说明 3 4 维护任务维护任务 管理员对任务进行注册 维护 删除或者卸载 重新启动 停止等操作 3 4 1 新增任务新增任务 用例编号用例编号 04 01 用例名称用例名称新增任务 用例描述用例描述新增任务 参与者参与者管理员 前置条件前置条件任务组信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 输入任务信息 2 保存任务信息 4 提示处理结果信息 说明说明 3 4 2 修改任务修改任务 用例编号用例编号 04 02 用例名称用例名称修改任务 用例描述用例描述修改任务 参与者参与者管理员 前置条件前置条件任务信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 输入任务信息 2 保存应用信息 3 提示处理结果信息 说明说明 3 4 3 删除任务删除任务 用例编号用例编号 04 03 用例名称用例名称删除任务 用例描述用例描述删除任务 参与者参与者管理员 前置条件前置条件任务信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 选择任务 2 保存任务信息 3 提示处理结果信息 说明说明级联删除任务参数和任务日志信息 3 4 4 配置依赖关系配置依赖关系 用例编号用例编号 04 04 用例名称用例名称配置依赖关系 用例描述用例描述配置任务和任务 任务和任务组之间的依赖关系 在任务 调度的时候需要根据依赖关系依次调用任务 参与者参与者管理员 前置条件前置条件任务信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 输入应用依赖信息 2 保存任务信息 3 提示处理结果信息 说明说明 3 4 5 卸载任务卸载任务 用例编号用例编号 04 05 用例名称用例名称卸载任务 用例描述用例描述将任务进行卸载 下次任务调度的时候将不会启动此任务 参与者参与者管理员 前置条件前置条件任务信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 选择任务 2 保存任务信息 3 提示处理结果信息 说明说明 3 4 6 停止停止 恢复任务恢复任务 用例编号用例编号 04 06 用例名称用例名称停止 恢复任务 用例描述用例描述将任务进行停止或者恢复 一般是在任务 joblet 发生变更 或者出现严重错误 需要重新开发 joblet 的时候 可以将 任务进行停止 修复完毕后再将任务恢复 下次任务调度的时候将不会启动此任务 参与者参与者管理员 前置条件前置条件任务信息保存完毕 后置条件后置条件 管理员系统基本流程基本流程 1 选择任务 2 保存任务信息 3 提示处理结果信息 说明说明 4 任务调度用例分析任务调度用例分析 任务调度是根据调度规则 定时扫描或者 cronTab 系统定时启动任务组或 者任务 单独任务不能独立启动 至少需要包含在某个任务组中 任务执行完 毕后 系统收集任务执行的参数并且记录任务执行日志供管理员查看 4 1 1 运行任务运行任务 用例编号用例编号 05 01 用例名称用例名称运行任务 用例描述用例描述系统自动启动任务 参与者参与者时间 前置条件前置条件以上配置信息配置完毕 后置条件后置条件 时间系统基本流程基本流程 1 获得需要启动的任务信息 2 发送任务启动请求 3 启动任务 4 发送任务执行结果 5 记录任务执行相关信息 6 记录任务日志 说明说明 5 任务监控用例分析任务监控用例分析 5 1 查看任务查看任务 5 1 1 查看任务执行统计信息查看任务执行统计信息 用例编号用例编号 06 01 用例名称用例名称查看任务执行统计信息 用例描述用例描述管理员在任务控制台可以查看当前系统任务的执行情况总 体信息 包括正在运行的任务数 执行成功的任务数 执 行失败的任务数等 参与者参与者管理员 前置条件前置条件 后置条件后置条件 管理员系统基本流程基本流程 1 进入任务控制台 2 查询任务执行总体信息 3 显示任务执行统计信息 说明说明 5 1 2 查看任务执行信息查看任务执行信息 用例编号用例编号 06 02 用例名称用例名称查看任务执行信息 用例描述用例描述查看某个具体任务或者任务组的执行情况 包括任务本身 的执行状态 所属任务组的执行状态等 参与者参与者管理员 前置条件前置条件 后置条件后置条件 管理员系统基本流程基本流程 1 选择任务或者任务组 2 查询任务执行信息 4 显示任务执行信息 说明说明 5 2 查看日志查看日志 日志为任务执行的情况记录 分为执行日志 重跑日志和业务日志 1 执行日志记录任务的开始时间 结束时间 执行结果 错误信息等 2 重跑日志记录在执行重新运行任务的时候的日志信息 3 业务日志记录具体任务执行发生的业务相关信息 其中执行日志和重跑日志由调度服务器端统一维护保存 业务日志因为涉及 到具体的业务逻辑 由节点端具体的 joblet 产生 管理员通过任务控制台可 以查看上述三种日志 5 2 1 查看执行日志查看执行日志 用例编号用例编号 06 03 用例名称用例名称查看执行日志 用例描述用例描述查看执行日志 参与者参与者管理员 前置条件前置条件 后置条件后置条件 管理员系统基本流程基本流程 1 查询任务或者任务组 2 选择任务或者任务组 3 查询执行日志 4 显示任务执行日志信息 说明说明 5 2 2 查看重跑日志查看重跑日志 用例编号用例编号 06 04 用例名称用例名称查看重跑日志 用例描述用例描述查看重跑日志 参与者参与者管理员 前置条件前置条件 后置条件后置条件 管理员系统 1 查询任务任务或者任务 组 基本流程基本流程 2 选择任务或者任务组 3 查询任务重跑日志信息 4 显示任务重跑日志信息 说明说明 5 2 3 查看业务日志查看业务日志 用例编号用例编号 06 05 用例名称用例名称查看业务日志信息 用例描述用例描述查看某个具体任务或者任务组的业务日志 因为业务日志 的发生依赖于执行日志 所以需要根据执行日志获得业务 日志信息 参与者参与者管理员 前置条件前置条件查看执行日志 后置条件后置条件 管理员系统基本流程基本流程 1 选择执行日志 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 用例名称用例名称恢复顶级任务组 用例描述用例描述将已经暂停的顶级任务组恢复 同时恢复此任务组下的任 务组和任务 参与者参与者管理员 前置条件前置条件指定的顶级任务已经暂停 后置条件后置条