Dashboard User Guide
제목 : Dashboard User Guide
작성자 : WhaTap Support
이메일 : support@whatap.io
날짜 : 2020-02-24
버전 : 1.0.2
설명 : 본 문서는 WhaTap Dashboard 에 대해 설명합니다.
1. Dashboard
1.1. Overview
사용자의 다양한 니즈에 대응하기 위한 사용자 정의형 통합 대시보드를 제공합니다.
사용자는 애플리케이션, 서버, 데이터베이스 모니터링과 관련한 모든 데이터를 화면에 자유자재로 배치하여 단일 대시보드를 통해 전체 모니터링 현황을 확인 할 수 있습니다.
1.1.1. Feature
-
사용자가 대시보드의 구성을 자유자재로 배치할 수 있습니다.
-
차트 유형, 데이터를 사용자가 선택하여 배치 가능한 위젯을 제공합니다.
-
각 위젯의 크기 및 위치를 사용자가 원하는 형태로 변경 가능합니다.
-
대시보드 영역 이외의 메뉴를 감출 수 있습니다.
-
대시보드 전체 사이즈를 일괄 축소하거나 확대할 수 있는 기능을 제공합니다.
-
각 개인별로 자신만의 대시보드를 생성하여 활용가능합니다.
-
개인화 된 대시보드를 타 계정에 복제하여 활용할 수 있습니다.
-
사전 구성된 템플릿을 제공하여 초기 설정을 손쉽게 진행하고, 이후 설정을 변경하여 활용할 수 있습니다.
1.2. Usage
1.2.1. Create Dashboard
대시보드의 생성 방법은 빈 대시보드를 생성하고 위젯을 추가하는 방법, 템플릿을 활용해 사전 정의된 대시보드를 생성한 후 이를 변경해 나가는 방법, 이미 추출된 메타 데이터를 기반으로 대시보드를 구성할 수 있는 방법을 제공합니다.
Start with an empty dashboard
Create dashboard 버튼을 클릭하면 선택가능한 탬플릿 목록을 볼 수 있습니다.
빈 대시보드를 생성하고자 한다면 하고, + 상자를 클릭하여 생성할 수 있습니다.
대시보드 이름과 설명을 입력한 후 Confirm 버튼을 클릭하여 대시보드를 생성합니다.
생성된 대시보드의 목록이 표시되면, 해당 대시보드를 클릭하고 2.2절의 Configure Widget 절차를 진행합니다.
Start with template of application and server
Create dashboard 버튼을 클릭하면 선택가능한 탬플릿 목록을 볼 수 있습니다.
템플릿 목록에 마우스를 올리면 템플릿에 대한 간단한 설명을 보실 수 있습니다. 생성되는 에이전트 종류(애플리케이션, 서버 등), 템플릿 명, 선택 가능한 프로젝트 개수를 확인 할 수 있습니다. 사용하고자 하는 탬플릿을 클릭합니다.
대시보드 이름과 설명을 입력한 후 프로젝트를 선택합니다.
생성된 대시보드가 대시보드 목록에 추가됩니다.
추가된 대시보드를 클릭하여 대시보드를 확인하고, 배치된 위젯의 설정을 변경하여 활용합니다.
Start with exported dashboard template
외부에 추출된 템플릿을 활용하여 대시보드를 생성하기 전에 대시보드를 추출하는 방법을 먼저 안내합니다.
대시보드 목록 우측의 
버튼을 클릭합니다.
추출 대상 대시보드의 템플릿이 팝업화면에 JSON 형식으로 표시되면 상단의 Export 버튼을 클릭합니다.
추출된 JSON 파일이 다운로드 됩니다.
추출된 템플릿 파일을 활용하여 대시보드를 생성하기 위한 절차를 안내합니다.
Import 버튼을 클릭합니다.
JSON 형식의 대시보드 파일을 선택합니다.
JSON 파일을 통해 생성된 대시보드가 목록에 추가되면, 해당 대시보드를 클릭하여 배치된 각 위젯의 설정을 변경하여 활용합니다.
1.2.2. Manage dashboard list
Copy dashboard
생성된 대시보드를 복사하여 사용하고자 한다면 복사 버튼을 클릭합니다.
복사 기능은 나에게 복사 와 다른 사람에게 복사 하는 방법이 있습니다.
나에게 복사 는 현재 자신의 대시보드 목록에 동일한 대시보드를 복사하는 기능입니다.
다른 사람에게 복사 는 자신의 대시보드를 다른 계정에 복사하는 기능입니다.
[ 참고 ] 복사한 이후에 수정된 대시보드 내용은 복사한 대시보드에 반영되지 않습니다.
다른 사람에게 복사 를 클릭하면 복사하고자 하는 대상의 계정을 검색하여 검색된 계정에 복사 및 전달이 가능합니다.
전달받은 사용자는 복사한 사용자가 구성한 대시보드와 동일한 대시보드를 확인할 수 있습니다.
만약 전달받은 사용자가 대시보드에 포함되어 있는 프로젝트의 멤버가 아니라면 아래와 같이 알림 모달이 나타납니다.
읽기 전용 은 모든 사용자에게 공유가 가능하며 프로젝트 멤버가 아니어도 프로젝트의 데이터를 확인 할 수 있습니다.
그러나 대시보드 내부의 위젯을 수정 삭제 할 수 없습니다.
읽기 전용 으로 전달 받은 사용자의 대시보드에는 읽기 전용 이라는 태그가 나타납니다. 읽기 전용 대시보드는 수정 과 삭제 는 가능하지만 복사 및 내보내기 는 불가능 합니다.
1.2.3. Configure Widget
대시보드 상에 배치되는 단위 차트를 위젯이라 합니다. 위젯을 설정하기 위해서는 차트 유형, 차트에 표현할 데이터의 선택 및 개별 데이터를 표시할지, 합산 데이터를 표시할지를 설정할 필요가 있습니다.
빈 대시보드에서 새로 위젯을 배치하는 경우라면 하기의 절차를 따라 진행합니다.
이미 배치한 위젯을 편집하는 경우 1.2.4절의 `Edit or Delete Widget`의 절차를 따라 진행합니다.
Add Widget
② Chart Type
차트 타입은 특정 제품 맞춰 특화 되어 활용하도록 만들어진 Prest 차트와 모든 제품을 표현 가능한 Custom 차트로 구분되어있습니다. 원하는 제품에 원하는 형태의 차트를 선택하여 활용할 수 있습니다.
③ Select Project
차트에 표현할 대상 프로젝트를 선택합니다. 프로젝트는 유료 사용 중인 제품이나 무료체험 기간 중에 있는 제품 혹은 무료 사용 가능한 제품만 선택 가능합니다.
④ Select Metric
선탟한 차트로 표시할 지표를 선택합니다.
아래 유형의 차트 선택 시 옵션이 표시됩니다.
-
Equalizer
-
Series Chart
-
Series Text
-
Series Comparison
⑤ Select Each, Total Okind or Total
차트에 표현할 데이터의 병합 단위를 선택할 수 있습니다.
아래 유형의 차트 선택 시 옵션이 표시됩니다.
-
Active Transaction (Arc Equalizer)
-
Active Transaction (Equalizer)
-
Active Transaction (Horizontal Bar)
-
Equalizer
-
Series Chart
-
Series Comparison
Select Agent
Next 를 누르면 프로젝트에 포함된 에이전트 (서버, 애플리케이션, 데이터베이스 등)를 선택 가능합니다.
Complete 버튼을 클릭하면 위젯이 표시됩니다.
위젯의 차트 유형은 제품에 따라 활용 대상이 구분됩니다.
| Chart Type | Product | Each/Okind Total/Total Selection | Metric Selection | Description | |
|---|---|---|---|---|---|
Preset Chart |
HITMAP |
Application |
X |
X |
|
Active Transaction (Arc Eqaulizer) |
Application |
Each/Okind Total/Total |
O |
에이전트 단위 에이전트 종류, 프로젝트 단위로 표현 가능합니다. |
|
Active Transaction (Equalizer) |
Application |
O |
O |
에이전트 단위, 프로젝트 단위로 표현 가능합니다. |
|
Active Transaction (Horizontal Bar) |
Application |
O |
O |
에이전트 단위, 프로젝트 단위로 표현 가능합니다. |
|
Active Status |
Application |
X |
X |
||
Event List |
Application |
X |
X |
프로젝트 단위 |
|
Compound Eye |
Server |
X |
X |
||
URL |
URL |
X |
X |
프로젝트 단위 |
|
Custom Chart |
Equalizer |
All |
Each/Total |
O |
|
Series Chart |
All |
Each/Total |
O |
||
Series Text |
All |
Each/Total |
O |
||
Series Comparison |
All |
X |
O |
||
Custom |
N/A |
X |
X |
문자열 또는 하이퍼링크 문자열 |
각각의 설정에 따른 Active Transaction 차트의 표현 형태는 아래와 같습니다.
1.2.4. Manage widget
Edit or Delete Widget
대시보드에 배치된 각 위젯의 우측 상단에 
를 클릭하면 수정 모달이 나타납니다.
삭제하고자한다면 X 버튼을 클릭합니다.
Adjust Widget Position and Size
표시된 위젯의 우측 하단을 드래그 하여 위젯의 사이즈를 조절하고, 위젯의 타이틀을 클릭한 후 위젯의 배치 위치를 지정합니다.
Change Theme
테마 버튼을 통해 선택 가능한 두 가지 테마를 제공합니다. 
버튼을 통해 각각의 테마를 적용한 모습은 아래와 같습니다.
2. Metrics
시계열 차트에서 사용 가능한 메트릭 속성 입니다.
2.1. Application
| 범주 | Metric | Description | 에이전트 병합 방식 |
|---|---|---|---|
트랜잭션 |
TPS |
초당 트랜잭션 처리량 |
평균 |
응답시간 |
에이전트별 평균 트랜잭션 응답 시간 |
평균 |
|
액티브 TX 건수 |
평균 진행 중 트랜잭션 개수 |
합계 |
|
TX Error 건수 |
에러 트랜잭션 건 수 |
합계 |
|
SQL 건수 |
실행 완료된 SQL 건수의 합 |
합계 |
|
SQL 에러 건수 |
SQL 에러 개수 |
합계 |
|
SQL 시간 |
SQL 수행 시간 합 |
합계 |
|
SQL 평균 수행 시간 |
SQL 수행 시간 합 |
평균 |
|
SQL 패치 건수 |
SQL Fetch 개수 합 |
합계 |
|
SQL 패치 시간 |
SQL Fetch 시간 합 |
평균 |
|
HTTPC 호출 건수 |
OutBound 외부 호출 건 수 |
합계 |
|
HTTPC 호출 에러 건수 |
OutBound 외부 호출 에러 |
합계 |
|
HTTP 호출 시간 |
OutBound 외부 호출 시간 |
합계 |
|
HTTP 호출 평균 시간 |
OutBound 외부 호출 시간 |
평균 |
|
DB 평균 연결 시간 |
DB Connection 소요 시간 |
평균 |
|
사용자 |
실시간 사용자 |
실시간 방문 사용자 |
합계 |
자원 |
CPU |
시스템 CPU 사용률 |
평균 |
CPU System |
CPU 사용률 중 System 영역 |
평균 |
|
CPU User |
CPU 사용률 중 User 영역 |
평균 |
|
CPU Wait |
CPU 사용률 중 Wait 영역 |
평균 |
|
CPU Steal |
CPU 사용률 중 Steal 영역 |
평균 |
|
CPU IRQ |
CPU 사용률 중 IRQ 영역 |
평균 |
|
Process CPU 사용률 |
애플리케이션 프로세스(Java, Apache, Python, NodeJS 등) CPU 사용량 |
평균 |
|
힙 전체 |
Total Heap Size |
평균 |
|
힙 사용 |
Used Heap Size |
평균 |
|
힙 펌 |
Permanant Heap 사용량 |
평균 |
|
DB 활성 카운트 |
Active 상태의 DB Connection Pool 수 |
합계 |
|
DB Idle 카운트 |
Idle 상태의 DB Connection Pool 수 |
합계 |
|
Heap Pending Finalization |
finally() 메소드 내에서 GC 대기중인 Object 수 |
평균 |
|
GC 건수 |
Full, Minor 를 포함한 GC |
평균 |
|
GC 시간 |
GC 에 소비된 시간 |
평균 |
|
Old Generation GC 건수 |
Full GC 횟수 |
합계 |
|
메모리 |
시스템 메모리 사용률 |
평균 |
2.2. Server
| Metric | Description |
|---|---|
CPU |
CPU 사용량 (Machine CPU) |
CPU Sys / Usr / Wait / Irq / Steal |
CPU사용량(%)을 세분화한 데이터 |
Memory |
시스템 메모리 사용율(%) |
Disk |
Disk는 Java Process의 Current 디렉토리의 사용율(%) |
2.3. Database
2.3.1. PostgreSQL
| Metric | Description |
|---|---|
Active Sessions |
쿼리를 실행중인 세션 수 |
Deadlock Count |
감지 된 deadlock 의 수 |
Commit Count |
커밋 된 트랜잭션의 수 |
Rollback Count |
롤백 된 트랜잭션의 수 |
DML Count |
DML(insert, update, delete) 수행 횟수 |
BLKS Read |
읽은 디스크 블록 수 (Physical read) |
BLKS Hit |
디스크 블록 캐시 히트 수(디스크 블록이 이미 버퍼 캐시에 있어서 읽기가 필요하지 않은 횟수. Logical read) |
BLKS Hit Ratio |
blks hit(캐시 히트)와 blks read(디스크 읽은 횟수)의 비율 |
Check Point |
checkpoint 가 수행 된 횟수 |
Total Sessions |
모든 세션 수 |
Total Runtime |
active session 들의 실행 시간 합 |
Long Running Sessions |
실행 시간이 긴 세션 수 |
Lock Wait Sessions |
lock 을 wait 하는 세션 수 |
Table Hit Ratio |
테이블의 blks hit(캐시 히트)와 blks read(디스크 읽은 횟수)의 비율 |
Index Hit Ratio |
인덱스의 blks hit(캐시 히트)와 blks read(디스크 읽은 횟수)의 비율 |
Vacuum Running Count |
vacuum 이 실행 된 횟수 |
2.3.2. Oracle
| Metric | Description |
|---|---|
CPU |
db의 cpu 사용율 |
Active Sessions |
쿼리를 실행중인 세션 수 |
Total Sessions |
모든 세션 수 |
Lock Wait Sessions |
lock 을 wait 하는 세션 수 |
Session Logical Reads |
데이타를 buffer cache 내에서 읽은 횟수 |
Physical Reads |
데이타를 물리적인 disk에서 읽은 횟수 |
Execute Count |
sql의 실행 수 |
Opened Cursors Current |
현재 열려 있는 cursor의 수 |
Parse Count (hard) |
hard parse 횟수 |
Parse Count (total) |
전체 parse 횟수(hard + soft) |
Enqueue Waits |
enqueue 대기 횟수 |
Logons Current |
현재 logon 되어 있는 수 |
User Commits |
commit 실행 횟수 |
CPU used by this session |
session 에 의해 사용된 cpu time 의 합 |
DB Time |
db 사용에 소요된 시간 합 |
Physical Writes |
데이타를 disk 에 기록한 횟수 |
Sorts (memory) |
memory에서 disk에 기록하는 중 sort한 시간 비율 |
DB File Sequential Read |
서비스 시간 중 쓰기를 위해 wait 하는 비율(Single-block reads) |
DB File Scattered Read |
서비스 시간 중 쓰기를 위해 wait 하는 비율(Multi-block reads) |
Wait Sessions |
event 를 wait 하는 세션 수 |
Txn Sessions |
transaction 이 있는 세션 수 |
Long Running Sessions |
lock 을 wait 하는 세션 수 |
2.3.3. MySQL
| Metric | Description |
|---|---|
Innodb Buffer Pool Read Requests |
논리 read 요청 횟수 |
Innodb Buffer Pool Reads |
물리적 read를 한 횟수 |
Threads Connected |
현재 접속 되어 있는 세션 수 |
Threads Running |
쿼리를 실행중인 세션 수 |
Questions |
실행된 query 의 수 |
Com Select |
Select 명령을 실행한 횟수 |
Writes |
write 에 사용한 명령 횟수 |
Bytes Received |
db 서버가 받은 데이터 bytes |
Bytes Sent |
db 서버가 보낸 데이터 bytes |
Innodb Row Lock Current Waits |
Lock 의 수 |
Connections |
DB 에 접속 시도 횟수 |
Com Commit |
commit 횟수 |
Com Rollback |
rollback 횟수 |
Innodb Rows Read |
select 에서 처리된 row 수 |
Innodb Rows Writes |
write 에서 처리된 row 수 |
Innodb Row Lock Waits |
row lock wait 한 수 |
Innodb Row Lock Time |
row lock wait 한 시간 |
Sort Rows |
sort 처리한 row 수 |