[SpringBoot] Scavenger 적용기 (데드코드 분석 툴)

Scavenger란?

Naver DEVIEW 2023 - 당신의 코드는 생각보다 많이 죽어있다. 발표영상 | GITHUB

GitHub - naver/scavenger: A runtime dead code analysis tool

- 런타임 Dead Code 분석 도구

- 메소드 호출 기록을 수집하여 시각화

- Java Agent 방식 사용

=> 유지보수 용이, 컴파일 및 테스트 속도 향상!

 

컴포넌트

- Agent: 코드 베이스를 스캔하고, 어플리케이션 내 메소드 호출 정보를 주기적으로 Collector에게 보냄

- Collector: 에이전트로 받은 데이터를 DB에 저장

- API: DB를 읽어, 사용자에게 시각화

 

설치하기

Database

H2 & MySQL 지원

데이터베이스 서버를 띄우고 scavenger 데이터베이스 생성

Collector

1. Github에서 scavenger-collector-${version}.jar 파일 다운

2. Configuration

java \
-Dspring.datasource.url=${JDBC_URL} \
-Dspring.datasource.username=${JDBC_USERNAME} \
-Dspring.datasource.password=${JDBC_PASSWORD} \ 
-Dspring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver \
-Darmeria.port=8080 \
-jar scavenger-collector-${version}.jar

API

1. Github에서 scavenger-api-${version}.jar 파일 다운

2. Configuration

java \
-Dscavenger.collector-server-url=${COLLECTOR_SERVER_URL} \
-Dspring.datasource.url=${JDBC_URL} \
-Dspring.datasource.username=${JDBC_USERNAME} \
-Dspring.datasource.password=${JDBC_PASSWORD} \ 
-Dspring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver \
-Dserver.port=8081 \
-jar scavenger-api-${version}.jar

Collector와 API 서버를 띄운 후, localhost:8081(or API_SERVER_NAME)으로 접속하면 메인화면 확인 가능!

Agent

1. 프로젝트에 에이전트 다운

curl https://repo1.maven.org/maven2/com/navercorp/scavenger/scavenger-agent-java/1.0.3/scavenger-agent-java-1.0.3.jar -L -o scavenger-agent.jar

2. Scavenger UI에서 워크스페이스를 생성하고 설정파일 다운로드 후, 프로젝트 내부에 저장

 

 

3. Project Run 옵션 지정

-javaagent:$PROJECT_DIR$/scavenger-agent.jar -Dscavenger.configuration=$PROJECT_DIR$/scavenger.conf

 

Agent - Collector 통신 이슈 (Kubernetes)

Kubernetes 환경으로 Collector와 API 서버는 동일한 Cluster, 어플리케이션(Agent)는 다른 Cluster에 띄워져있음

Agent - Collector의 통신 불가 

Caused by: java.io.IOException: FRAME_SIZE_ERROR: 4740180

Collector를 Ingress-nginx로 서비스 하고있었으나, 이때 gRPC 통신이 잘 먹지않는 것으로 파악...

Ingress-nginx를 사용하지 않고, Nodeport Service로 띄우고, 직접 붙으니(https://{{도메인}}:{{NODE_PORT}}) 정상적으로 통신! 

하지만 Port를 붙여서 통신하는 것 자체가 굉장히 ugly하여 다른 방식 파악 중...

(ingress-nginx에 gRPC 설정 또한 해주었으나 결과는 동일 ㅠㅠ)