DBX 에이전트 설정

DBX 에이전트에 필요한 설정은 whatap.conf 파일에 작성합니다. 설정할 수 있는 옵션은 다음을 참조하세요.

기본 옵션

license String

에이전트를 설치할 때 서버로부터 부여받은 프로젝트 액세스 키를 설정합니다. 프로젝트 액세스 키는 에이전트가 속한 프로젝트와 보안 통신을 위한 암호 키를 포함하고 있습니다.
whatap.server.host String

기본값 127.0.0.1,127.0.0.1

에이전트가 수집한 데이터를 전송할 와탭 수집 서버의 IP 주소를 설정하세요. 수집 서버 이중화로 2개 이상의 IP를 가진 경우 쉼표(,)를 구분자로 사용하세요. 설정한 IP 주소에는 수집 서버 proxy 데몬이 리스닝 상태로 서비스돼야 합니다.

whatap.server.port String

기본값 6600

수집 서버 포트(port)를 설정합니다. 포트는 하나만 설정할 수 있으므로 whatap_server_host에 설정한 수집 서버들은 동일 포트를 사용해야 합니다.
dbms String

whatap-docs

주의
다른 옵션 값을 입력할 경우 모니티링을 위한 데이터 수집이 정상 작동하지 않을 수 있습니다.

db String

접속할 데이터베이스 이름입니다.

db_ip String

모니터링할 데이터베이스 서버의 IP 주소를 설정합니다.

db_port String

데이터베이스가 통신에 사용하는 포트를 설정합니다.

데이터 수집

db_param_enabled Boolean

기본값 true

DB 파라미터 수집 여부를 설정합니다.

conn_fail_count Int

기본값 15

15번 연속 connection error가 발생할 때 알림을 보냅니다. 원하는 횟수를 입력해 알림 발생 기준을 조정할 수 있습니다.

long_run_session_sec Second

기본값 10 (단위: 초)

설정한 시간보다 길게 수행되고 있는 세션을 long run 세션으로 처리합니다.

tables Boolean

기본값 true

테이블 사이즈 정보를 수집합니다. 통계/보고서 > 데이터베이스 사이즈 메뉴에서 해당 데이터베이스를 선택하면 테이블 사이즈 정보를 확인할 수있습니다.

tables_hour Int

기본값 5

테이블 사이즈 정보를 저장하기 위해 정보를 수집하는 시각을 설정합니다. 기본값으로 5이며 새벽 5시에 수집을 시작합니다.

tables_min_size Int

기본값 10

테이블 정보를 수집할 때 설정한 값보다 작은 크기의 테이블 정보는 수집하지 않습니다. 테이블 데이터를 수집하는 최소 단위로 기본값은 pg_total_relation_size 기준 10 MB입니다.

replication_name String

리플리케이션 이름을 설정하면 동일한 replication_name을 갖는 DB 사이에 Master/Slave 관계가 있는 것으로 간주합니다.

리플리케이션 세트를 정의하는 옵션으로 마스터, 슬레이브 노드에 모두 동일한 값의 replication_name 옵션을 설정하면 인스턴스 모니터링에서 트리 구조로 표시됩니다. 또한 이 옵션 값을 기준으로 Flex 보드에서 리플리케이션 상태를 모니터링하는 위젯을 제공합니다.

skip_schema String

기본값: pg_catalog,sys,information_schema,pg_toast

옵션값으로 설정한 스키마의 테이블을 수집하지 않습니다.
skip_db String

기본값: edb,postgres

옵션값으로 설정한 데이터베이스의 테이블을 수집하지 않습니다.
slave_ip string

IP 주소 확인은 select inet_server_addr();로 합니다. 마스터 노드에서 pg_stat_replication.client_addr를 조회했을 때 나오는 IP 주소 중 하나여야 합니다. replication_name 옵션값이 동일하면서 Slave DB인 경우라면 slave_ip를 명시해야 합니다.

노트
RDS의 경우 IP 주소 대신 pg_replication_slots.slot_name으로 Master/Slave 관계가 셋팅되므로 slave_ip 옵션을 설정하지 않아도 됩니다.
statements_min_row Int

기본값 10000 (row)

PG SQL 통계 메뉴에서 사용하는 데이터를 수집하는 기준입니다. pg_stat_statements를 조회하며 rows 값이 statements_min_row 보다 큰 경우 수집합니다.

노트
PG SQL 통계 메뉴에 대한 자세한 내용은 다음 문서를 참조하세요.

skip_whatap_session Int

기본값 0

1을 설정하면 와탭에서 수집하기 위한 query가 동작하는 세션을 active session list에 표시하지 않습니다.(기본값: 0)

xview_min_sec Int

기본값 0

xview 수집 시, 쿼리의 수행 시간이 설정된 시간보다 오래 걸릴 때만 수집합니다. 기본 설정으로는 수행 시간이 0초 이상인 모든 쿼리를 수집합니다.

Top 오브젝트 사용 설정하기

다음은 Top 오브젝트에 대한 정보를 조회하기 위한 에이전트 설정입니다. Top 오브젝트 메뉴에 대한 자세한 내용은 다음 문서를 참조하세요.

pg_object Boolean

기본값 true

Top 오브젝트의 정보 수집 여부를 설정합니다. 정보를 수집하려면 true로 변경하세요.
pg_object_hour Int

기본값 5

Top 오브젝트의 정보를 수집 시각을 설정합니다. 기본값은 5이며 새벽 5시에 수집을 시작합니다.
table_bloat_ratio Percentage

기본값 50

테이블 bloating ratio 값이 설정값 이상인 경우 정보를 수집합니다. 기본값은 50%입니다.
table_bloat_bytes Byte

기본값 10485760

테이블 bloating bytes 값이 설정값 이상인 경우 정보를 수집합니다. 기본값은 10MB입니다.
index_bloat_ratio Percentage

기본값 50

인덱스 bloating ratio 값이 설정값 이상인 경우 정보를 수집합니다. 기본값은 50%입니다.
index_bloat_bytes Byte

기본값 10485760

인덱스 bloating bytes 값이 설정값 이상인 경우 정보를 수집합니다. 기본값은 10MB입니다.
autovacuum_list_limit Int

기본값 50

가장 오래된 age(relfrozenxid) 순으로 설정값만큼 테이블 정보를 수집합니다. 기본값은 50개입니다.

사용자 지표 수집 (SQLMON)

SQLMON으로 사용자 정의 SQL 결과를 주기적으로 수집해 메트릭스로 저장합니다. 결과가 숫자이고 실행 부하가 낮은 쿼리에 적합합니다.

sqlmon Int

기본값 1
- 1 dbx와 sqlmon 동시 실행
- 2 sqlmon만 실행

지원 버전: dbx 2.3.5 이상

설정

에이전트 설치 경로에 sqlmon 디렉터리를 생성합니다.
수집할 쿼리를 .sql 파일로 저장합니다.
whatap.conf에 SQLMON을 활성화합니다.
에이전트를 재기동합니다.
사이트맵 > 메트릭스 조회에서 sqlmon 카테고리를 확인합니다.

# whatap.conf
sqlmon=1

슬로우 쿼리 수집

슬로우 쿼리를 수집하려면 먼저 데이터베이스(DB)를 설정한 후, 사용자의 환경(온프레미스 또는 AWS RDS/Aurora)에 따라 WhaTap 설정 방법이 달라집니다.

노트

슬로우 쿼리 기능은 MySQL과 PostgreSQL만 지원합니다.

주의

데이터베이스 설정 확인하기

WhaTap 설정 전, PostgreSQL 데이터베이스(DB)에 슬로우 쿼리 관련 파라미터를 설정해야 합니다. 슬로우 쿼리 로그 기능이 활성화되어 있는지 확인하고 WhaTap 설정을 진행합니다.

log_min_duration_statement=3000  # 3초

온프레미스 환경

자체 서버에서 운영하는 경우, WhaTap의 DBX/XOS 설정 방식을 사용합니다. DBX 에이전트 설치 외에 DB 서버에 XOS를 반드시 설치해야 합니다. XOS 에이전트 설정 방법은 다음 문서를 참고하세요.

DBX whatap.conf 파일에 slow_query_log=on 옵션을 추가합니다.
- slow_query_log Boolean
  슬로우 쿼리 로깅 기능을 활성화(on)하거나 비활성화(off)합니다. PostgreSQL의 기본값은 off 입니다.
XOS가 설치되어 있으면 파일명을 자동 인식합니다. 파일명이 자동으로 인식되지 않는다면, XOS whatap.conf 파일에 slow_query=로 설정합니다.

AWS RDS/Aurora 환경

AWS RDS/Aurora 환경은 XOS 에이전트를 설치할 수 없으므로, 클라우드 설정을 통해 슬로우 쿼리를 수집할 수 있습니다.

관리 > 클라우드 설정 메뉴에서 제공되는 가이드를 따라 실행하면 사용자의 AWS 환경에서 자동으로 모니터링 리소스를 생성하여 슬로우 쿼리 데이터를 수집합니다. 별도의 추가 설정이 필요하지 않습니다. 자세한 내용은 다음 문서를 참고하세요.

노트

PostgreSQL은 DBX 에이전트 설정 방식을 지원하지 않습니다. 클라우드 설정 메뉴를 활용하면 CloudWatch 지표와 함께 슬로우 쿼리 데이터를 수집할 수 있습니다.

AES 256 암호화 적용

와탭 DBX 에이전트는 수집된 데이터를 암호화하여 서버로 전송합니다. 데이터의 중요도나 설정에 따라 이를 변경할 수 있습니다. 기본적으로 XOR 연산과 AES 알고리즘을 통한 암호화를 사용하며 평문을 128비트 단위로 나누어 암호화, 복호화를 수행합니다. 사용자 설정에 따라 256비트까지 확장할 수 있습니다.

와탭 DBX 에이전트를 설치한 경로에서 whatap.conf 파일에 다음과 같이 옵션을 추가하세요.

whatap.conf
cypher_level=256

설정을 추가한 다음 에이전트를 다시 시작하세요.

에이전트 이름 설정

자동 설정하기

에이전트 설정(whatap.conf)에서 이름을 설정하지 않으면, 에이전트 이름은 IP 주소와 포트 번호가 결합되어 자동 지정됩니다. 예를 들어, IP 주소가 10.11.12.13이고 포트 번호가 3000이라면, 에이전트 이름은 DBX-12-13-3000으로 설정됩니다.

에이전트 이름을 결정하는 주요 변수는 다음을 참조하세요.

설정	설명
`{type}`	DBX 값을 사용합니다.
`{ip0}`	IPv4 주소 중 첫 번째 단위를 사용합니다. (예시, 10.11.12.13 중 10)
`{ip1}`	IPv4 주소 중 두 번째 단위를 사용합니다. (예시, 10.11.12.13 중 11)
`{ip2}`	IPv4 주소 중 세 번째 단위를 사용합니다. (예시, 10.11.12.13 중 12)
`{ip3}`	IPv4 주소 중 네 번째 단위를 사용합니다. (예시, 10.11.12.13 중 13)
`{port}`	데이터베이스 서버 포트

노트

RDS와 같이 IP 주소가 숫자가 아니라면 DBX-{ip0}-{hash}-{port} 형식으로 이름이 설정됩니다. 여기서 {hash} 값은 IP 주소를 4자리의 16진수로 변환한 값입니다.

수동 설정하기

에이전트 이름을 직접 설정하고 싶다면, whatap.conf 파일에서 whatap.name 또는 object_name 옵션에 원하는 이름을 입력하세요. 사용자가 입력한 이름이 에이전트 이름으로 설정됩니다.

whatap.conf
whatap.name=agent-1234
# or
object_name=agent-1234

기본 옵션​

데이터 수집​

Top 오브젝트 사용 설정하기​

사용자 지표 수집 (SQLMON)​

설정​

슬로우 쿼리 수집​

온프레미스 환경​

AWS RDS/Aurora 환경​

AES 256 암호화 적용​

에이전트 이름 설정​

자동 설정하기​

수동 설정하기​