Scouter Paper 설치 in Linux

SCOUTER PAPER

1. SCOUTER PAPER

☞ SCOUTER WEB API를 활용하여 만들어진  Scouter의 성능 지표를 웹을 통해 확인할 수 있게 해주는 대시보드 SW입니다.

☞ PC, 모바일 모두 접속 가능한 반응형 웹을 가지고 있습니다.

Paper

☞ SCOUTER PAPER 파일은 아래는 공식 GitHub 다운로드 링크입니다.

GitHub - scouter-contrib/scouter-paper: scouter-paper is a web client software for scouter

 

 

Scouter Paper Installation in Linux

아래의 링크를 통해 Scouter 설치를 완료합니다.

Scouter APM 설치 in Linux

 

Scouter Paper를 다운로드 받고 압축을 해제합니다.

# wget https://github.com/scouter-contrib/scouter-paper/releases/download/2.6.4/scouter-paper-v2.6.4.zip

# mkdir /root/scouter-paper
# unzip scouter-paper-v2.6.4.zip -d /root/scouter-paper

 

Scouter Paper 압축 파일을 해제하면 아래와 같은 웹 소스를 확인할 수 있습니다.

# tree -L 1 /root/scouter-paper
/root/scouter-paper
├── asset-manifest.json
├── css
├── favicon.ico
├── help
├── index.html
├── js
├── manifest.json
├── service-worker.js
└── static

4 directories, 5 files

 

Scouter Paper 압축 해제한 디렉토리에서 Scouter webapp 디렉토리로 복사합니다.

# cp -a /root/scouter-paper/* /app/scouter/webapp/extweb/

# ls -l /app/scouter/webapp/extweb/
total 136
-rw-rw-r--. 1 root root   3749 May 17  2020 asset-manifest.json
drwxrwxr-x. 2 root root     76 May 17  2020 css
-rw-rw-r--. 1 root root 118026 May 17  2020 favicon.ico
drwxrwxr-x. 4 root root     61 May 17  2020 help
-rw-rw-r--. 1 root root   1572 May 17  2020 index.html
drwxrwxr-x. 2 root root     26 May 17  2020 js
-rw-rw-r--. 1 root root    317 May 17  2020 manifest.json
-rw-rw-r--. 1 root root   6644 May 17  2020 service-worker.js
drwxrwxr-x. 5 root root     40 May 17  2020 static

 

Scouter Paper 관련 설정을 추가합니다.

"## scouter-paper" 주석 아래의 3개 설정은 Web API 서버를 활성화하는 설정입니다.

# vi /app/scouter/server/conf/scouter.conf

## Scouter APM ID
server_id=scouter-tomcat

## Default 6100
net_tcp_listen_port=6100
net_udp_listen_port=6100

db_dir=/app/scouter/data
log_dir=/app/scouter/logs

## scouter-paper
net_http_server_enabled=true
net_http_api_enabled=true
net_http_port=6180

 

설정이 완료되었으면 Scouter Server를 실행한 다음 Scouter Paper를 실행합니다.

실행한 뒤에 http_port인 6180이 LISTEN 상태인지 확인합니다. 

# cd /app/scouter/server/
# ./startup.sh

# cd /app/scouter/webapp/
# ./startup.sh

# ss -atnlp
State         Recv-Q        Send-Q                 Local Address:Port                 Peer Address:Port        Process
LISTEN        0             128                          0.0.0.0:22                        0.0.0.0:*            users:(("sshd",pid=1014,fd=4))
LISTEN        0             50                                 *:6180                            *:*            users:(("java",pid=2620,fd=131))
LISTEN        0             50                                 *:6188                            *:*            users:(("java",pid=2700,fd=100))
LISTEN        0             50                                 *:6100                            *:*            users:(("java",pid=2620,fd=102))
LISTEN        0             128                             [::]:22                           [::]:*            users:(("sshd",pid=1014,fd=6))

 

실행중인 Scouter Web API test를 하여 정상인지 확인합니다.

여러가지 Web API 테스트가 있겠지만 가장 간단한 Scouter Server의 정보를 조회합니다.

# curl localhost:6180/scouter/v1/info/server |jq .
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   216  100   216    0     0   9818      0 --:--:-- --:--:-- --:--:-- 10285
{
  "status": "200",
  "requestId": "#45829",
  "resultCode": "0",
  "message": "success",
  "result": [
    {
      "id": "-1082951330",
      "name": "scouter-tomcat",
      "connected": true,
      "serverTime": "1667836487922",
      "version": "2.17.1 2022-03-27 04:35 GMT"
    }
  ]
}

 

연동할 WAS 서버에 접속하여 Scouter 연동 설정 파일중 "agents.java" 디렉토리의 scouter.conf에 "counter_interaction_enabled=true" 설정을 추가합니다.

# vi /app/scouter-agent/agent.java/conf/scouter.conf

obj_name=WAS-1
net_collector_ip=192.168.0.12
net_collector_udp_port=6100
net_collector_tcp_port=6100

#hook_method_patterns=sample.mybiz.*Biz.*,sample.service.*Service.*
#trace_http_client_ip_header_key=X-Forwarded-For
#profile_spring_controller_method_parameter_enabled=false
#hook_exception_class_patterns=my.exception.TypedException
#profile_fullstack_hooked_exception_enabled=true
#hook_exception_handler_method_patterns=my.AbstractAPIController.fallbackHandler,my.ApiExceptionLoggingFilter.handleNotFoundErrorResponse
#hook_exception_hanlder_exclude_class_patterns=exception.BizException

## Scouter Paper
counter_interaction_enabled=true

 

설정이 완료되면 Agent 재기동을 진행합니다.

# /app/scouter-agent/agent.host/stop.sh
# /app/scouter-agent/agent.host/host.sh

 

브라우저에서 Scouter Paper 페이지에 접속합니다.

Scouter Paper 접속화면

 

위와 같은 대시보드의 지표 설정은 아래와 같이 좌측 상단 메뉴에 PAPER CONFIG에서 추가합니다.

ADD PAPER를 추가하고 원하는 지표를 DRAG하는 방식으로 진행합니다.