- 인쇄
- PDF
Pinpoint Cloud 사용
- 인쇄
- PDF
Pinpoint Cloud 웹 콘솔을 사용하는 방법과 Pinpoint Agent를 사용하여 애플리케이션을 연동하는 방법을 설명합니다. Pinpoint Cloud 웹 콘솔에서는 애플리케이션의 성능을 모니터링할 수 있습니다. Pinpoint Cloud 웹 콘솔은 오픈 소스 버전의 Pinpoint와 동일한 UI로 구성되어 있기 때문에 기존 Pinpoint 사용자들도 쉽게 적응이 가능합니다.
Agent 설치 및 관리
Pinpoint Cloud를 사용하려면 모니터링 대상 애플리케이션에 Pinpoint Agent를 설치해야 합니다.
Pinpoint Agent는 모니터링할 애플리케이션(<예시> Tomcat)에 연결된 Java Agent로 실행됩니다. Pinpoint Agent를 모니터링 대상 애플리케이션에 연결하려면 애플리케이션 실행 시 -javaagent
JVM argument에 $AGENT_PATH/pinpoint-bootstrap-$VERSION.jar
를 전달해야 합니다.
Agent 설치
Pinpoint Agent를 설치하려면 환경 변수를 설정하고 링크를 PC로 다운로드해야 합니다. 설치하는 방법은 다음과 같습니다.
- 네이버 클라우드 플랫폼 콘솔에서 Services > Management & Governance > Pinpoint Cloud 메뉴를 차례대로 클릭해 주십시오.
- 목록에서 원하는 리포지토리의 [바로가기] 버튼을 클릭해 주십시오.
- 웹 콘솔에 로그인한 후 오른쪽 상단의 을 클릭하고 Installation 메뉴를 클릭해 주십시오.
- Agent의 환경 변수를 입력해 주십시오.
- Application Name: 애플리케이션 그룹을 구분하기 위한 ID 입력 후 [Check] 버튼 클릭
- Agent ID: 애플리케이션을 구분하기 위한 고유 ID 입력 후 [Check] 버튼 클릭
- 입력된 정보로 JVM argument가 구성되면 을 클릭해 코드를 복사해 주십시오.
- 추후 애플리케이션의 실행 옵션에 해당 코드를 추가해야 합니다.
- Download Link에 있는 링크를 클릭해 압축 파일을 다운로드해 주십시오.
- 다운로드된 Agent 파일의 압축을 푼 후, 모니터링 대상 애플리케이션의 실행 옵션 설정 및 라이선스 키 설정을 완료해 주십시오.
- 모니터링 대상 애플리케이션의 실행 옵션 설정: <예시> Tomcat의 경우, Tomcat 시작 스크립트인
$CATALINA_HOME/bin/catalina.sh
파일을 다음과 같이 수정하고 저장해 주십시오.
CATALINA_OPTS="$CATALINA_OPTS -javaagent:$AGENT_PATH/pinpoint-bootstrap-$VERSION.jar" CATALINA_OPTS="$CATALINA_OPTS -Dpinpoint.agentId=$AGENT_ID" CATALINA_OPTS="$CATALINA_OPTS -Dpinpoint.applicationName=$APPLICATION_NAME"
- 라이선스 키 설정: Agent License Key 영역에 마우스 오버하면 나타나는 을 클릭해 라이선스 키를 복사하고,
$AGENT_PATH/pinpoint.license
파일에 값을 붙여 넣어 저장해 주십시오.
- 모니터링 대상 애플리케이션의 실행 옵션 설정: <예시> Tomcat의 경우, Tomcat 시작 스크립트인
- 애플리케이션을 실행해 주십시오.
- 설치된 Pinpoint Agent를 통해 성능 정보가 수집됩니다.
Pinpoint 로그 레벨 조정
Pinpoint 각 컴포넌트의 로그 레벨을 조정하려면 log4j2.xml
파일을 다음과 같이 수정해 주십시오.
(...중략)
<logger name="com.navercorp.pinpoint" additivity="false">
<level value="WARN"/>
<appender-ref ref="console"/>
</logger>
<logger name="com.navercorp.pinpoint.web.filter" additivity="false">
<level value="WARN"/>
<appender-ref ref="console"/>
</logger>
<logger name="com.navercorp.pinpoint.web.controller" additivity="false">
<level value="WARN"/>
<appender-ref ref="console"/>
</logger>
<logger name="com.navercorp.pinpoint.web.applicationmap" additivity="false">
<level value="WARN"/>
<appender-ref ref="console"/>
</logger>
<logger name="com.navercorp.pinpoint.web.calltree.server" additivity="false">
<level value="WARN"/>
<appender-ref ref="console"/>
</logger>
<logger name="com.navercorp.pinpoint.web.mapper" additivity="false">
<level value="WARN"/>
<appender-ref ref="console"/>
</logger>
<logger name="com.navercorp.pinpoint.web.service" additivity="false">
<level value="WARN"/>
<appender-ref ref="console"/>
</logger>
(...중략)
주요 기능
Pinpoint Cloud 웹 콘솔의 주요 기능을 간략하게 안내합니다.
Pinpoint Cloud 웹 콘솔은 오픈 소스 버전의 Pinpoint와 동일한 UI로 구성되었으므로 사용 방법에 대한 자세한 안내는 Pinpoint 공식 웹사이트를 참고해 주십시오.
Server Map
분산 시스템의 구성을 한눈에 확인할 수 있고, 각 노드를 클릭해 구성 요소의 현재 상태 및 트랜잭션 수 등을 확인할 수 있습니다.
영역 | 설명 |
---|---|
① 서버 토폴로지 | 애플리케이션 서버의 아키텍처 |
② Active Request | 모니터링 중인 애플리케이션 내부의 활성 스레드 수를 실시간으로 표시 |
③ 차트 | 선택된 노드의 상세 정보를 분산형 차트와 막대 차트로 표시 |
Call Stack
시스템 트랜잭션을 코드 수준으로 확인해 병목 지점 또는 장애 발생 지점을 빠르게 식별하고 애플리케이션의 오류 및 예외 정보를 바로 확인할 수 있습니다.
Server Map의 분산형 차트에 기록된 트랜잭션을 선택하면 다음과 같이 Call Stack 화면이 표시됩니다.
영역 | 설명 |
---|---|
① 트랜잭션 목록 | 선택된 트랜잭션 목록 |
② Call Tree | 트랜잭션을 수행하며 실행된 메소드 목록 |
Application Inspector
애플리케이션의 리소스 데이터(stat: CPU, 메모리, TPS, Datasource Connection Count)를 확인할 수 있습니다.
- 차트에서 특정 영역을 드래그하면 선택된 영역만 확대하여 확인할 수 있습니다.
- 확대된 상태에서 [Reset Zoom] 버튼을 클릭하면 확대를 해제할 수 있습니다.
설정 메뉴
Pinpoint Cloud 웹 콘솔에서 을 클릭하여 설정 메뉴를 이용할 수 있습니다. 이용 가능한 설정 메뉴는 다음과 같습니다.
이 가이드는 관리자 계정을 기준으로 표시되는 메뉴를 안내합니다. 실제 접속 시 계정에 따라 일부 메뉴가 표시되지 않을 수 있습니다.
메뉴 | 설명 |
---|---|
Administration | 리포지토리별 웹 콘솔 사용자 및 Agent 데이터 관리 |
Setting | 리포지토리별 웹 콘솔 사용 설정 |
User Group | 사용자 그룹 추가 및 관리(사용자 그룹 관리 참고) |
Authentication & Alarm | 사용자 그룹별 애플리케이션 사용 권한 및 알림 설정(애플리케이션 사용 권한 및 알림 설정 참고) |
Installation | Agent 설치 환경 변수 설정 및 다운로드(Agent 설치 참고) |
사용자 관리
생성된 리포지토리 웹 콘솔의 사용자를 관리할 수 있습니다.
사용자 추가
새로운 사용자를 추가하는 방법은 다음과 같습니다.
- Pinpoint Cloud 웹 콘솔에서 > Users 메뉴를 차례대로 클릭해 주십시오.
- 사용자 목록 상단의 을 클릭해 주십시오.
- 사용자 정보를 입력한 후 [저장] 버튼을 클릭해 주십시오.
- 사용자 역할은 Role 메뉴에서 설정할 수 있습니다. 새로운 역할을 생성하려면 역할 생성을 참고해 주십시오.
등록된 사용자 정보를 수정하려면 목록에서 사용자를 클릭한 후 입력란에 정보를 새로 입력하고 [저장] 버튼을 클릭해 주십시오.
사용자 삭제
사용자를 삭제하는 방법은 다음과 같습니다.
- Pinpoint Cloud 웹 콘솔에서 > Users 메뉴를 차례대로 클릭해 주십시오.
- 사용자 목록에서 삭제하려는 사용자의 을 클릭해 주십시오.
- [삭제] 버튼을 클릭해 주십시오.
역할 관리
리포지토리 웹 콘솔 사용자의 역할 및 사용 권한을 관리할 수 있습니다.
역할 생성
새로운 역할을 생성하는 방법은 다음과 같습니다.
- Pinpoint Cloud 웹 콘솔에서 > Role 메뉴를 차례대로 클릭해 주십시오.
- 역할 목록 상단의 을 클릭해 주십시오.
- 역할의 이름을 입력하고 부여할 사용 권한을 선택한 후 [저장] 버튼을 클릭해 주십시오.
등록된 역할 정보를 수정하려면 목록에서 역할을 클릭한 후 사용 권한을 선택하고 [저장] 버튼을 클릭해 주십시오.
역할 삭제
역할을 삭제하는 방법은 다음과 같습니다.
역할을 삭제하면 해당 역할로 지정된 사용자들의 사용 권한이 함께 삭제됩니다.
- Pinpoint Cloud 웹 콘솔에서 > Role 메뉴를 차례대로 클릭해 주십시오.
- 역할 목록에서 삭제하려는 역할의 을 클릭해 주십시오.
- [삭제] 버튼을 클릭해 주십시오.
사용자 그룹 관리
등록된 사용자를 그룹으로 묶어 사용할 수 있는 애플리케이션을 지정하고 알람 대상자로 일괄 설정할 수 있습니다.
사용자 그룹 조회
사용자 그룹의 목록과 그룹별로 설정된 상세 정보를 조회할 수 있습니다. 사용자 그룹을 조회하는 방법은 다음과 같습니다.
- Pinpoint Cloud 웹 콘솔에서 > User Group 메뉴를 차례대로 클릭해 주십시오.
- User Group 화면에서 그룹 정보를 확인해 주십시오.
- User Group: 생성된 사용자 그룹 목록
- 목록 내 항목을 클릭하면 해당 그룹에 속한 멤버 목록이 Group Member에 표시됩니다.
- 을 클릭해 새 사용자 그룹을 생성할 수 있습니다.
- 을 클릭해 사용자 그룹을 삭제할 수 있습니다.
- Group Member: 선택된 그룹에 속한 멤버 목록
- > 을 클릭해 멤버를 그룹에서 삭제할 수 있습니다.
- Pinpoint User: Pinpoint Cloud 웹 콘솔에 등록된 모든 사용자 목록
- 그룹이 선택된 상태에서 사용자 이름 앞에 있는 체크 박스를 클릭하여 선택하면 해당 사용자가 그룹 멤버로 추가됩니다.
- 사용자 이름을 클릭하면 프로필 상세 정보를 확인할 수 있습니다.
- Application Authentication & Alarm: 선택된 그룹에 지정된 애플리케이션 목록
- Detail 항목의 을 클릭해 애플리케이션 사용 권한을 확인할 수 있습니다.
- More 항목의 을 클릭해 Authentication & Alarm 메뉴로 이동할 수 있습니다.
- User Group: 생성된 사용자 그룹 목록
사용자 그룹 생성
새로운 사용자 그룹을 생성하고 멤버를 추가하는 방법은 다음과 같습니다.
- Pinpoint Cloud 웹 콘솔에서 > User Group 메뉴를 차례대로 클릭해 주십시오.
- User Group 목록 상단의 을 클릭해 주십시오.
- 사용자 그룹의 이름을 입력한 후 [OK] 버튼을 클릭해 주십시오.
- 생성된 사용자 그룹을 클릭한 후 Pinpoint User 목록에서 멤버로 추가하려는 사용자의 체크 박스를 클릭하여 선택해 주십시오.
- 선택된 사용자가 Group Member 목록에 추가됩니다.
애플리케이션 사용 권한 및 알림 설정
Pinpoint Cloud 웹 콘솔에 등록된 애플리케이션의 사용 권한을 사용자 그룹에게 부여하고 이벤트 발생 시 보낼 알림을 설정할 수 있습니다.
사용 권한 설정
애플리케이션의 사용 권한을 설정해 사용자 그룹에게 부여하는 방법은 다음과 같습니다.
- Pinpoint Cloud 웹 콘솔에서 > Authentication & Alarm 메뉴를 차례대로 클릭해 주십시오.
- Application 목록에서 사용 권한을 부여할 애플리케이션을 클릭해 주십시오.
- Authentication 목록 상단의 을 클릭해 주십시오.
- 사용 권한을 부여할 사용자 그룹 ID와 포지션을 선택한 후 데이터 노출 여부를 설정하고 [OK] 버튼을 클릭해 주십시오.
- 권한 설정 내용이 목록에 추가됩니다.
- 을 클릭해 사용자 그룹에게 설정된 데이터 노출 여부를 확인할 수 있습니다.
- 을 클릭해 포지션 및 데이터 노출 여부를 변경할 수 있습니다.
- > 을 클릭해 권한 설정 내용을 삭제할 수 있습니다.
- 권한 설정 내용이 목록에 추가됩니다.
알람 설정
지표의 기준을 초과하면 SMS/이메일로 알람을 보내도록 설정할 수 있습니다. 알람 설정이 가능한 지표 항목은 다음과 같습니다.
항목 | 설명 |
---|---|
SLOW COUNT | 외부에서 애플리케이션을 호출한 요청 중에 외부 서버로 응답을 늦게 준 요청의 개수가 기준점을 초과한 경우 알람 전송 |
SLOW RATE | 외부에서 애플리케이션을 호출한 요청 중에 외부 서버로 응답을 늦게 준 요청의 비율(%)이 기준점을 초과한 경우 알람 전송 |
ERROR COUNT | 외부에서 애플리케이션을 호출한 요청 중에 오류가 발생한 요청의 개수가 기준점을 초과한 경우 알람 전송 |
ERROR RATE | 외부에서 애플리케이션을 호출한 요청 중에 오류가 발생한 요청의 비율(%)이 기준점을 초과한 경우 알람 전송 |
TOTAL COUNT | 외부에서 애플리케이션을 호출한 요청 개수가 기준점을 초과한 경우 알람 전송 |
SLOW COUNT TO CALLEE | 애플리케이션 내에서 외부 서버를 호출한 요청 중 응답을 늦게 준 호출의 개수가 기준점을 초과한 경우 알람 전송. 메모 항목에 외부 서버의 도메인이나 주소(IP, 포트) 입력 필요 <예시> naver.com, 127.0.0.1:8080 |
SLOW RATE TO CALLEE | 애플리케이션 내에서 외부 서버를 호출한 요청 중 응답을 늦게 준 호출의 비율(%)이 기준점을 초과한 경우 알람 전송. 메모 항목에 외부 서버의 도메인이나 주소(IP, 포트) 입력 필요 <예시> naver.com, 127.0.0.1:8080 |
ERROR COUNT TO CALLEE | 애플리케이션 내에서 외부 서버를 호출한 요청 중 오류가 발생한 호출의 개수가 기준점을 초과한 경우 알람 전송. 메모 항목에 외부 서버의 도메인이나 주소(IP, 포트) 입력 필요 <예시> naver.com, 127.0.0.1:8080 |
ERROR RATE TO CALLEE | 애플리케이션 내에서 외부 서버를 호출한 요청 중 오류가 발생한 호출의 비율(%)이 기준점을 초과한 경우 알람 전송. 메모 항목에 외부 서버의 도메인이나 주소(IP, 포트) 입력 필요 <예시> naver.com, 127.0.0.1:8080 |
TOTAL COUNT TO CALLEE | 애플리케이션 내에서 외부 서버를 호출한 요청의 개수가 기준점을 초과한 경우 알람 전송. 메모 항목에 외부 서버의 도메인이나 주소(IP, 포트) 입력 필요 <예시> naver.com, 127.0.0.1:8080 |
HEAP USAGE RATE | heap 사용률이 기준점을 초과한 경우 알람 전송 |
JVM CPU USAGE RATE | 애플리케이션의 CPU 사용률이 기준점을 초과한 경우 알람 전송 |
SYSTEM CPU USAGE RATE | 서버의 CPU 사용률이 기준점을 초과한 경우 알람 전송 |
DATASOURCE CONNECTION USAGE RATE | 애플리케이션 datasource 내의 connection 사용률이 기준점을 초과한 경우 알람 전송 |
DEADLOCK OCCURRENCE | 애플리케이션에서 교착 상태가 탐지되면 알람 전송 |
FILE DESCRIPTOR COUNT | 열려 있는 file descriptor 개수가 기준점을 초과한 경우 알람 전송 |
이벤트 발생 시 사용자 그룹에게 보낼 알림을 설정하는 방법은 다음과 같습니다.
- Pinpoint Cloud 웹 콘솔에서 > Authentication & Alarm 메뉴를 차례대로 클릭해 주십시오.
- Alarm 목록 상단의 을 클릭해 주십시오.
- 알람 항목 및 기준점을 설정한 후 알람을 받을 사용자 그룹 ID와 알람 형식을 선택하고 [OK] 버튼을 클릭해 주십시오.
- 알람 내용이 목록에 추가됩니다.
- 을 클릭해 알람 내용을 변경할 수 있습니다.
- > 을 클릭해 알람 내용을 삭제할 수 있습니다.
- 알람 내용이 목록에 추가됩니다.