본문으로 건너뛰기

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

    redis

    주의

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

  • db_ip String

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

  • db_port String

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

클러스터 구성​

  • cluster_name String

    클러스터 세트를 정의하는 옵션으로 동일한 cluster_name 옵션 값을 갖는 데이터베이스들은 대시보드 > 인스턴스 목록 메뉴에서 트리 구조로 표시됩니다. 멀티 인스턴스 모니터링 메뉴의 에이전트 선택 옵션에서 클러스터별 에이전트 항목을 선택해 클러스터를 구성하는 인스턴스들끼리 대시보드에 표현되어 한눈에 모니터링할 수 있습니다. 일부 위젯은 클러스터 단위의 정보를 제공합니다. 자세한 내용은 다음 문서를 참조하세요.

데이터 수집​

  • db_param_enabled Boolean

    기본값 true

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

  • conn_fail_count Int

    기본값 15

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

  • idle_as_active Second

    기본값 1

    세션이 마지막 active 상태였던 이후로 idle 상태를 유지한 시간(초)이 설정값보다 작은 세션들을 active session으로 간주하는 옵션입니다. 예를 들어 설정값이 1이면, 1초 이내에 active였던 세션들이 액티브 세션 창에 나타납니다.

AWS RDS CloudWatch 적용​

AWS CloudWatch를 이용하는 에이전트 설정에 대한 설명입니다. 수집을 시작하면 메트릭스에 포함되며, 관리 > 메트릭스 차트 메뉴의 db_redis_counter 카테고리에서 다른 지표들과 함께 확인할 수 있습니다.

  • aws_region String

    AWS 리전을 설정합니다.

  • aws_arn String

    AWS 인증을 위해 적절한 권한을 가진 IAM ROLE의 ARN을 사용할 수 있습니다.

    필수 권한

    ROLE은 다음의 권한(Policy)이 필요합니다.

    권한권한 내용
    rds:DescribeDBInstances인스턴스 클래스 정보 수집
    rds:DescribeDBClustersautoscale 사용 시 클러스터의 정보 수집
    rds:DescribeDBLogFilesCloudWatch 로그 수집
    rds:DownloadDBLogFilePortionCloudWatch 로그 수집
    ec2:DescribeInstanceTypes인스턴스 클래스에 해당하는 cpu 개수 수집
    elasticache:DescribeCacheClusterselasticache 이용 시 인스턴스 클래스 정보 수집
    cloudwatch:ListMetricsCloudWatch 지표 리스트 수집
    cloudwatch:GetMetricStatisticsCloudWatch 지표의 값 수집
    logs:DescribeLogStreamsCloudWatch 로그 수집(게시된 로그 기능 사용 시)
    logs:GetLogEventsCloudWatch 로그 수집(게시된 로그 기능 사용 시)

  • cloud_watch String

    CloudWatch 모니터링의 유무를 설정합니다. 설정 값은 on 또는 off입니다.

  • cloud_watch_instance String

    CloudWatch 인스턴스 명을 설정합니다.

  • cloud_watch_interval Second

    CloudWatch로 모니터링 값을 가져올 간격을 설정합니다. (단위: 초)

  • cloud_watch_metrics String

    CloudWatch로 가져올 모니터링 지표 이름을 설정합니다. 다음과 같이 설정할 수 있습니다.

    cloud_watch_metrics=CPUUtilization,FreeableMemory,FreeStorageSpace,NetworkTransmitThroughput,NetworkReceiveThroughput

RDS CloudWatch 수집을 위한 설정 예시​

다음과 같은 기본 설정을 작성해야 RDS CloudWatch를 모니터링하고 데이터를 수집합니다.

whatap.conf
cloud_watch=on
aws_region=ap-northeast-2

# AWS IAM에서 역할(Role)을 생성하고 역할 ARN(Role ARN) 값을 복사, 붙여넣기하세요.
aws_arn=arn:aws:iam::999999999999:role/UpdateApp
cloud_watch_metrics=CPUUtilization,FreeableMemory,FreeStorageSpace,NetworkTransmitThroughput,NetworkReceiveThroughput

#인스턴스 이름 예시
cloud_watch_instance=pg-rds
노트

  • 역할 ARN(Role ARN)에 대한 자세한 내용은 다음 링크를 참조하세요.

  • IAM ROLE의 ARN 값을 이용하지 않고 EC2에 RDS CloudWatch Metric의 수집 권한을 부여해 데이터를 수집하는 방법은 다음 문서를 참조하세요.

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