Newer
Older
---
html:
toc: true
offline: true
export_on_save:
html: true
---
# 모니터링 소개
---
KSB 프레임워크에 제출된 워크플로우(워크플로우에 속한 엔진 포함)의 목록 및 상태를 확인하고 제어합니다.
각 엔진은 다음과 같은 상태를 가질 수 있습니다.
Engine Status | 설명
--|---
<span style="color:#555555">Accepted</span> | API 게이트웨이로 엔진이 제출(submit) 된 경우
<span style="color:#1F77B4">InProgress</span> | 엔진이 실행 중인 경우
<span style="color:#2ca02c">Completed</span> | 엔진이 에러없이 완료된 경우
<span style="color:#d62728">Failed</span> | 엔진 실행 중 에러가 발생하여 종료된 경우
<span style="color:#ff7f0e">Killed</span> | 사용자가 엔진 실행 중 종료한 경우
워크플로우는 워크플로우에 속한 엔진들의 상태에 따라 다음과 같은 두 가지 상태를 가질 수 있습니다.
- <span style="color:#1F77B4">Inprogress</span>
- 한 엔진이라도 Inprogress 또는 Accpted 의 상태를 가지는 경우
- <span style="color:#2ca02c">Finished</span>
- 모든 엔진이 Completed / Failed / Killed 중 하나의 상태를 가지는 경우
- 엔진 정보를 검색할 수 없는 경우
<br>
워크플로우 편집기 소개 매뉴얼을 참고하여 작성한 워크플로우를 실행한 뒤, KSB 웹툴킷 상단의 **Monitoring** 메뉴를 선택하여 "진행내역/상태모니터링" 화면으로 이동합니다.
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
## Workflow 탭
진행내역/상태 모니터링의 *workflow* 탭에서는 KSB 프레임워크에 제출된 워크플로우(워크플로우에 속한 엔진 포함)의 목록 및 상태를 확인할 수 있습니다. 또한 실행 중인 워크플로우를 종료(<span style="color:red">◼</span>)하거나, 다시 실행(<span style="color:#6698FF">▶</span>)할 수 있습니다.
**<span style="font-size: 14pt;">➀ 워크플로우 필터링</span>**
워크플로우의 목록을 필터링 하여 볼 수 있습니다. 콤보박스를 클릭하여 필터링 하고자 하는 항목을 선택하고, 값을 입력한 후 돋보기 모양의 버튼을 누르면 필터링 된 워크플로우 목록을 보여줍니다.
**<span style="font-size: 14pt;">➁ 워크플로우 개수 조절</span>**
화면에 보여지는 워크플로우의 개수를 조절할 수 있습니다. 콤보박스를 클릭하여 한 화면에서 보고자 하는 워크플로우 개수를 선택합니다.
**<span style="font-size: 14pt;">➂ 펼쳐보기/줄여보기</span>**
"펼쳐보기" 를 선택하면 워크플로우에 속한 엔진들의 목록을 일괄적으로 펼쳐서 모두 보여줍니다. "줄여보기" 를 선택하면 워크플로우에 속한 엔진들의 목록을 일괄적으로 접고 워크플로우 목록만 보여줍니다.
각 워크플로우를 개별적으로 "펼쳐보기" 하려면 워크플로우 이름 앞의 (<span style="color:#777777">✚</span>) 버튼을 클릭합니다. 각 워크플로우를 개별적으로 "줄여보기" 하려면 워크플로우 이름 앞의 (<span style="color:#777777">⁃</span>) 버튼을 클릭합니다.
**<span style="font-size: 14pt;">➃ 새로고침 </span>**
워크플로우 및 엔진의 현재 상태(Status) 를 업데이트 합니다. 상태 정보는 KSB 프레임워크에 요청하여 응답 받은 결과를 보여주는 것입니다. 기본적으로는 모니터링 페이지를 열 때 마다 새로운 정보를 수신하여 표시 합니다.
**<span style="font-size: 14pt;">➄ 자동 새로고침 </span>**
"Auto Reload" 를 체크할 경우 워크플로우 및 엔진의 상태(Status) 를 주기적으로 업데이트 합니다.
참고로, 업데이트 할 주기는 **Management** 메뉴의 **System Configuration** 탭에서 `monitoring.auto.reload.interval` 를 통해 설정합니다. 기본 값은 5000 (5초) 으로 설정되어 있습니다.
**<span style="font-size: 14pt;">➅ 개별 펼쳐보기/줄여보기 </span>**
워크플로우 이름 앞의 (<span style="color:#777777">✚</span>) 버튼을 클릭하면 워크플로우에 속한 엔진의 상세 정보를 확인할 수 있습니다 ("펼쳐보기"). 워크플로우 이름 앞의 (<span style="color:#777777">⁃</span>) 버튼을 클릭하면 워크플로우에 속한 엔진의 목록을 숨깁니다 ("줄여보기").
**<span style="font-size: 14pt;">➆ 워크플로우 세부 Spec 보기 </span>**
KSB 웹툴킷에서 워크플로우 Spec 을 작성하여 KSB 프레임워크로 제출한 워크플로우일 경우에 "세부 Speck 보기" 버튼이 활성화 됩니다. (이클립스와 같이 개발자 환경 환경을 통해 워크플로우 Spec 을 작성하여 KSB 프레임워크로 제출하거나, 클라이언트 라이브러리를 이용한 경우 "세부 Speck 보기" 버튼이 보이지 않습니다.)
"세부 Speck 보기" 버튼을 클릭하면 **워크플로우 편집기** 화면을 열어서 작성한 워크플로우의 Spec 을 보여줍니다. 이 경우, 해당 워크플로우는 새로운 워크플로우로 열리며, 수정 및 재제출 시 다른 워크플로우로 인식 됩니다.
참고로, 이 기능은 추후 json 형태의 워크플로우 Spec 을 보여주는 것으로 변경될 예정입니다.
**<span style="font-size: 14pt;">➇ 워크플로우/엔진 실행/종료 </span>**
워크플로우 및 엔진의 Status에 따라 실행 중인 워크플로우 및 엔진을 종료(<span style="color:red">◼</span>)하거나, 재실행(<span style="color:#6698FF">▶</span>)할 수 있습니다.
**<span style="font-size: 14pt;">➈ 워크플로우 삭제</span>**
워크플로우를 목록에서 삭제합니다.
## Workflow History 탭
진행내역/상태 모니터링의 *Workflow Histroy* 탭에서는 최근에 수행한 워크플로우 이력을 엔진 단위로 보여줍니다. (각 엔진은 재실행 될 때 마다 새로운 history id를 부여 받으며, 각 실행이력은 본 Workflow History 탭에서 확인할 수 있습니다.)
**<span style="font-size: 14pt;">➀ 필터링</span>**
엔진 목록을 필터링 하여 볼 수 있습니다. 콤보박스를 클릭하여 필터링 하고자 하는 항목을 선택하고, 값을 입력한 후 돋보기 모양의 버튼을 누르면 필터링 된 목록을 보여줍니다.
**<span style="font-size: 14pt;">➁ 목록 개수 조절</span>**
화면에 보여지는 목록의 개수를 조절할 수 있습니다. 콤보박스를 클릭하여 한 화면에서 보고자 하는 목록의 개수를 선택합니다.
**<span style="font-size: 14pt;">➂ 새로고침 </span>**
엔진의 상태(Status) 를 업데이트 합니다. 상태 정보는 KSB 프레임워크에 요청하여 응답 받은 결과를 보여주는 것입니다.
**<span style="font-size: 14pt;">➃ CSV 결과 파일 보기 (차트) </span>**
FileWriter 를 포함하고 있는 엔진일 경우에 "CSV 결과 파일 보기(차트)" 버튼이 활성화 됩니다. CSV 파일로 결과를 출력한 경우, 결과 파일의 내용을 확인하고 그래프로 시각화 할 수 있습니다.
"CSV 결과 파일 보기(차트)" 버튼을 클릭하면 차트보기 창이 팝업됩니다. 화면 우측에서 파일명을 선택하고 구분자, 헤더 포함 유무 등을 체크한 후 "OK" 버튼을 누릅니다.
화면 좌측에서 "Data" 는 파일의 내용을 표로 보여줍니다. "Statistics" 는 통계 정보를 보여줍니다. "Chart" 는 "Chart Style" 을 선택하여 그래프를 그려줍니다.
**<span style="font-size: 14pt;">➂ TEXT 결과 파일 보기 </span>**
FileWriter 를 포함하고 있는 엔진일 경우에 "TEXT 결과 파일 보기" 버튼이 활성화 됩니다. "TEXT 결과 파일 보기" 버튼을 클릭하면 파일의 내용을 보여주는 창이 팝업됩니다. 화면 우측에서 파일명을 선택하고 최대로 보고자 하는 길이 (Max Length) 를 입력합니다. 디폴트로 1000 바이트가 설정되어 있습니다.
**<span style="font-size: 14pt;">➂ 로그 보기 </span>**
"Show log" 버튼(<span style="color:#6698FF">ℹ</span>)을 클릭하면 로그 기록을 보여주는 창이 팝업됩니다. Line 수를 지정하여 보거나 전체 로그 보기가 가능합니다.
### 결과 파일 확인
워크플로우 실행 결과 생성된 파일은 **Monitoring** 메뉴의 *Workflow Histroy* 탭의 "CSV 결과 파일 보기 (차트)" 버튼과 "TEXT 결과 파일 보기" 버튼을 이용하여 확인할 수 있습니다.
또한 **Repository** 메뉴의 데이터저장소 관리 화면에서 결과 파일이 있는 위치로 이동하여 파일 이름 옆에 나타나는 "CSV 결과 파일 보기 (차트)" 버튼과 "TEXT 결과 파일 보기" 버튼을 이용하여 확인할 수 있습니다.
