Pinpoint 서버 생성 가이드

Classic/VPC 환경에서 이용 가능합니다.

사용하기 전에

Q. Pinpoint는 무엇인가요?

• Java 분산 서비스 및 시스템의 지속적인 성능 분석을 제공하며, 오류 발생 가능성에 대한 진단과 추적을 지원하는 플랫폼 서비스입니다.
• 'N' 계층의 SOA(Service Oriented Architecture) 및 Micro-Service로 구성된 아키텍처 서비스의 추적/분석 기능을 제공합니다.
• 분산 애플리케이션의 트랜잭션 분석, Topology Detection, Bytecode Instrumentation을 활용한 진단 기능을 제공합니다.
• 'Pinpoint'는 '네이버 주식회사'에서 개발하여 공개한 오픈소스인 Pinpoint를 이용하고 있습니다.

Q. Pinpoint를 사용하면 어떤 이점이 있나요?

• 서비스 코드 수정 없이 Java Application의 성능을 진단하고, 오류를 추적할 수 있습니다.
• 다양한 Java Agent Plug-in 기능을 지원하고, 지속적으로 확장 가능한 기능을 제공합니다.
• 복잡한 서비스의 분산 환경을 하나의 트랜잭션으로 추적하여 Root Cause 분석에 중요한 데이터를 제공합니다.

Q. Pinpoint 서버는 어떻게 생성하나요?

• 콘솔 > Compute > Server 메뉴에서 Pinpoint 서버 이미지를 선택하여 생성할 수 있습니다.
• 원하는 사양의 서버를 생성하고 필요에 따라 스토리지를 추가합니다.
• 월 요금제와 시간 요금제로 청구되며, 서버를 생성한 후 접속 환경을 설정하여 이용할 수 있습니다.
• Pinpoint 웹 서비스를 이용하기 위해서 공인 IP 주소를 신청하고 ACG 설정에서 10090 포트를 추가해야 합니다.
• 콘솔에 접속한 후 다음의 단계를 통해 쉽게 서버를 생성할 수 있습니다.

Q. Pinpoint Web에 접속할 수 없습니다.

• Pinpoint 웹 서비스를 사용하기 위해서는 공인 IP 주소를 신청하여 서버에 할당해야 하며, ACG에 10090 포트가 추가되어 있어야 합니다. (접속 환경 설정 참조)
• 공인 IP 주소와 ACG를 확인한 후에도 접속되지 않는 경우 Pinpoint 프로세스가 정지된 상태일 수 있으니, 터미널에서 재시작 명령어를 실행하여 프로세스를 다시 시작해 주십시오. (Pinpoint 프로세스 관리 참조)

Q. Pinpoint는 어느 디렉터리에 설치되나요?

• /root/pinpoint 디렉터리에 설치됩니다.
• Pinpoint 설치 경로에는 pinpoint-collector, pinpoint-web, hbase-1.2.6.1 등이 함께 설치됩니다.
• 데이터 유실을 방지하기 위해 설치 경로를 백업해 두는 것을 권장합니다.

Q. Pinpoint Admin 패스워드를 초기화하려면 어떻게 해야 하나요?

• Pinpoint Admin 패스워드를 초기화하는 방법은 다음과 같습니다.
  1. 서버 접속
  2. [Pinpoint Web 설치 경로]/webapps/pinpoint-web-1.7.3/WEB-INF/web.xml 수정
     • Pinpoint Web 초기 설치 경로: /root/pinpoint/pinpoint-web
  3. LoginCheck filter 항목의 <init-param> 중 username, password 값 수정
     • <param-name>username</param-name>, <param-name>password</param-name>
  4. Pinpoint Web 서비스 재시작
     • $ /root/pinpoint/pinpoint-web/bin/shutdown.sh
     • $ /root/pinpoint/pinpoint-web/bin/startup.sh

Q. Pinpoint 웹 서비스를 위해 주의할 사항이 있나요?

• Pinpoint Web 서비스는 기본적으로 HTTP 프로토콜 기반으로 설정되어 있습니다.
• Pinpoint Web 서비스를 보다 안정적이고 보안이 강화된 방법으로 사용을 원하실 경우 HTTPS 프로토콜로 사용하시기 바랍니다.
• SSL 인증서 및 Web Service Domain 생성 후 사용하시면 됩니다.

Pinpoint 소개

Pinpoint는 분산 서비스 및 시스템의 성능 분석/진단/추적 플랫폼 서비스로서 'N' 계층의 SOA(Service Oriented Architecture) 및 Micro-Service로 구성된 아키텍처 서비스의 추적 및 분석 기능을 제공하고, 분산 애플리케이션의 트랜잭션 분석, Topology Detection, Bytecode Instrumentation을 활용한 진단 기능을 제공합니다.

Pinpoint 서버 생성

Pinpoint 서버 생성 과정은 아래와 같습니다.

Step 1. 콘솔 접속

콘솔에 접속해서 Compute > Server 메뉴를 선택합니다.

1. 서버를 생성하려면 [서버 생성] 버튼을 클릭해 주십시오.

Step 2. 서버 이미지 선택

Pinpoint 서버 이미지를 선택해서 서버를 생성합니다.

1. Pinpoint 이미지를 선택해 주십시오.

2. 팝업 창의 안내(Pinpoint 사용을 위한 공인 IP 주소, ACG 신청, 초기 비밀번호 확인)를 확인해 주십시오.

3. [확인] 버튼을 클릭하면 팝업창이 닫히면서 서버 정보 입력 화면으로 이동해 주십시오.

Step 3. 서버 설정

스토리지 종류, 서버 타입, 요금제, Zone을 선택하고, 서버 이름을 입력합니다.

1. Zone을 선택해 주십시오.

• Pinpoint 서비스는 모든 Region에서 지원되고 있습니다.

2. 부팅 스토리지로 사용할 스토리지 종류를 선택해 주십시오.

3. 원하는 서버 타입을 선택해 주십시오.

• 일부 서버 스펙은 부팅 디스크 타입에 따라 지원되지 않을 수 있습니다.
• 사용 용량에 따라 서버 타입 중 하나를 선택해 주십시오.

4. 요금제는 월요금제 또는 시간 요금제 중 선택해 주십시오.

5. 서버 이름을 입력해 주십시오.

• 고객이 서버를 구별하기 위한 명칭으로, 중복해서 사용할 수 없습니다.

6. [다음] 버튼을 클릭해 주십시오.

Step 4. 인증키 설정

보유하고 있는 인증키가 있는 경우 보유하고 있는 인증키 이용을 선택하고, 없는 경우 아래의 절차대로 새로운 인증키를 생성합니다.

1. 새로운 인증키 생성을 선택해 주십시오.

2. 인증키 이름을 입력해 주십시오.

3. [인증키 생성 및 저장] 버튼을 클릭하여 로컬 PC에 인증키 파일을 저장해 주십시오.

• 새로운 인증키를 발급받습니다.
• 저장 후 인증키는 고객의 PC 안전한 위치에 보관해 주십시오.
• 인증키는 최초의 관리자 비밀번호를 가져올 때 이용됩니다.

4. [다음] 버튼을 클릭합니다.

Step 5. ACG 설정

보유하고 있는 ACG를 이용하거나 신규 ACG를 생성하여 방화벽을 설정할 수 있습니다.

보유하고 있는 ACG 이용

보유하고 있는 ACG를 이용하여 방화벽을 설정하는 방법은 다음과 같습니다.

1. ACG는 필수로 선택해야 하며, 기본으로 제공하는 ‘ncloud-default-acg’를 포함하여 보유하고 있는 ACG 중에서 하나를 선택해 주십시오.

• 보유하고 있는 ACG는 최대 5개까지 선택할 수 있습니다.
• 필수로 ACG를 선택해야 [다음] 버튼이 활성화되어 설정을 진행할 수 있습니다.

2. 보유하고 있는 ACG 외에 신규 ACG를 생성하여 설정하고 싶다면, 신규 ACG 생성을 선택해 주십시오.

3. [다음] 버튼을 클릭해 주십시오.

새로 ACG 생성

새로 ACG를 생성하여 방화벽을 설정하는 방법은 다음과 같습니다.

1. 신규 ACG 생성에서 [ACG 생성] 버튼을 클릭해 주십시오.

2. ACG 이름을 입력해 주십시오.

3. ACG 설정에서 프로토콜, 접근 소스, 허용 포트를 입력하고 생성해 주십시오.

• 프로토콜: TCP, UDP, ICMP에서 선택
• 접근 소스: IP 주소 또는 ACG명 입력
• 허용 포트: 단일 포트 또는 범위 지정
• 터미널 접속을 위해서는 접속하려는 서버의 ACG에 SSH 'TCP/22'에 대한 규칙이 설정되어 있어야 하고, Pinpoint 사용을 위해서는 아래와 같은 규칙이 추가로 설정되어 있어야 합니다. 규칙을 추가하려면 프로토콜, 접근 소스, 허용 포트를 기재하고 [추가] 버튼을 클릭해 주십시오.

• Pinpoint ACG 규칙 추가 예시
  

4. 위의 서비스 포트가 모두 추가된 경우 [생성] 버튼을 클릭해 주십시오.

Step 6. 최종 확인

설정한 내용을 최종 확인합니다.

1. 서버 이미지, 서버, 인증키, ACG가 정상적으로 설정되었는지 확인해 주십시오.

2. 최종 확인 후에는 [서버 생성] 버튼을 클릭해 주십시오.

• 서버가 생성되기까지는 수 분에서 수십 분이 소요됩니다.

서버 목록에서 확인

생성한 서버를 목록에서 확인합니다.

1. 생성한 서버가 목록에 표시됩니다.

2. 서버가 생성되고 Pinpoint 패키지가 설치 완료되어 서버 상태가 운영중이 될 때까지 대기해 주십시오.

접속 환경 설정

공인 IP 주소 사용 신청

Pinpoint를 사용하려면 반드시 공인 IP 주소를 이용해서 접속해야 하며, 공인 IP 주소 사용에 대한 요금이 별도로 부과됩니다.

1. 좌측 메뉴에서 PUBLIC IP 메뉴를 선택해 주십시오. 공인 IP 주소를 할당받으려면 [공인 IP 신청] 버튼을 클릭해 주십시오.

2. 적용 서버 선택에서 공인 IP 주소를 할당할 Pinpoint 서버를 선택해 주십시오.

3. [확인] 버튼을 클릭합니다. 적용 서버 이름을 확인하고 다시 [확인] 버튼을 클릭해 주십시오.

포트 포워딩 설정

터미널 프로그램(PuTTY 등)으로 서버에 접속하려면 포트 포워딩을 설정해야 합니다.

1. 좌측 메뉴에서 Server 메뉴를 선택해 주십시오. 서버에 접속하려면 [포트 포워딩 설정] 을 클릭해 주십시오.

2. 포트 포워딩 설정 화면에서 외부 포트 번호를 설정해 주십시오. 외부 포트 번호의 입력 범위는 1024~65,534로, 서버 접속을 위한 기능 외에 서비스 용도로 사용할 수 없습니다. (내부 포트 번호는 22로 정해져 있습니다.)

3. [추가] 버튼을 클릭하면 설정 내역이 하단에 추가되며 [수정], [삭제] 버튼을 클릭하여 설정 내역을 수정, 삭제할 수 있습니다.

4. [적용] 버튼을 클릭하면 설정한 외부 포트로 터미널 프로그램을 이용하여 SSH 접속을 할 수 있습니다.

ACG 설정

ACG에 터미널 접속 SSH('TCP/22') 및 Pinpoint 서비스('TCP/UDP' 설정) 규칙을 추가합니다.

서버 생성 시 규칙을 이미 추가한 경우는 이 단계의 ACG 설정 작업을 수행할 필요가 없습니다.

1. 왼쪽의 메뉴에서 ACG 메뉴를 선택해 주십시오.

2. 서버 생성 시 선택한 ACG를 선택하고 상단의 [ACG 생성] 버튼을 클릭해 주십시오.

3. ACG 이름을 입력해 주십시오.

4. 설정이 완료되면 [생성] 버튼을 클릭해 주십시오.

• Pinpoint ACG 규칙이 아래와 같이 추가되어 있다면, 추가 작업이 필요 없습니다.
  

1. 생성한 ACG를 선택해 주십시오.

2. 상단 [ACG 설정] 버튼을 클릭해 주십시오.

3. ACG 규칙 설정에서 프로토콜, 접근 소스, 허용 포트를 입력하고 생성해 주십시오.

• 프로토콜: TCP, UDP, ICMP에서 선택

• 접근 소스: IP 주소 또는 ACG명 입력

• 허용 포트: 단일 포트 또는 범위 지정

• 터미널 접속을 위해서는 접속하려는 서버의 ACG에 SSH 'TCP/22'에 대한 규칙이 설정되어 있어야 합니다.

• 규칙을 추가하려면 프로토콜, 접근 소스, 허용 포트를 기재하고 [추가] 를 클릭해 주십시오.

4. 설정이 완료되면 [적용] 버튼을 클릭해 주십시오.

서버 관리자 비밀번호 확인

터미널 프로그램(PuTTY 등)으로 서버에 접속하려면 관리자 비밀번호를 알아야 합니다.

1. 좌측 메뉴에서 Server 메뉴를 선택해 주십시오.

2. 해당 서버를 선택하고, 서버 관리 및 설정 변경에서 관리자 비밀번호 확인을 선택해 주십시오.

3. [Drop files here or click to upload] 버튼을 클릭해 서버 생성 시 개인 PC에 저장한 인증키 파일(.pem)을 첨부해 주십시오.

4. 첨부 후 [비밀번호 확인] 버튼을 클릭하면 터미널 프로그램으로 최초 서버 접속 시 사용할 비밀번호를 얻을 수 있습니다.

• 서버에 접속 후 관리자가 기억할 수 있는 비밀번호로 변경하여 사용하는 것을 권장합니다.

터미널 접속

터미널 프로그램(PuTTY 등)으로 서버에 접속해서 Pinpoint 프로세스를 관리할 수 있습니다.

터미널 프로그램으로 서버 접속

1. 터미널 프로그램(PuTTY 등)을 실행해 주십시오.

2. 서버 리스트 또는 내용 보기에서 확인한 서버 접속용 공인 IP와 외부 포트 값을 입력하고 [Open] 버튼을 클릭하면 서버에 접속됩니다.

• 서버 접속용 공인 IP 확인: 콘솔의 Server > Server 메뉴에서 서버 선택 후 상세정보에서 포트 포워딩 정보의 서버 접속용 공인 IP 값 확인
• 외부 포트 번호 확인: 콘솔의 Server > Server 메뉴에서 서버 선택 후 상세정보에서 포트 포워딩 정보의 외부 포트 값 확인

3. 사용자 정보 및 암호를 입력하고 로그인해 주십시오.

• login as: root
• password: 위에서 확인한 관리자 비밀번호

4. 로그인 후에는 root 계정의 비밀번호를 기억할 수 있는 비밀번호로 변경할 것을 권장합니다.
   passwd root 명령어를 입력한 후 새 비밀번호를 입력해 주십시오.

Pinpoint Server 빠르게 시작하기/중지하기

Pinpoint 서버 생성 시 제공되는 pinpoint-init.sh 파일 실행으로 Pinpoint Components를 쉽게 시작할 수 있습니다.

• pinpoint-init.sh 파일 위치 확인

  shell> PINPOINT_HOME=/root/pinpoint
  shell> ls -al $PINPOINT_HOME
  

  

• 빠르게 시작하기: pinpoint-init.sh 실행 및 확인

  shell> PINPOINT_HOME=/root/pinpoint
  shell> $PINPOINT_HOME/pinpoint-init.sh
  

  

• 빠르게 중지하기: pinpoint-stop.sh 실행 및 확인

  shell> PINPOINT_HOME=/root/pinpoint
  shell> $PINPOINT_HOME/pinpoint-stop.sh
  

  

• Pinpoint 재시작하기: pinpoint-restart.sh 실행 및 확인
  Pinpoint Component를 정지 후 시작합니다.

  shell> PINPOINT_HOME=/root/pinpoint
  shell> $PINPOINT_HOME/pinpoint-restart.sh
  

  

• Pinpoint 시작하기: pinpoint-start.sh 실행 및 확인
  Pinpoint Component를 시작합니다.

  shell> PINPOINT_HOME=/root/pinpoint
  shell> $PINPOINT_HOME/pinpoint-start.sh
  

  

• Pinpoint 상태 확인하기: pinpoint-status.sh 실행 및 확인
  Pinpoint Component 상태를 확인합니다.

  shell> PINPOINT_HOME=/root/pinpoint
  shell> $PINPOINT_HOME/pinpoint-status.sh
  

  

  주의

  Pinpoint Components Status가 STOP일 때 pinpoint-stop.sh 또는 pinpoint-restart.sh를 실행할 경우 아래와 같은 Tomcat 오류 메시지가 출력될 수 있습니다.

  shell> PINPOINT_HOME=/root/pinpoint
  shell> $PINPOINT_HOME/pinpoint-status.sh
  shell> $PINPOINT_HOME/pinpoint-stop.sh
  

  

Pinpoint 프로세스 관리

다음 명령어로 Pinpoint 프로세스를 관리할 수 있습니다.Pinpoint 서비스는 아래와 같은 3가지 컴포넌트로 구성되어 있습니다.

• HBase 프로세스 시작/중지/프로세스 확인

  shell> $PINPOINT_HOME/hbase-1.2.6.1/bin/start-hbase.sh
  shell> $PINPOINT_HOME/hbase-1.2.6.1/bin/stop-hbase.sh
  shell> ps -ef | grep hbase
  

  

• Pinpoint Web 시작/중지/프로세스 확인

  shell> $PINPOINT_HOME/pinpoint-web/bin/startup.sh
  shell> $PINPOINT_HOME/pinpoint-web/bin/shutdown.sh
  shell> ps -ef | grep pinpoint-web
  

  

• Pinpoint Collector 시작/중지/프로세스 확인

  shell> $PINPOINT_HOME/pinpoint-collector/bin/startup.sh
  shell> $PINPOINT_HOME/pinpoint-collector/bin/shutdown.sh
  shell> ps -ef | grep pinpoint-collector
  

  

Pinpoint Agent 설치 및 적용

Pinpoint Agent는 각 사용자가 해당 서비스에 직접 설치하고 설정해야 합니다. Tomcat Application Service에 설치하고 설정하는 방법은 다음과 같습니다.

1. Pinpoint Agent 바이너리를 다운로드 및 설치해 주십시오. (Pinpoint Releases 바로가기)
   Agent 설치 디렉터리는 사용자가 직접 선택하여 설치 및 저장합니다.

2. Tomcat Application Service에 Agent를 설치하고, $CATALINA_HOME/bin/catalina.sh 파일을 다음과 같이 수정하고 저장해 주십시오.

$AGENT_PATH={PINPOINT_AGENT_INSTALLATION_DIRECTORY}
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_PATH: Pinpoint Agent가 설치된 디렉터리를 지정합니다.
• pinpoint-bootstrap-$VERSION.jar: 2018년 8월 5일 현재 1.7.3 버전이 최종 릴리즈 버전입니다.
• $AGENT_ID: Pinpoint Web 대시보드에서 각 Application을 구분하기 위한 Unique ID를 설정합니다.
• $APPLICATION_NAME: Pinpoint Web 대시보드에서 각 Application Group을 구분하기 위한 ID를 설정합니다.

3. ${AGENT_PATH}/pinpoint.config 파일에서 profiler.collector.ip=xxx.xxx.xxx.xxx에 Pinpoint Collector 서버 주소를 입력해 주십시오.

4. $CATALINA_HOME/bin/startup.sh을 실행하면, Pinpoint Agent에서 값을 수집하여 Pinpoint Collector(Port: 9994)로 전송합니다.

위와 같이 설정 완료 및 정상적으로 Application이 실행되었다면, Pinpoint Web에서 Application ID/Name으로 추가된 Agent 정보를 확인할 수 있습니다.

Pinpoint Web 접속하기

Pinpoint Components 설치 및 시작이 완료되면, 아래와 같은 방법으로 접속 및 사용이 가능합니다.

• Pinpoint Web 접속: http://{Public IP}:10090
• 로그인: 최초 로그인 ID/Password인 ppadmin/{Hostname}으로 접속이 가능하며, 위의 'Pinpoint Admin 패스워드를 초기화하려면 어떻게 해야 하나요?'를 참조하여 접속 계정 및 비밀번호를 반드시 변경해야 합니다.
  

1. Pinpoint Web ID와 Password를 입력해 주십시오.

2. [Login] 을 클릭하여 정상적으로 로그인하면 Pinpoint Main 대시보드를 사용할 수 있습니다.