에이전트 설치

정보

이 문서는 CUBRID 모니터링 V2를 기준으로 작성했습니다. CUBRID 모니터링 V1 문서는 다음 문서를 참조하세요.

와탭 데이터베이스 모니터링 서비스 이용을 위한 기본 설치 방법을 안내합니다.

와탭 모니터링 서비스를 사용하기 위해서는 회원 가입 후 프로젝트를 생성하고 대상 서버에 에이전트를 설치해야 합니다. 회원 가입에 관한 자세한 내용은 다음 문서를 참조하세요.

다음 동영상 가이드를 참조하세요.

프로젝트 생성하기

에이전트를 설치하기 전에 먼저 프로젝트를 생성하세요.

와탭 모니터링 서비스로 이동한 다음 로그인하세요.
프로젝트를 생성하려면 화면 왼쪽 사이드 메뉴에서 전체 프로젝트 > + 프로젝트 버튼을 선택하세요.
상품 선택 화면에서 프로젝트에 설치할 상품을 선택하세요.
프로젝트 이름, 데이터 서버 지역, 타임 존 항목을 차례로 설정하세요.
알림 언어 설정에서 경고 알림 메시지의 언어를 선택하세요.
모든 설정을 완료한 다음에는 프로젝트 생성하기 버튼을 선택하세요.

노트

데이터 서버 지역은 리전(클라우드 서비스를 제공하기 위해 설치한 데이터 센터의 묶음)을 의미합니다. 특정 리전을 선택하면 해당 리전에 속한 데이터 센터에 사용자의 데이터를 저장합니다.
타임 존은 알림, 보고서를 생성하는 기준 시간입니다.
여러 개의 프로젝트를 그룹으로 묶어 관리하려면 프로젝트 그룹에서 그룹을 선택하거나 그룹을 추가하세요. 그룹에 대한 자세한 설명은 다음 문서를 참조하세요.
조직을 선택한 상태에서 프로젝트를 추가할 경우 조직 하위 그룹을 필수로 설정해야 합니다.

구성도 확인

DBX 에이전트는 별도 서버에 설치하거나 DB 서버에 설치할 수 있습니다. 설치할 방식을 선택하고 구성과 방화벽을 확인하세요.

별도 서버에 설치	DB 서버에 같이 설치

모니터링을 위한 계정 생성하기

CUBRID를 모니터링하기 위해서는 DB 계정과 CUBRID Manager 계정이 모두 필요합니다. DB 계정은 dba를 사용하세요. CUBRID Manager 계정은 다음 명령어를 이용하세요.

CUBRID Manager account

cm_admin adduser whatap whatap

노트

에이전트마다 서로 다른 이름의 계정을 사용해야 합니다.

액세스 키 확인

액세스 키는 와탭 서비스 활성화를 위한 고유 ID입니다.

설치 안내 섹션에서 프로젝트 액세스 키 발급받기 버튼을 선택하세요. 액세스 키를 자동으로 발급받은 후 다음 단계를 진행합니다.

노트

프로젝트를 생성한 다음에는 자동으로 에이전트 설치 페이지로 이동합니다. 에이전트 설치 페이지로 이동하지 않는다면 화면 왼쪽 메뉴에서 관리 > 에이전트 설치를 선택하세요.

DBX 에이전트 다운로드

DBX 에이전트 파일을 다운로드하세요. 다음 두 가지 방법을 이용하세요.

wget 명령어를 이용해 다운로드할 수 있습니다.

BASH
wget -O whatap.agent.database.tar.gz "https://service.whatap.io/download/dbx_agent?type=cubrid&format=tar.gz"

명령어로 다운로드할 수 없다면 와탭 모니터링 서비스 화면에서 다운로드 버튼을 선택하세요.

DBX 에이전트 파일을 다운로드한 다음 압축을 해제하세요.

BASH
tar -zxvf whatap.agent.database.tar.gz

노트

보안 설정으로 인해 tar 형식의 파일을 다운로드할 수 없는 사용자를 위해 ZIP 형식의 파일도 함께 제공합니다. 설치 화면에서 .zip 다운로드 버튼을 선택하세요.

DBX 에이전트 설정

에이전트 설치 화면의 안내에 따라 에이전트 설정을 진행하세요. 화면에 각 항목마다 필요한 정보를 입력하면 설정 내용 및 명령어를 자동 완성할 수 있습니다.

whatap.conf 설정

압축을 해제한 폴더로 이동해 whatap.conf 파일을 확인하세요. whatap.conf 파일에 프로젝트 액세스 키 정보 및 와탭 서버 정보, db 접속 정보를 입력하세요.

whatap.conf
license={AccessKey}
whatap.server.host=13.124.11.223/13.209.172.35 # WhaTap server information
dbms=cubrid
db={DB_Name}
db_ip={DB_Server_IP}
db_port={DB_Server_Port} 
cmd_port=8001 # CUBRID Manager server port number, default 8001
broker=query_editor,broker1

db: 모니터링 대상 데이터베이스 이름으로 $CUBRID_DATABASES/databases.txt 파일의 db_name 값입니다.
db_ip: 모니터링 대상 데이터베이스 서버에 접속 가능한 IP 주소입니다.
db_port: 브로커 설정 파일(cubrid_broker.conf)에서 BROKER_PORT 항목에 정의된 값을 입력하세요. (CUBRID의 기본값 BROKER_PORT: 33000)
cms_port: CUBRID Manager가 사용하는 포트입니다. CUBRID Manager 설정 파일(cm.conf)에서 cm_port 항목에 정의된 값을 입력하세요.
broker: CUBRID를 설치하면 broker1, query_editor로 브로커가 기본 실행됩니다. 사용자가 임의로 브로커의 이름을 변경했거나 추가적으로 기동했을 경우 변경 사항을 입력하세요.

노트

whatap.conf 파일 설정에 대한 자세한 내용은 다음 문서를 참조하세요.
CUBRID 환경의 databases.txt 파일에 대한 자세한 내용은 다음 링크를 참조하세요.
CUBRID의 브로커(broker) 설정에 대한 자세한 내용은 다음 링크를 참조하세요.

JDBC 다운로드

압축 파일을 해제한 DBX 에이전트 경로에 데이터베이스 서버의 운영체제와 버전에 맞는 JDBC 드라이버를 다운로드하세요. /압축을 해제한 폴더/jdbc

정보

데이터베이스 서버의 운영체제와 버전에 맞는 JDBC 드라이버를 다운로드하려면 다음 링크를 참조하세요.

노트

/압축해제한 폴더/jdbc/README.md 파일에서 각 데이터베이스별 JDBC 드라이버 설치 경로를 확인할 수도 있습니다.

DB 유저 파일 생성

데이터베이스 접속을 위해 암호화된 UID를 생성합니다. username과 password를 입력하고 쉘 스크립트(또는 배치 파일)를 실행하세요.

CUBRID 환경에서 유저 파일은 사용자 DB(dba)와 CUBRID Manager(admin)를 대상으로 모두 실행해야 합니다.

Linux
Windows

BASH
./uid.sh dba {DB_Password}
./cmsuid.sh admin {Admin_Password}

CMD
./uid.bat "dba" "DB_Password"
./cmsuid.bat "admin" "Admin_Password"

노트

최초 한번만 설정하면 그 이후부터는 암호화된 UID를 통해 모니터링 대상 데이터베이스 서버로부터 데이터 수집을 진행합니다.
DB 유저 파일을 생성하기 위해서는 프로젝트 액세스 키가 whatap.conf 파일에 입력되어 있어야 합니다. 액세스 키 확인
Linux 환경에서 DB_USER 또는 DB_PASSWORD에 특수문자가 포함될 경우 특수문자 앞에 Escape Character(\)를 같이 입력하세요.
Example
```
./uid.sh whatap whatap\!pwd

# 특수문자가 2개 이상일 경우 각각 이스케이프 문자 추가
./uid.sh whatap whatap\!\@pwd
```

XCUB 에이전트 설정

XCUB 에이전트는 데이터베이스 서버에 별도의 프로세스를 실행해 sql text와 지표를 수집합니다. XOS 에이전트와 함께 설치하기를 권장합니다.

whatap.conf 파일 설정

whatap.conf 파일에 다음과 같이 에이전트 옵션을 설정하세요.

whatap.conf
xcub=1
xcub_port=3002

DBX 에이전트 설치 경로 안에 xcub 폴더(/압축 해제 폴더/xcub/)를 데이터베이스 서버로 복사하세요.

노트

XOS 에이전트를 함께 설치한다면, XOS 포트를 공유하기 때문에 xcub_port 옵션은 설정할 필요 없습니다.

xcub.conf 파일 설정

데이터베이스 서버의 xcub 폴더 경로에 있는 xcub.conf 파일에 DBX 에이전트 서버 정보를 입력하고, 추가 옵션을 설정하세요.

db=demodb@127.0.0.1
dba_pwd={dba_password}
dbx_ip={DB_Agent_IP}
dbx_port=3002

db: dbname@db서버IP 형식으로 입력하세요.
dba_pwd: 비밀번호를 설정하면 최초 실행 시 xcub.pwd 파일을 생성합니다. 이후 xcub.conf 파일에서는 dba_pwd 항목을 삭제하세요.
dbx_ip: DBX 에이전트를 설치한 서버의 IP 주소를 입력하세요.
dbx_port: DBX 에이전트와 통신할 포트를 설정하세요. DBX 에이전트와는 UDP로 통신합니다. 해당 포트에 방화벽을 설정했다면 UDP 통신을 위해 방화벽을 해제하세요.

노트

XCUB 에이전트 설정에 대한 자세한 내용은 다음 문서를 참조하세요.

XCUB 에이전트 실행 권한 부여

XCUB 에이전트에 실행 권한을 부여하세요.

chmod +x ./whatap.agent.xcub*

XCUB 에이전트 실행

데이터베이스 서버에서 XCUB 에이전트 프로세스를 실행하세요.

./start.sh

노트

XCUB 에이전트를 백그라운드로 실행하려면 ./startd.sh 파일을 실행하세요.

모니터링 시작하기

에이전트를 설치한 경로에서 쉘 스크립트(또는 배치 파일)를 실행하세요.

Linux
Windows

./start.sh

데몬처럼 사용하고 싶은 경우에는 다음 명령어를 실행하세요. 단 nohup을 설치한 환경에서만 동작합니다.

./startd.sh

start.bat

Windows 시스템 시작 시 자동으로 에이전트를 시작하도록 서비스에 등록할 수 있습니다. 다음 명령어를 참조하세요.

# 서비스 등록 시
install_WindowsService.bat create WhatapDBXAgent

# 서비스 삭제 시
install_WindowsService.bat delete WhatapDBXAgent

노트

제어판 > Windows 도구 > 서비스(services.msc)에서 WhatapDBXAgent 서비스를 시작하거나 중지할 수 있습니다. 사용하는 Windows 버전에 따라 서비스 경로는 다를 수 있습니다.

데이터베이스 모니터링을 위한 에이전트 설치를 완료했습니다. 다음 문서에서 설치 후 점검 사항을 확인하세요.

XOS 에이전트 설치 (선택사항)

데이터베이스 서버의 자원을 추가로 모니터링하려면 데이터베이스 서버에 별도의 XOS 에이전트를 실행해 데이터를 수집할 수 있습니다.

노트

x86 아키텍쳐 기반에서 동작하는 OS 환경에만 적용할 수 있습니다.
부가 에이전트 설치 과정은 필수가 아닌 선택 사항입니다.

XOS 에이전트 설정 옵션에 대한 자세한 내용은 다음 문서를 참조하세요.

whatap.conf 파일 설정하기

DBX 에이전트가 설치된 경로의 whatap.conf 파일에 다음 옵션을 설정하세요.

whatap.conf
xos=1
xos_port=3002

xos 폴더(/압축 해제 폴더/xos/)를 데이터베이스 서버로 이동하세요.

xos.conf 파일 설정하기

데이터베이스 서버로 이동한 xos 경로의 xos.conf 파일에 다음 옵션을 설정하세요.

xos.conf
dbx_ip={DB_Agent_IP}
dbx_port=3002 # default 3002
cpu_limit=0
mem_limit=10240

팁

에이전트 설치 메뉴에서 DB Agent IP, DB Agent Port 항목에 DB 정보를 입력하면 에이전트 옵션을 자동 생성할 수 있습니다.

XOS 에이전트 실행하기

Linux
Windows

XOS 에이전트 실행 권한을 부여하세요.
```
chmod +x ./whatap.agent.xos*
```
XOS 에이전트를 실행하세요.
```
./start.sh
```

노트

DBX 에이전트로 모니터링한 데이터를 전송하기 위해 dbx_port로 설정한 포트(default 3002)가 열려 있어야 합니다. (UDP Outbound)
XOS 에이전트를 백그라운드로 실행하려면 ./startd.sh 파일을 실행하세요.

xos 폴더의 배치 파일로 에이전트를 실행하세요.

start.bat

화면에 표시되는 실행 로그에 에러가 없는지 확인하고 실행을 종료한 후, 다음 순서에 따라 서비스에 등록하세요.

서비스 등록

xos 폴더에 있는 install_WindowsService.bat 파일을 다음과 같이 실행하여 서비스에 등록하세요. 만약 create 옵션 다음에 이름을 입력하지 않으면 WhatapXOSAgent 이름으로 서비스에 기본 등록됩니다.
```
install_WindowsService.bat create WhatapXOSAgent
```

서비스 삭제

install_WindowsService.bat delete WhatapXOSAgent

노트

DBX 에이전트로 모니터링한 데이터를 전송하기 위해 dbx_port로 설정한 포트(default 3002)가 열려 있어야 합니다. (UDP Outbound)

다음 단계

설치 점검하기

프로젝트 생성 및 에이전트 설치, 기본 에이전트 옵션까지 모두 적용했다면 다음 문서에서 점검 사항을 확인하세요.
설치 문제 해결

에이전트 설치 시 발생할 수 있는 다양한 문제들과 이를 해결하기 위한 구체적인 지침을 제공합니다. 자세한 내용은 다음 문서를 참조하세요.
에이전트 설정

에이전트 설정(whatap.conf) 파일에 옵션을 적용해 모니터링을 위한 다양한 기능을 제공합니다. 자세한 내용은 다음 문서를 참조하세요.
데이터베이스 서버 자원을 추가로 모니터링하려면 부가 에이전트(XOS)에 추가 옵션을 설정하세요. 자세한 내용은 다음 문서를 참조하세요.

XCUB 에이전트 설정에 대한 자세한 내용은 다음 문서를 참조하세요.

모니터링 시작하기

모든 설정을 완료한 다음 데이터베이스 서버의 지표를 에이전트가 정보를 수집하기 시작합니다. 먼저 인스턴스 목록 메뉴에서 모니터링 데이터가 수집되는지 확인하세요. 인스턴스 목록에 대한 자세한 내용은 다음 문서를 참조하세요.

프로젝트 생성하기​

구성도 확인​

모니터링을 위한 계정 생성하기​

액세스 키 확인​

DBX 에이전트 다운로드​

DBX 에이전트 설정​

whatap.conf 설정​

JDBC 다운로드​

DB 유저 파일 생성​

XCUB 에이전트 설정​

whatap.conf 파일 설정​

xcub.conf 파일 설정​

XCUB 에이전트 실행 권한 부여​

XCUB 에이전트 실행​

모니터링 시작하기​

XOS 에이전트 설치 (선택사항)​

whatap.conf 파일 설정하기​

xos.conf 파일 설정하기​

XOS 에이전트 실행하기​

다음 단계​