任務調度系統(tǒng)需求規(guī)格說明書

1、統(tǒng)一任務調度系統(tǒng)需求規(guī)格說明書文件編號：生效日期：版本號：V0.1修改狀態(tài)：0密級：編制：李曉海日期：2013/04/08審核：日期：批準：日期：北京聯(lián)動優(yōu)勢科技有限公司聯(lián)動UIVP版本控制信息版本日期描述作者V0.12013-04-08創(chuàng)建李曉海本文檔中的所有內容為北京聯(lián)動優(yōu)勢科技有限公司的機密和專屬所有。 未經(jīng)北京聯(lián)動優(yōu)勢科技有限公司的明確書面許可，任何組織或個人不得以任何目的、任何形式及任何手段復制或傳播本文檔部分或全部內容。本規(guī)范解釋權屬北京聯(lián)動優(yōu)勢科技有限公司所有。1前言 51.1文檔目的 51.2閱讀對象 51.3名詞解釋 52需求概述 62.1系統(tǒng)結構 62.2角色分析 62.3

2、總體用例 73任務管理用例分析 73.1維護節(jié)點 83.1.1新建節(jié)點 83.1.2修改節(jié)點 83.1.3刪除節(jié)點 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配置調度規(guī)則 113.4維護任務 123.4.1新增任務 123.4.2修改任務 123.4.3刪除任務 133.4.4配置依賴關系 133.4.5卸載任務 133.4.6停止/恢復任務 144任務調度用例分析 144.1.1 運行任務 141.%2.任 務監(jiān)控用例分析 151查看任務

3、 151.3查看任務執(zhí)行統(tǒng)計信息 151.3查看任務執(zhí)行信息 151查看日志 161.4查看執(zhí)行日志 161.4查看重跑日志 161.4查看業(yè)務日志 172.%2.任 務 干涉用例分析 172重跑任務 172暫停/恢復任務 182.4暫停頂級任務組 182.4恢復頂級任務組 182.4暫停任務 192.4回復任務 192跳過任務 203.%2.非功能需求 201 刖百文檔目的該文檔主要對公司內部統(tǒng)一任務調度系統(tǒng)(UMPAY-JSM)的相關需求進行了分析，為之后概要設計和詳細設計提供依據(jù)。閱讀對象參與統(tǒng)一調度系統(tǒng)的設計人員參與統(tǒng)一調度系統(tǒng)的產(chǎn)品負責人和業(yè)務人員參與統(tǒng)一調度系統(tǒng)的開發(fā)人員。參與統(tǒng)一

4、調度系統(tǒng)的測試人員。名詞解釋UMPAY-JSM:統(tǒng)一任務調度系統(tǒng)。為公司內部管理類系統(tǒng)和業(yè)務系統(tǒng)提供統(tǒng)一的任務注冊管理，運行監(jiān)控和任務干涉等相關功能。分布式：任務調度系統(tǒng)為分布式系統(tǒng)，增加、維護新的調度任務的時候不影響正在運行的其他調度任務。服務器端：負責節(jié)點、應用、任務組以及任務的注冊維護和任務執(zhí)行情況的監(jiān)控。節(jié)點端：任務真正執(zhí)行處，多個應用部署在某個節(jié)點。負責任務的部署，卸載和執(zhí)行。JOBLET:最小的任務執(zhí)行單元，一個 Joblet 代表一個完整的任務執(zhí)行邏輯。應用：一組任務組或者任務的邏輯分組，代表一個應用系統(tǒng)，歸屬于某個業(yè)務系統(tǒng)的需要定時調度的任務組成一個應用。如 OA 系統(tǒng)、賬戶管

5、理系統(tǒng)等。任務組：任務的邏輯分組，包含多個任務組或者任務。是某個任務調度的邏輯單元。任務規(guī)則配置在任務組中。在進行任務調度的時候根據(jù)調度規(guī)則啟動任務組。任務：在服務器端注冊的最小任務單元，代表需要執(zhí)行的最小單位。對應一個 Jobleto調度規(guī)則：指定任務執(zhí)行的時間，問隔、周期等信息。2 需求概述系統(tǒng)結構任田節(jié)點任第節(jié)總任第貨啟:系統(tǒng)總體架構為分布式系統(tǒng)，分為服務器端和任務運行節(jié)點服務器（任務節(jié)點）。服務器端負責任務信息配置、任務調度、任務權限配置以及日志查看。任務節(jié)點運行具體任務，產(chǎn)生和保存業(yè)務日志。雙方通過 http 或者 TCP 等協(xié)議進行遠程通訊。任務調度支持自動執(zhí)行和手動干預。根據(jù)任務

6、調度規(guī)則配置，在指定的時間點，調度服務器就把任務請求發(fā)送請求到相應的任務節(jié)點，各個任務節(jié)點上接到請求后，先返回一個響應，通知服務器是否能夠啟動任務，接著處理相應的任務，并根據(jù)執(zhí)行的情況會返回執(zhí)行結果，如有異常，可 以 返 回 異 常 結 果 ， 記 錄 日 志 ， 運 維 人 員 前 端 進 行 日 志 下 載 ， 方 便 查 找 問 題 。手工調度：根據(jù)權限，業(yè)務任務可以手動干預任務，包括重跑任務、暫停任務、停止任務、安裝、卸載任務、重新安裝任務等。角色分析角色名稱說明管理員1:節(jié)點，應用、任務等注冊維護工作2:女責節(jié)點、應用、任務的停用、卸載重新安裝工作3:監(jiān)控任務的執(zhí)行情況，查看執(zhí)行日志

7、4:十塊任務， 對任務進行暫停， 重跑恢復等。時間根據(jù)調度規(guī)則，啟動執(zhí)行任務。開發(fā)人員使用系統(tǒng)框架，開發(fā)部署任務 joblet。總體用例總體需求分為任務管理、任務調度、任務監(jiān)控和任務干預四個模塊，具體需求描述如下：任務管理：管理員對需要調度的任務進行注冊維護，包括注冊維護基本信息以及任務的調度規(guī)則和任務依賴關系。另外管理員可以卸載、停用或者重新安裝指定的任務。任務調度：根據(jù)調度規(guī)則，系統(tǒng)定時執(zhí)行任務并且記錄任務的執(zhí)行日志。任務監(jiān)控：管理員在任務控制臺查看任務的執(zhí)行情況，包括任務的總體執(zhí)行統(tǒng)計信息或者指定某個具體的任務，查看任務歷史執(zhí)行情況。任務干預：根據(jù)需要，管理員可以對某個正在執(zhí)行的任務進行

8、干預，包括暫停某個任務，跳過任務以及重新運行某個任務等。3 任務管理用例分析在任務能夠被調度執(zhí)行之前需要將任務注冊到服務器端，管理員負責注冊任務,配置任務調度規(guī)則。并且管理員能夠對任務進行卸載，重新安裝等。具體分為:0IM事T而圖in!lucle才_一一*TJlrrh-維護節(jié)點管理員對節(jié)點基本信息進行維護。節(jié)點的核心屬性包括：名稱，IP 地址，協(xié)議（如 http、cm20 等），端口號、上下文等。新建節(jié)點用例編號01-01用例名稱新建節(jié)點用例描述新建節(jié)點參與者管理員前置條件條件基本流程管理員系統(tǒng)1,輸入節(jié)點信息2,保存節(jié)點信息3,提示處理結果信息說明修改節(jié)點用例編號01-02用例名稱修改節(jié)點用

9、例描述修改節(jié)點參與者管理員前置條件節(jié)點信息保存完畢后置條件基本流程管理員系統(tǒng)1,1,選擇節(jié)點2,輸入節(jié)點信息3,保存節(jié)點信息4,提示處理結果信息說明刪除節(jié)點用例編號 01-03用例名稱刪除節(jié)點用例描述刪除節(jié)點參與者管理員前置條件節(jié)點信息保存完畢后置條件基本流程管理員系統(tǒng)1,選擇節(jié)點2,保存節(jié)點信息3,提示處理結果信息同時級聯(lián)刪除節(jié),照下的應用、任務以及任務組信息說明一維護應用管理員在指定節(jié)點下，對應用信息進行維護。核心屬性包括：名稱，上下文。應用必須歸屬與具體的節(jié)點，一個節(jié)點可以包括多個應用。新增應用用例編號02-01用例名稱新增應用用例描述新增應用參與者管理員前置條件節(jié)點信息保存完畢后置條件

10、基本流程管理員系統(tǒng)1,輸入應用信息2,保存應用信息3,提示處理結果信息必須選擇某個節(jié)點。說明修改應用用例編號02-02用例名稱新增應用用例描述新增應用參與者管理員前置條件節(jié)點信息保存完畢后置條件基本流程管理員系統(tǒng)1,輸入應用信息2,保存應用信息3,提示處理結果信息說明刪除應用用例編號02-03用例名稱新增應用用例描述新增應用參與者管理員前置條件節(jié)點信息保存完畢條件基本流程管理員系統(tǒng)1,輸入應用信息2,保存應用信息3,提示處理結果信息級聯(lián)刪除應用下的任務組。說明維護任務組任務組指的是任務的邏輯劃分單元，必須歸屬于某個應用。任務組 fenweu 頂級任務組和普通任務組。一個任務組包含多個任務組或者

11、多個任務。任務組核心屬性包括名稱，上級任務組，是否頂級任務組，調度規(guī)則等。維護任務組指的是管理員對任務組進行注冊，維護刪除操作。新增任務組用例編號03-01用例名稱新增任務組用例描述新增任務組參與者管理員前置條件應用信息保存完畢后置條件基本流程管理員系統(tǒng)1,輸入任務組信息2,保存任務組信息3,提示處理結果信息說明必須選擇某個應用或者指定上級任務組3.3.2修改任務組用例編號03-02用例名稱修改任務組用例描述修改任務組參與者管理員前置條件任務組信息保存完畢條件基本流程管理員系統(tǒng)1,輸入任務組信息2,保存任務組信息3,提示處理結果信息說明3.3.3刪除任務組用例編號03-03用例名稱刪除任務組用

12、例描述刪除任務組參與者管理員前置條件任務組信息保存完畢5 條件基本流程管理員系統(tǒng)1,選擇任務組2,刪除任務組3,提示處理結果信息級聯(lián)刪除子任務組和任務說明3.3.4配置調度規(guī)則用例編號03-04用例名稱配置調度規(guī)則用例描述配置調度規(guī)則，可以選擇是輪訓方式或者 cronTab 方式，兩者是互斥的。參與者管理員一前置條件任務組信息保存完畢|后置條件基本流程管理員1,輸入調度規(guī)則信息系統(tǒng)2,保存任務組信息3,提示處理結果信息說明維護任務管理員對任務進行注冊，維護，刪除或者卸載，重新啟動，停止等操作。新增任務用例編號04-01用例名稱新增任務用例描述新增任務參與者管理員前置條件任務組信息保存完畢5 條

13、件基本流程管理員系統(tǒng)1,1,輸入任務信息2,保存任務信息4,提示處理結果信息說明3.4.2修改任務用例編號04-02用例名稱修改任務用例描述修改任務參與者管理員前置條件任務信息保存完畢后置條件基本流程管理員系統(tǒng)1,輸入任務信息2,保存應用信息3,提示處理結果信息說明3.4.3刪除任務用例編號04-03用例名稱刪除任務用例描述刪除任務參與者管理員前置條件任務信息保存完畢后置條件基本流程管理員系統(tǒng)1,選擇任務2,保存任務信息3,提示處理結果信息級聯(lián)刪除任務參數(shù)和任務日志信息說明3.4.4配置依賴關系用例編號04-04用例名稱配置依賴關系用例描述配置任務和任務，任務和任務組之間的依賴關系，在任務調度

14、的時候需要根據(jù)依賴關系依次調用任務。：參與者管理員前置條件任務信息保存完畢后置條件基本流程說明管理員系統(tǒng)1,輸入應用依賴信息2,保存任務信息3,提示處理結果信息3.4.5卸載任務用例編號04-05用例名稱卸載任務用例描述將任務進行卸載，下次任務調度的時候將不會啟動此任務。參與者管理員前置條件任務信息保存完畢5 條件基本流程管理員系統(tǒng)1,選擇任務2,保存任務信息3,提示處理結果信息11|3.4.6停止/恢復任務用例編號04-06用例名稱停止/恢復任務用例描述將任務進行停止或者恢復。一般是在任務 joblet 發(fā)生變更或者出現(xiàn)嚴重錯誤，需要重新開發(fā) joblet 的時候，可以將任務進行停止，修復完

15、畢后再將任務恢復、下次任務調度的時候將不會啟動此任務。參與者管理員前置條件任務信息保存完畢后置條件基本流程管理員系統(tǒng)1,選擇任務2,保存任務信息3,提示處理結果信息說明一4 任務調度用例分析任務調度是根據(jù)調度規(guī)則（定時掃描或者 cronTab）,系統(tǒng)定時啟動任務組或者任務（單獨任務不能獨立啟動，至少需要包含在某個任務組中）。任務執(zhí)行完畢后，系統(tǒng)收集任務執(zhí)行的參數(shù)并且記錄任務執(zhí)行日志供管理員查看。4.1.1運行任務用例編號05-01用例名稱運行任務用例描述系統(tǒng)自動啟動任務參與者時間前置條件以上配置信息配置完畢后置條件基本流程時間系統(tǒng)1,獲得需要啟動的任務信息2,發(fā)送任務啟動請求-13,啟動任務4

16、,發(fā)送任務執(zhí)行結果5,記錄任務執(zhí)行相關信息6 記錄任務日志說明5 任務監(jiān)控用例分析查看任務查看任務執(zhí)行統(tǒng)計信息用例編號06-01用例名稱查看任務執(zhí)行統(tǒng)計信息用例描述管理員在任務控制臺可以查看當前系統(tǒng)任務的執(zhí)行情況總體信息，包括正在運行的任務數(shù)，執(zhí)行成功的任務數(shù)，執(zhí)行失敗的任務數(shù)等。參與者管理員前置條件后置條件基本流程說明管理員系統(tǒng)1,1,進入任務控制臺2,查詢任務執(zhí)行總體信息3,顯示任務執(zhí)行統(tǒng)計信息查看任務執(zhí)行信息用例編號06-02用例名稱查看任務執(zhí)行信息用例描述查看某個具體任務或者任務組的執(zhí)行情況，包括任務本身的執(zhí)行狀態(tài)，所屬任務組的執(zhí)行狀態(tài)等。參與者管理員前置條件條件基本流程管理員1,選擇

17、任務或者任務組系統(tǒng)2,查詢任務執(zhí)行信息4,顯示任務執(zhí)行信息說明查看日志日志為任務執(zhí)行的情況記錄，分為執(zhí)行日志，重跑日志和業(yè)務日志。執(zhí)行日志記錄任務的開始時間，結束時間，執(zhí)行結果，錯誤信息等重跑日志記錄在執(zhí)行重新運行任務的時候的日志信息。業(yè)務日志記錄具體任務執(zhí)行發(fā)生的業(yè)務相關信息。其中執(zhí)行日志和重跑日志由調度服務器端統(tǒng)一維護保存，業(yè)務日志因為涉及到具體的業(yè)務邏輯，由節(jié)點端具體的 joblet產(chǎn)生，管理員通過任務控制臺可以查看上述三種日志。5.2.1查看執(zhí)行日志用例編號06-03用例名稱查看執(zhí)行日志用例描述查看執(zhí)行日志參與者管理員前置條件后置條件基本流程管理員系統(tǒng)1,查詢任務或者任務組2,選擇任務

18、或者任務組3,查詢執(zhí)行日志4,顯示任務執(zhí)行日志信息說明5.2.2查看重跑日志用例編號06-04用例名稱查看重跑日志用例描述查看重跑日志。參與者管理員前置條件后置條件基本流程管理員1,查詢任務任務或者任務組2,選擇任務或者任務組系統(tǒng)3,查詢任務重跑日志信息4,顯示任務重跑日志信息說明5.2.3查看業(yè)務日志用例編號06-05用例名稱查看業(yè)務日志信息用例描述查看某個具體任務或者任務組的業(yè)務日志。因為業(yè)務日志的發(fā)生依賴于執(zhí)行日志，所以需要根據(jù)執(zhí)行日志獲得業(yè)務日志信息。參與者管理員前置條件查看執(zhí)行日志5 條件基本流程管理員系統(tǒng)1,選擇執(zhí)行日志2,查詢任務業(yè)務日志信息4,顯示任務業(yè)務日志信息說明6 任務干涉用例分析任務干涉指的是管理