본문으로 건너뛰기

에이전트 설정

와탭 에이전트는 에이전트 별 필요한 설정을 whatap.conf 파일에 작성합니다. 에이전트는 환경변수를 통해 설정 파일의 위치를 파악하고 로딩합니다.

별도 설정이 없는 경우 에이전트는 자기 자신(whatap.agent-X.Y.Z.jar)이 위치한 디렉터리에서 whatap.conf 파일을 찾도록 구현했습니다. 5초에 한번씩 whatap.conf 파일의 변경 여부를 체크하고 리로딩합니다.

사용자의 편의성을 위해 와탭 모니터링 서비스에서도 에이전트 설정 기능을 제공하고 있습니다.

기본 설정

whatap.conf
whatap.home=.
whatap.config=whatap.conf
  • whatap.home: 기본값은 whatap.agent.jar 파일의 경로를 입력하세요.

  • whatap.config: 파일명만 입력할 것을 권고합니다. 상대 패스를 같이 입력할 수는 있습니다.

에이전트가 데이터를 수집하고, 서버로 데이터를 전송하기 위해서는 최소한 액세스 키와 서버 주소는 설정돼 있어야 합니다.

whatap.conf
license=x220g160hgd29-x3qpff0garcus7-z4p0kao58un11a
whatap.server.host=10.10.0.1

와탭 에이전트는 최초 실행시 다음과 같이 어떤 jar 파일이 에이전트로 사용됐는지, 어떤 경로에서 whatap.conf 파일을 로딩하는지 확인할 수 있습니다.

Java start screen

서버 연결 및 데이터전송

와텝 에이전트는 whatap.conf 파일에 설정한 서버 주소로 연결합니다.

whatap.conf
whatap.server.host=10.10.1.1
whatap.server.port=6600 # 기본값
  • TCP 세션을 연결하면 license를 이용해 서버로부터 통신키를 전달 받습니다. 잘못된 license를 설정하면 서버는 세션을 종료합니다.
  • TCP 연결이 반복적으로 종료되면 방화벽 문제 확인하거나 license 값이 올바른지 확인하세요.
  • TCP 세션을 연결하면 서버로부터 받은 비밀키를 기반으로 보안 통신으로 데이터를 전송합니다.

여러 애플리케이션 서버의 설정 파일 관리

한 서버에 여러 애플리케이션을 운영할 경우, 각 애플리케이션 별 설정 파일을 별도로 관리하려면 whatap.conf 파일명을 변경하고 시작 스크립트에 JVM 옵션을 추가하세요.

Service A
-Dwhatap.config=whatap_Aservice.conf
Service B
-Dwhatap.config=whatap_Bservice.conf
주의

whatap.conf 설정 파일은 반드시 ${WHATAP_HOME} 경로에 위치해야 합니다.

서비스 화면에서 에이전트 설정하기

홈 화면 > 프로젝트 선택 > 관리 > 에이전트 설정

모니터링 대상 서버에 위치한 whatap.conf 파일을 직접 수정하지 않고 와탭 모니터링 서비스에서 에이전트 설정 옵션을 추가하거나 수정, 삭제할 수 있습니다. 또한 설정 파일 다운로드 버튼을 클릭해 whatap.conf 파일을 다운로드할 수 있습니다.

노트
  • 이 기능은 수정 권한을 가진 멤버만 이용할 수 있습니다. 수정 권한이 없는 멤버는 설정 내용을 조회만 할 수 있습니다.

  • 옵션 값으로 설정할 수 있는 형식은 다음과 같습니다.

    • Boolean 형식의 값은 true 또는 false를 선택하세요.
    • 숫자 형식의 값은 숫자만 입력할 수 있습니다.
    • 텍스트(String) 형식의 값을 입력 또는 수정할 경우 옵션 셜명을 자세히 확인하세요.
  • 수정할 수 없는 옵션은 선택할 수 없습니다. (예, license)

  • 추가 또는 수정, 삭제한 옵션에 따라 에이전트를 재시작해야할 수 있습니다.

  • 애플리케이션 종류 및 에이전트의 버전에 따라 적용할 수 있는 옵션 키는 다를 수 있습니다.

옵션 추가하기

에이전트 설정

  1. 에이전트 목록에서 옵션을 추가하려는 숫자 1 에이전트를 선택하세요.

  2. 숫자 2 옵션 작성에서 추가할 옵션 항목을 선택하세요.

    • 검색에서 추가할 옵션을 찾을 수 있습니다. 텍스트를 입력하면 일치하는 옵션을 필터링합니다.
    • 직접 입력을 선택하면 옵션 키와 값을 입력할 수 있습니다.
  3. 선택한 옵션 키에 대한 설명과 기본값을 확인한 다음 설정값을 입력하세요.

    • 선택한 옵션을 취소하려면 삭제 아이콘 버튼을 선택하세요.
    • 옵션을 추가 설정하려면 추가하기 버튼을 선택하고 2번의 과정을 반복하세요.
  4. 원하는 모든 옵션을 추가했으면 화면 오른쪽 위에 적용 버튼을 선택하세요.

선택한 옵션 및 설정값을 에이전트에 적용합니다.

노트
  • 수정 중인 내용을 초기화하려면 화면 오른쪽 위에 초기화 아이콘 버튼을 선택하세요.
  • 옵션값으로 아무것도 입력하지 않은 상태에서 적용 버튼을 선택하면 해당 옵션을 삭제합니다.
  • 이미 추가한 옵션은 옵션 목록에서 선택할 수 없습니다.
  • 애플리케이션 종류 및 에이전트의 버전에 따라 적용할 수 있는 옵션 키는 다를 수 있습니다.
  • 예시로 제공한 이미지는 애플리케이션 종류 및 에이전트에 따라 다를 수 있습니다.

옵션 수정 또는 삭제하기

옵션 수정

  1. 화면을 위 또는 아래로 스크롤하거나 왼쪽의 옵션 목록에서 수정 또는 삭제하려는 옵션을 선택하세요.

  2. 변경하려는 옵션에서 원하는 값을 선택하거나 수정하세요. 옵션을 삭제하려면 삭제 아이콘 버튼을 선택하세요.

  3. 변경한 사항을 적용하려면 적용 버튼을 선택하세요.

노트
  • 화면 가장 위로 이동하려면 숫자 3 옵션 추가로 이동 버튼을 선택하세요.

  • 옵션값으로 아무것도 입력하지 않은 상태에서 적용 버튼을 선택하면 해당 옵션을 삭제합니다.

여러 에이전트에 동시 적용하기

프로젝트에 소속된 여러 개의 에이전트에 변경한 옵션을 동시에 적용할 수 있습니다.

  1. 화면 오른쪽 위에 다중 에이전트 적용 체크박스를 선택하면 각 옵션 항목에 체크박스가 생성됩니다.

  2. 동시에 적용하길 원하는 옵션의 체크박스를 선택하세요. 여러 개를 선택할 수 있습니다.

  3. 화면 오른쪽 위에 적용 버튼을 선택하세요.

  4. 에이전트 적용 창이 나타나면 변경한 옵션을 적용할 에이전트를 선택하세요. 모두 선택하려면 전체 선택 체크박스를 선택하세요.

  5. 적용 버튼을 선택하세요.

에이전트 기본값 설정하기

프로젝트에 새로운 에이전트를 추가할 경우 기존의 설정값을 반복해서 적용하는 번거로움을 피하고 싶다면 프로젝트별, 업무별 기본 설정값을 만들어 적용할 수 있습니다.

  • 업무 디폴트: whatap.conf 파일에서 whatap.okind 항목으로 분류한 에이전트들에 옵션을 공통 적용할 수 있고, 적용된 옵션을 확인할 수 있습니다.

  • 프로젝트 디폴트: 프로젝트에 소속된 모든 에이전트들에 옵션을 공통 적용할 수 있고, 적용된 옵션을 확인할 수 있습니다.

노트
  • 업무 디폴트 또는 프로젝트 디폴트 탭을 선택한 다음 옵션을 적용하는 것은 에이전트를 공통으로 관리하는 데 유용합니다.

  • 옵션의 적용 우선 순위는 업무 디폴트, 프로젝트 디폴트, 에이전트 설정 순입니다.

    • 프로젝트 디폴트에서 b 옵션값을 1000을 적용하고, 업무 디폴트에서 b 옵션값을 2000으로 적용하면, 업무 디폴트에서 설정한 옵션값 2000을 우선 적용합니다.
    • 프로젝트 디폴트에서 b 옵션값을 아무것도 입력하지 않았고 업무 디폴트에 b 옵션값에 2000이 적용된 경우에도 업무 디폴트에서 설정한 옵션값을 우선 적용합니다.

에이전트 설정 공유하기

에이전트 설정 내용을 json 형식의 파일로 저장하고 파일을 불러와 다른 에이전트에 적용할 수 있습니다.

  1. 에이전트 목록에서 설정 내용을 json 파일로 내보낼 에이전트를 선택하세요.

  2. 화면 오른쪽 위에 내보내기 아이콘 버튼을 선택하세요.

  3. json 파일을 다운로드하세요.

  4. 에이전트 목록에서 다른 에이전트를 선택하세요.

  5. 화면 오른쪽 위에 가져오기 아이콘 버튼을 선택하세요.

json 파일을 통해 가져온 에이전트 설정을 확인하세요.

에이전트 설정 옵션 안내

다음 링크를 통해 설정할 수 있는 옵션들에 대한 설명을 제공합니다.

HTTPC, API Call

HTTP 외부 호출과 API 호출 관련 데이터를 수집, 분석을 위한 자바(Java) 에이전트의 옵션 설정 방법을 안내합니다. SLOW_HTTPC 에러 처리 및 CPU와 메모리 사용량 추적, 호출 시점의 스택 트레이스 기록, URL 정규화 등 세밀한 모니터링을 위한 다양한 옵션을 제공합니다. 이를 통해 개발자는 애플리케이션의 외부 의존성을 효율적으로 관리하고 성능 문제를 식별할 수 있습니다.

스크립트 플러그인

자바(Java) 에이전트에서 제공하는 플러그인 옵션을 통해 사용자가 원하는 코드를 트레이스 데이터에 주입하거나 메소드 수행 전후로 부가 정보를 추가하는 방법을 제공합니다. 메소드 시작/종료 시점에 특정 코드를 실행할 위치를 설정하는 옵션과 사용자 정의 pool을 모니터링하기 위한 클래스 설정 방법을 포함합니다. 실제 플러그인 적용 사례를 통해 구체적인 활용 방안을 제시하며, 모니터링의 유연성과 세밀함을 높일 수 있는 다양한 설정 예시와 API 사용법을 안내합니다.

부하량 제어

자바(Java) 애플리케이션 서버의 트래픽 쓰로틀링 옵션을 설정하는 에이전트 옵션을 안내합니다. 애플리케이션의 최대 동시 요청 수를 제한하고, 특정 사용자나 URL을 기준으로 서비스 접근을 제어하는 기능을 포함합니다. 사용자 정의 메시지 전송, URL 리다이렉션 설정, 이벤트 알림 활성화 등 다양한 옵션을 제공하여 과부하 상황에서 애플리케이션의 안정성을 보장할 수 있습니다.

에이전트 알림

자바(Java) 에이전트를 통해 애플리케이션 서버에서 발생하는 다양한 이벤트에 대한 알림 설정 방법을 제공합니다. 트랜잭션 재귀 호출, 서비스 거절, HTTPC 연결 오류, 힙 및 디스크 사용량 초과, CPU 사용량 임계치 도달, DB 커넥션 중복 할당 및 예외 발생 시 이벤트 알림을 설정하는 옵션을 포함합니다. 각 이벤트별로 발행 간격, 발행 여부, 임계치 설정 등 세밀한 조정을 할 수 있습니다.

트랜잭션 에러 스택

자바(Java) 애플리케이션에서 트랜잭션 중 발생하는 에러를 감지하고 이에 대한 스택 트레이스를 표시하는 에이전트 설정 옵션을 안내합니다. 트랜잭션, 메소드, SQL, HTTP 호출, SOCKET 호출 등 다양한 영역에서 에러 정보를 수집하고, 에러 스택의 길이, 제목 길이 등을 설정하는 방법을 포함합니다. 에이전트 설정을 통해 에러 관리를 개선하고, 애플리케이션의 오류 진단을 보다 효율적으로 수행할 수 있도록 지원합니다.

부가 기능

자바(Java) 애플리케이션의 모니터링 수준을 사용자의 필요에 맞게 조정할 수 있는 추가적인 에이전트 설정 옵션을 안내합니다. SQL 파라미터 수집, HTTP 파라미터 및 헤더 정보 수집, 사용자 IP 정보 추출, 사용자 수 추적 방법 선택, SAP Function 추적 등을 포함합니다. 이 옵션들을 통해 보다 세밀한 데이터 수집 및 분석이 가능하며, 특히 보안이 중요한 환경에서 필요에 따라 옵션을 조정할 수 있습니다.