Scouter 공부 시작하기

1. 환경 정보

• Scouter Version: 2.21.3
• Scouter 서버
  • OS: Ubuntu Pro 24.04
  • Type: t3.small
• Scouter Client
  • Windows

---

2. 참고 링크

• 설치 파일: https://github.com/scouter-project/scouter/releases/
  • 서버(scouter-all-2.21.3.tar.gz)
  • Client(scouter.client.product-win32.win32.x86_64.zip)
• 설치 방법: https://github.com/scouter-project/scouter/blob/master/scouter.document/main/Setup.md
• WEB API: https://github.com/scouter-project/scouter/blob/master/scouter.document/tech/Web-API-Guide.md

---

3. 간단 설명

3.1 Scouter 구성

• Scouter: Java 애플리케이션(WAS)과 서버 OS 리소스를 모니터링하는 오픈소스 APM 도구
• Client: 사용자가 수집 서버에 접속해 지표를 조회하는 Tool
• Collector: 에이전트가 보낸 데이터를 받아 저장하고 Client에 제공하는 수집 서버
• Host Agent: 서버의 CPU, 메모리, 디스크 등 OS 리소스 정보를 수집하는 에이전트
• Tomcat Agent(Java Agent): Tomcat에서 실행되는 애플리케이션의 트랜잭션, 응답 시간 등 성능 정보를 수집하는 에이전트
• WEB API: Collector에 저장된 성능 데이터를 HTTP(REST) 방식으로 조회할 수 있게 해 주는 인터페이스로, 외부 시스템이나 웹 대시보드(예: Scouter Paper)와 연동할 때 사용

---

4. JAVA 설치

Collector Server, Host Agent, Tomcat Agent 서버에 사전 설치 필요

# JDK 1.8 설치
sudo apt update  # 패키지 목록 최신화, 최신 버전으로 업그레이드는 안함.
sudo apt list |grep jdk
sudo apt install -y openjdk-8-jdk
java -version

#openjdk version "1.8.0_504"
#OpenJDK Runtime Environment (build 1.8.0_504-8u504-ga-1ubuntu1~24.04.3-b01)
#OpenJDK 64-Bit Server VM (build 25.504-b01, mixed mode)

---

5. Scouter 설치 파일 다운로드

Collector Server, Host Agent, Tomcat Agent 서버에 사전 다운로드 필요

scouter_version='2.21.3'
wget "https://github.com/scouter-project/scouter/releases/download/v${scouter_version}/scouter-all-${scouter_version}.tar.gz"
tar -zxvf "scouter-all-${scouter_version}.tar.gz"
rm "scouter-all-${scouter_version}.tar.gz"

---

6. Collector Server

6.1 설치

# 스카우터 기동
cd ./scouter/server
./startup.sh

#nohup: redirecting stderr to stdout
#  ____                  _
# / ___|  ___ ___  _   _| |_ ___ #_ __
# \___ \ / __/   \| | | | __/ _ \ #'__|
#  ___) | (_| (+) | |_| | ||  #__/ |
# |____/ \___\___/ \__,_|\__\___|#_|
# Open Source S/W Performance Monitoring
# Scouter version 2.21.3

6.2 네트워크 포트

프로토콜	포트	용도
UDP (수신)	6100	성능 지표 수집
TCP (서비스)	6100	Scouter 클라이언트 및 에이전트와의 통신

6.3 Config

server/conf/scouter.conf

---

7. Host Agent

7.1 설치

# Host Agent 기동
cd ./scouter/agent.host
./host.sh

---

8. Tomcat Agent

Tomcat이 기동할 때 Tomcat Agent도 같이 기동되도록 구성

8.1 설치

# Tomcat 기동할 때 Tomcat Agent도 함께 기동되도록 구성하기

# 기동 시 사용하는 파일
# ./scouter/agent.java/scouter.agent.jar

# JAVA 옵션 설정
# 아래 옵션을 ${TOMCAT_DIR}/bin/catalina.sh 또는 startup.sh에 추가
# 이거 이렇게 변수로 넣는건 어떠한지?
SCOUTER_AGENT_DIR=./scouter/agent.java

JAVA_OPTS=" ${JAVA_OPTS} -javaagent:${SCOUTER_AGENT_DIR}/scouter.agent.jar"
JAVA_OPTS=" ${JAVA_OPTS} -Dscouter.config=${SCOUTER_AGENT_DIR}/conf/scouter1.conf"
JAVA_OPTS=" ${JAVA_OPTS} -Dobj_name=myFirstTomcat1"

• 하나의 가상 머신에서 여러 개의 Tomcat 인스턴스를 사용하는 경우, 각 인스턴스에 대한 구성 파일 정의 필요
• -Dscouter.config 환경 변수를 통해 설정 파일을 지정할 수도 있음
• 모니터링 대상 객체의 이름이 하나의 VM 내에서 중복되지 않도록 obj_name 옵션을 통해 이름을 지정해야함

8.2 Config 예시

# Scouter Server IP Address (Default : 127.0.0.1)
net_collector_ip=127.0.0.1

# Scouter Server Port (Default : 6100)
net_collector_udp_port=6100
net_collector_tcp_port=6100

# Scouter Name(Default : tomcat1)
obj_name=myFirstTomcat1

---

9. Client (Windows)

https://github.com/scouter-project/scouter/releases/download/v2.21.3/scouter.client.product-win32.win32.x86_64.zip

# 압축 해제
# scouter.exe 실행
# 인증 정보 입력 후 확인 (admin/admin)

---

10. WEB API

10.1 설치

# Embedded 모드 실행은 공식 문서 참고

# Standalone 모드 실행
## Config 설정
### net_collector_ip_port_id_pws 설정
Default ==> 127.0.0.1:6100:admin:admin
형식 ==> {host}:{port}:{id}:{pw}

### 기본값
net_http_port: 6188
net_http_api_allow_ips: localhost,127.0.0.1,0:0:0:0:0:0:0:1,::1;

## 실행
cd scouter.webapp
./startup.sh

10.2 네트워크 포트

모드	프로토콜	포트	용도
Embeded	TCP	6180	WEB API 접근 포트
Standalone	TCP	6188	WEB API 접근 포트

10.3 테스트

# 접속
http://{http-server-ip}:{port}/scouter/v1/info/server

# 예상 응답
{
    "status": 200,
    "requestId": "#xxxx",
    "resultCode": 0,
    "message": "success",
    "result": [
        {
            "id": -1234512345,
            "name": "MyCollectorName",
            "connected": true,
            "serverTime": 1507878605943
        }
    ]
}

10.4 Swagger

• net_http_api_swagger_enabled 옵션으로 설정 가능
• /swagger/index.html ==> URI에서 확인 가능
• (http://demo.scouterapm.com:6180/swagger/index.html)

10.5 Counter widget

• /widget/simple/counter.html