본문으로 건너뛰기

에이전트 설치

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

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

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

프로젝트 생성하기​

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

  1. 와탭 모니터링 서비스로 이동한 다음 로그인하세요.

  2. 프로젝트를 생성하려면 화면 왼쪽 사이드 메뉴에서 전체 프로젝트 > + 프로젝트 버튼을 선택하세요.

  3. 상품 선택 화면에서 프로젝트에 설치할 상품을 선택하세요.

  4. 프로젝트 이름, 데이터 서버 지역, 타임 존 등의 항목을 차례로 설정하세요.

  5. 모든 설정을 완료한 다음에는 프로젝트 생성하기 버튼을 선택하세요.

노트

  • 데이터 서버 지역은 리전(클라우드 서비스를 제공하기 위해 설치한 데이터 센터의 묶음)을 의미합니다. 특정 리전을 선택하면 해당 리전에 속한 데이터 센터에 사용자의 데이터를 저장합니다.

  • 타임 존은 알림, 보고서를 생성하는 기준 시간입니다.

  • 여러 개의 프로젝트를 그룹으로 묶어 관리하려면 프로젝트 그룹에서 그룹을 선택하거나 그룹을 추가하세요. 그룹에 대한 자세한 설명은 다음 문서를 참조하세요.

  • 조직을 선택한 상태에서 프로젝트를 추가할 경우 조직 하위 그룹을 필수로 설정해야 합니다.

구성도 확인​

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

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

계정 생성​

데이터베이스 모니터링을 하기 위해 필요한 권한을 가진 계정을 생성합니다. root(admin) 계정으로 로그인해 계정을 생성하세요.

노트

  • 이미 있는 계정을 사용하고 싶다면 DB 유저 파일 생성으로 넘어가세요. 권한이 없을 경우 모니터링을 시작할 수 없습니다.

  • 예시 코드에서 whatap은 DB 사용자 계정 이름입니다. 사용자가 이용하는 사용자 계정 이름으로 변경하세요.

  • 예시 코드의 DB Password에는 사용자 비밀번호를 입력하세요.

기능 및 사용 환경에 따라 추가 권한을 부여하세요.

  • PostgreSQL 10 버전 이상

    SQL
    create user whatap with password 'DB Password'; 
    grant pg_read_all_stats to whatap;

  • PostgreSQL 10 버전 미만

    SQL
    create user whatap with password 'DB Password';
    alter user whatap with superuser;

  • Kill session 기능을 사용할 경우

    데이터베이스 모니터링에서는 진행 중인 세션을 종료할 수 있는 Kill Session 기능을 제공합니다. 이 기능을 사용하려면 다음과 같이 권한을 설정하세요.

    SQL
    alter user whatap with superuser;

  • AWS RDS 환경에서 Kill session 기능을 사용할 경우

    SQL
    grant rds_superuser to whatap;

  • wal_count 수집하는 경우

    SQL
    grant execute on function pg_ls_dir(text) to whatap;  # EDB 사용 시
    alter user whatap with superuser;

  • cache 수집하는 경우

    SQL
    grant select on pg_backend_memory_contexts to whatap;
    grant execute on function pg_get_backend_memory_contexts to whatap;

  • 테이블 사이즈를 수집하는 경우

    SQL
    grant usage on schema {schema_name} to whatap;

  • 오브젝트 정보를 조회하는 경우(분석 > Top 오브젝트)

    SQL
    grant select on all tables in schema {schema_name} to whatap;

액세스 키 확인​

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

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

노트

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

DBX 에이전트 다운로드​

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

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

    BASH
    wget -O whatap.agent.database.tar.gz https://dev.whatap.io/download/agent/whata.agent.database.tar.gz

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

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

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

DBX 에이전트 설정​

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

팁

DBX 에이전트의 구성 파일 중 setup.sh 파일을 실행해 에이전트 설정을 빠르고 쉽게 진행할 수 있습니다. 자세한 내용은 다음 문서를 참조하세요.

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=postgresql
db=postgres
db_ip={DB_Server_IP}
db_port={DB_Server_Port}

JDBC 다운로드​

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

정보

PostgreSQL 9.2 버전 이상: https://jdbc.postgresql.org/download

노트

  • DB 구성에 따라 whatap.conf 파일에 추가 설정이 필요할 수 있습니다. 자세한 내용은 다음 문서를 참조하세요.

  • DB 서버의 자원을 추가로 모니터링하려면 XOS 에이전트를 이용해야 합니다. 자세한 내용은 다음 문서를 참조하세요.

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

DB 유저 파일 생성​

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

uid.sh 쉘 스크립트 파일(또는 uid.bat 배치 파일)은 와탭 데이터베이스 에이전트를 설치한 경로에서 찾을 수 있습니다. user 없이 암호만 있는 경우 DB_USER를 default로 설정합니다.

BASH
./uid.sh {DB_USER} {DB_PASSWORD}
노트

  • 최초 한번만 설정하면 그 이후부터는 암호화된 UID를 통해 모니터링 대상 데이터베이스 서버로부터 데이터 수집을 진행합니다.

  • DB 유저 파일을 생성하기 위해서는 프로젝트 액세스 키가 whatap.conf 파일에 입력되어 있어야 합니다. 액세스 키 확인

  • Azure Database 환경의 경우 DB_USER를 DB_USER@DB_name과 같은 형식으로 입력해야 합니다.

  • DB_USER 또는 DB_PASSWORD에 특수문자가 포함될 경우 특수문자 앞에 Escape Character(\)를 같이 입력하세요.

    Example
    ./uid.sh whatap whatap\!pwd

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

모니터링 시작하기​

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

./start.sh

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

./startd.sh

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

부가 에이전트(XOS) 설치 및 기타 옵션 적용하기​

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

노트

  • x86 아키텍쳐 기반에서 동작하는 OS 환경에만 적용할 수 있습니다.

  • 부가 에이전트 설치 과정은 필수가 아닌 선택 사항입니다.

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

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

    whatap.conf
    xos=1
    xos_port=3002

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

  3. 데이터베이스 서버로 이동한 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 정보를 입력하면 에이전트 옵션을 자동 생성할 수 있습니다.

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

    chmod +x ./whatap.agent.xos*

  5. XOS 에이전트를 실행하세요.

    ./start.sh
노트

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

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