WhaTap Server 관리자 가이드

제목 : Server Admin Guide
작성자 : WhaTap Support
이메일 : support@whatap.io
날짜 : 2019-10-22
버전 : 1.0.0

설명 : 본 문서는 WhaTap 서버 관리에 대하여 설명 합니다.

1. 용어 정리

용어 의미

Region

데이터 수집 서버의 묶음

Front

웹 UI 담당

Yard

수집된 데이터 저장소

Keeper

개별 서버들의 정보 관리

Proxy

Agent가 보낸 데이터들을 처리

Gateway

개별 Region들에 속한 Keeper

Eureka

전체 Region들을 관장

Noti

알림 발생 및 알림 발송을 담당

Account

계정정보를 관리

Agent

호스트 서버/애플리케이션의 데이터 수집 및 와탭 서버로의 데이터 전송하는 애플리케이션

2. 관리자 페이지

2.1. SERVERS

  • 해당 URL: /v2/admin/servers

serversCardView
Figure 1. Servers Cardview Page

SERVERS 페이지는 현재 세팅되어 있는 전체 서버들의 현황을 Cardview의 형태로 확인할 수 있습니다.
해당 페이지는 다중 Region으로 구성되어 있을 경우(Eureka 실행시)에만 나타나며, 단일 Region 형태로 구성시 해당 Region에 대한 정보 화면으로 바로 넘어갑니다.

serversGatewayCard
Figure 2. Gateway Server Card

다중 Region으로 구성시에는 Eureka에 등록된 서버들이 모두 Cardview 형태로 표시됩니다.
그 중 해당 Region(Gateway)에 대해서는 카드 우측 하단에 표기 되어있는 화살표 버튼을 누름으로써 해당 Region에 속한 Keeper, Proxy, Yard에 대한 정보 및 속해있는 Project들에 대한 정보들을 확인할 수 있습니다.

2.1.1. 개별 Region 정보

단일 Region 구성시 별도의 Cardview 없이 바로 해당 Region에 대한 정보가 표시됩니다.
해당 화면에서는 Keeper, Proxy, Yard, Project에 대한 정보를 확인할 수 있으며 아래 일들을 수행할 수 있습니다.

regionDetail
Figure 3. Region Detail
  • Yard 할당 적용
    각각의 Yard에 추가 Project 를 할당할 것인지 여부를 결정합니다.
    할당이 On 으로 활성화 되어있을 경우 해당 Yard 에 추가 Project 를 할당하며, 반대로 Off 로 비활성화 되어있을 경우 해당 Yard 에는 추가 Project 를 할당하지 않습니다.

    Project 할당은 Project 의 '라이선스 발급' 이 진행되었을 때 할당됩니다.
  • 개별 Project Info
    개별 Project에 대한 정보를 확인할 수 있습니다.

2.1.2. Projects 목록

serverDetailProjectList

개별 Region 정보 페이지 하단에는 Project들에 대한 정보를 포함하는 Projects 목록이 있습니다.
각 지표들에 대한 설명은 다음과 같습니다.

용어 의미

Pcode

Project 코드

Name

Project명

Core

Project에 속해있는 코어 수

Agent

Project에 속해있는 에이전트 수

Master

현재 Project 데이터가 속해있는 수집 서버

Journal

Project에 대한 백업 수집 서버 위치

Status

프로젝트 상태

Delete

사용자가 Project 삭제시 DELETE 버튼 활성화. Yard 서버에서 데이터 삭제

Info

개별 Project에 대한 정보

2.2. ACCOUNTS

  • 해당 URL: /v2/admin/accounts

account

ACCOUNTS 페이지는 현재 가입되어 있는 회원들의 정보와 각각의 회원들이 가지고 있는 정보를 확인할 수 있습니다.
자세한 정보는 상세 버튼을 눌러 진입할 수 있습니다.

2.2.1. 개별 회원 정보

accountDetail

개별 회원 정보 화면을 통해 회원 정보 및 Project 사용 현황에 대해 확인할 수 있습니다.
(Project 정보에 표기되는 정보는 SuperAdmin으로써 소유하고 있는 Project에 대한 정보만 표기됩니다)

accountTrialSetting

사용현황 란에서는 각각 언어에 대한 Project 수와 Project 생성 가능 여부, 그리고 Project 생성시 자동 유상전환 여부 등을 확인/변경할 수 있습니다.
변경 내역이 있을 경우, 반드시 우측에 있는 Edit 버튼을 눌러 수정을 적용시켜줘야 합니다.

accountProjectList

해당 사용자가 소유하고 있는(SuperAdmin) Project에 대한 정보를 확인할 수 있습니다.
선택 가능한 지표에 대한 설명은 다음과 같습니다.

용어 의미

Status

현재 Project의 구독 상태
  • Subscribe: 유료 구독

  • Trial: 체험 사용

  • Limited: 체험 사용 종료 후 미구독

  • Close_pending: 프로젝트 종료 Pending: 프로젝트 생성 후 라이선스 미발급

Notice

Project 대상으로 발생한 Notice

Detail

Project 상세 정보

2.3. PROJECTS

  • 해당 URL: /v2/admin/projects

projectMetering

PROJECTS화면의 경우 전체 사용 중인 언어별 Agent 수와 각각의 Project에 대한 정보를 확인할 수 있습니다.
최상단에 위치한 Platform별 정보의 경우, 매시각 정각에 수집된 정보를 기준으로 표기됩니다.

projectList

하단의 표를 통해 전체 프로젝트에 대한 정보를 확인할 수 있습니다. 화면에 대한 설명은 다음과 같습니다.

  • Export: 전체 프로젝트에 대한 정보를 Excel(xls) 파일 형식으로 다운 받습니다.

용어 의미

Pcode

해당 Project 코드. 권한이 있을 경우 이동 가능

Name

Project 명

PType

Project Type
  • APM: 애플리케이션 모니터링

  • SMS: 인프라 모니터링

  • DB: 데이터베이스 모니터링

Platform

Project 언어

Region

속해있는 Region

Status

구독 상태

Cores

Project에 등록되어 있는 CPU Core 수

Hosts

Project에 등록되어 있는 Host Machine 수

Group

Project가 속해있는 그룹 (없을 경우 공백)

Create Time

Project 생성일

Trial Start

체험 시작일

Trial End

체험 종료일

Trial Days

체험 기간(default 15일)

First Active

최초 Agent 가동일

Last Inactive

최종 Agent 가동일

Detail

Project 상세 페이지

2.3.1. 개별 Project 정보

projectInfo

개별 Project에 대한 정보 화면에서는 해당 Project의 정보, 소속된 Yard 서버의 정보, 그리고 현재 소속되어 있는 Project Member에 대한 정보를 추가/변경/수정/삭제할 수 있습니다.

projectYardInfo

Yard Info에는 현재 해당 Project가 속해있는 Region안에 있는 모든 Yard 서버에 대한 정보가 나타납니다.
이 중, Readable이 On으로 설정되어 있는 Yard 서버에서 데이터를 읽습니다.

Yard Info에 속해있는 지표들에 대한 설명은 다음과 같습니다.

용어 의미

ServerName

Yard 서버의 이름

Address

Yard 서버의 주소

Type

Yard 서버의 종류 Master: 주 데이터 저장 서버 Journal: 데이터 백업 서버

Readable

Yard로부터 데이터 읽기 여부 체크가 해제되어도 쓰기는 활성화

Keep

데이터 보관일 ( default : 37일 )

Copy

다른 Yard 서버로부터 데이터 복사 기능

Delete

Project 삭제

projectAccountsList

해당 Project에 속해있는 사용자들을 관리할 수 있습니다. 권한은 다음과 같습니다.

용어 의미

User

Admin

SuperAdmin

프로젝트당 한 명만 배정

2.3.2. Project Copy

projectCopy

Project 복사는 한쪽 Yard 서버에서 Data이전 작업시 다른 Yard 서버로 저장되어 있는 Data를 옮길 시 사용하는 기능입니다. 희망하는 날짜와 Port, 그리고 데이터가 저장되어 있는 Yard를 선택한 뒤 Copy를 누르면 됩니다.

  • 20000101로 시작하는 폴더는 TextDB정보를 포함하고 있습니다.
    기존 데이터 없이 새롭게 저장되는 데이터만 모니터링하길 희망하실 경우 해당 폴더만 복사해주시면 됩니다.

  • Copy 버튼 클릭 후에는 백그라운드에서 실행되기 때문에 별도의 Web화면을 띄워놓지 않아도 됩니다.

해당 기능은 아직 불안정한 상태입니다.
가급적 서버단에서 scp 명령어를 통해 이전하시는 것을 권장드립니다.

2.4. NOTICE

  • 해당 URL: /v2/admin/notice/list

{TO_BE_UPDATED}

2.5. REGIONS

  • 해당 URL: /v2/admin/regions

regionList

Region은 Project가 저장될 수집 서버의 위치를 지정합니다. 지표들에 대한 설명은 다음과 같습니다.

Region 변경은 정상적인 WhaTap 운영에 심각한 영향을 미칠 수 있습니다.
반드시 담당자를 통해 진행해주시기 바랍니다.
용어 의미

Key

해당 Region의 Key 값

GatewayName

해당 Region의 Gateway 명칭과 동일

Detail(Display)

화면상에 나타날 Region명

Region type

Region 공개 여부
  • Public: 누구나 해당 Region 선택 가능

  • Private: 선택된 이용자에게만 Region 선택권 부여

Proxy Address

해당 Region에 해당하는 Proxy 서버의 주소 (외부IP)

Proxy port

해당 Region에 해당하는 Proxy 서버의 Port

Platform

Platform 설정. APM,SMS,DB 선택 가능

Product type

사용 가능한 제품군

Edit/Delete

해당 Region 정보 수정 / 삭제

2.6. MAIL

2.6.1. Mail Setting

  • 해당 URL: /v2/admin/mail/setting

{TO_BE_UPDATED}

2.6.2. Mail Templates

  • 해당 URL: /v2/admin/mail/template

{TO_BE_UPDATED}

  • 해당 URL: /v2/admin/logos

SITELOGO 화면은 현재 지정되어 있는 Site의 Logo를 변경할 수 있도록 합니다.
이미지들은 svg포멧이 권장되며, 로고의 제원은 명시되어 있는 사이즈와 같아야 이미지가 정상적으로 출력됩니다. 각각의 로고들은 다음과 같습니다.

용어 의미

Header Logo

대시보드 화면 좌측 상단 로고

Sidebar Logo

좌측 메뉴에 노출되는 로고

Login Logo

로그인 화면에 노출되는 로고

Report Logo

리포트 화면 우측상단에 찍히는 로고

2.8. 이벤트 관리

2.8.1. 이벤트 설정

사이트 관리자가 소유한 프로젝트에 이벤트 정책을 편집합니다.

주요 기능
  • 관리자 권한의 이벤트 정책 [SITE_MASTER] 생성하기

  • 관리자 권한의 이벤트 정책을 프로젝트에 덮어쓰기

  • 프로젝트의 이벤트 정책 편집하기

페이지 이동

이벤트(Event) > 이벤트 정책(Event Policy)

Event Menu
Figure 4. Select an 'Event policy' from the 'Event' menu.
화면 구성
Event Policy
Figure 5. 이벤트 설정 페이지 (Initialization plane of the Event Policy menu)

1) 제품군 선택 탭

2) 마스터 정책 패널

3) 프로젝트 이벤트 정책 패널

주요 사용법
해당 페이지의 주 사용 목적은 1)프로젝트 제품군을 선택하여 2)해당 제품의 마스터 이벤트 정책을 생성하고, 3)관리자 소유의 프로젝트에 해당 마스터 정책을 적용하기 위함입니다.
제품군 선택

제품군 이름을 클릭하여 이벤트 설정을 위한 화면을 전환합니다.

  • APM

  • INFRA

  • DBX (준비중)

마스터 정책 관리하기

관리자 권한의 이벤트 정책을 관리합니다. 마스터 정책을 편집하여 관리자 소유의 프로젝트에 일괄적으로 적용할 수 있습니다.

마스터 정책 (SITE_MASTER)
관리자 권한의 이벤트 정책입니다. 마스터 이벤트 정책 패널에서 생성하며 '복사하기' 기능을 통해 프로젝트에 적용이 가능합니다.

Master Policy

1) 마스터 정책 복제하기
마스터 정책 목록(테이블)에서 복제할 마스터 정책을 선택하면 해당 기능이 활성화 됩니다. 클릭 시 선택한 정책과 동일한 룰의 마스터 정책이 추가됩니다.

Copy to Board Active
Figure 6. Clone the master policy / Active.

2) 마스터 정책 생성하기
아래 모양의 버튼 클릭 시 마스터 정책 생성을 위한 창이 나타납니다.

Add Button
Figure 7. Create Event Policy button for site master privileges.

3) 마스터 정책 편집하기
사이트 관리자가 생성한 마스터 정책들의 목록입니다. 설정한 이벤트 정책 이름과 이벤트 정책 종류[SITE MASTER]가 표시됩니다.

  • Radio Button : '마스터 정책 복제하기’와 '프로젝트 이벤트 정책에 덮어쓰기' 기능을 위한 마스터 정책을 선택합니다.

  • Table Row : 테이블 행을 클릭하여 편집 모달을 확장합니다.

마스터 정책을 우선 2)생성하시기 바랍니다. 마스터 정책 목록 중에서 하나를 선택하여 '프로젝트에 덮어쓰기' 또는 '마스터 정첵 복제하기’가 가능합니다.

기본 마스터 정책
마스터 정책 생성을 위한 편집창에는 기본값이 설정되어 있습니다. 이벤트 정책에 적용하는 '이벤트 룰’은 제품별로 다릅니다. 아래는 제품별 마스터 정책의 기본 설정 화면 입니다.

  • APM

Default master event policy rules for APM
Figure 8. Default master event policy rules for APM.

1) 이벤트 정책 이름
마스터 정책을 구분할 이름을 설정합니다.

2) 비활성 이벤트 룰 설정
어플리케이션 또는 에이전트의 비활성 이벤트를 위한 규칙(Rule)을 설정합니다.

3) 커스텀 이벤트 룰 추가하기 (준비 중)
이벤트 룰을 사용자 정의할 수 있습니다. json 형식의 문자열 조합을 통해 사용자 정의 이벤트 룰을 추가합니다.

4) 이벤트 룰 설정
에이전트가 수집하는 지표(Cpu, Response..)에 이벤트를 발생시키기 위한 룰을 설정합니다. 지표별 설정 방식은 아래 '이벤트 룰 편집하기' 목차를 참고해주시기 바랍니다.

5) 마스터 정책 삭제하기
마스터 정책을 삭제합니다. 삭제한 마스터 정책을 복구가 불가능합니다.

6) 저장하기
편집이 완료된 마스터 정책을 저장합니다. 저장이 정상적으로 완료되면 안내 메시지와 함께 마스터 정책 목록이 갱신됩니다.

  • INFRA