기타(framework)
HOME > JAVA > FRAMEWORK > 기타(framework)
2019.05.29 / 24:47

4. Scouter Server BuiltInPlugin을 제작해보자 - (2) 플러그인 제작

탁돌이개발자
추천 수 307

이번 포스팅은 (1) 요구사항 분석 에 이어 실제로 플러그인을 만들어 보는 실습을 소개하겠다.
실습으로는 정해진 시간 간격에 따라 로그를 남기는 단순한 기능의 플러그인을 제작해 볼 것이다.

목차는 아래와 같다.

1. 개발 요구사항
2. 플러그인 제작 실습
  2-1. 코드 작성
  2-2. 내보내기(export)
3. 구동 테스트
  3-1. 정상작동 확인



1. 개발 요구사항

이전 포스팅에서 살펴봤듯이 위의 요구조건을 반드시 충족해야 한다.
잘 이해가 안 간다면 이전 게시글을 참고하면 된다.
http://blog.naver.com/occidere/221069755554

3. Scouter Server BuiltInPlugin을 제작해보자 - (1) 요구사항 분석
이번 주제는 조금 길어질 듯하여 1, 2부로 나누었다. 1부에서는 Built-in Plugin의 개념과 개발하기 위한...
blog.naver.com

단, 본 예시에서는 상기 명시한 6개의 기능을 딱히 활용할 필요가 없는 단순 플러그인을 제작하기 때문에, 6개 annotation 중 아무거나 골라 사용하도록 하겠다.



2. 플러그인 제작 실습

제작할 플러그인은 일정 시간마다 콘솔에 로그를 남기는 간단한 프로그램을 만들어 보겠다.



2-1. 코드 작성

1. 새로운 프로젝트를 생성한다
이름은 자유이나, 본 예시에서는 scouter-plugin-server-log라고 생성하였다.

프로젝트 생성



2. Dependency를 설정한다
scouter.server와 scouter.common이 필요하다.

Dependency 추가




3. scouter.plugin.server.log 패키지 내부에 Log 클래스를 생성하여 다음과 같이 작성한다
이미 이전에도 강조했다시피 작동시킬 플러그인은 반드시 scouter.plugin.server 패키지 내부의 public class여야 한다.

Log.java 클래스
package scouter.plugin.server.log; import scouter.lang.pack.*; //메서드의 매개변수로 들어갈 Pack들을 이용하기 위해 불러옴 import scouter.lang.plugin.PluginConstants; //메서드에 어노테이션 사용하기 위해 불러옴 import scouter.lang.plugin.annotation.ServerPlugin; //메서드에 어노테이션 사용하기 위해 불러옴 import scouter.server.Configure; //서버 설정 파일(scouter.conf)을 이용하기 위해 불러옴 public class Log { private Configure conf = Configure.getInstance(); @ServerPlugin(PluginConstants.PLUGIN_SERVER_COUNTER) public void printLog(Pack pack) { //scouter.conf 파일에서 ext_plugin_log 부분의 값(true 또는 false)을 읽어온다. //ext_plugin_log가 없으면 false로 초기화 boolean extConf = conf.getBoolean("ext_plugin_log", false); if(extConf) { //로그 출력 부분 } } }


내용을 설명하자면,

conf 는 스카우터 외부 설정파일인 scouter.conf로, 스카우터 doc에선 외부 플러그인은 ext_plugin_으로 시작하는 이름의 설정값을 사용할 것을 명시 및 권장하고 있다.
https://github.com/scouter-project/scouter/blob/master/scouter.document/main/Plugin-Guide_kr.md#2-annotation


기본적으로 scouter/server/conf/scouter.conf에 존재하며, 본 예시에서는 ext_plugin_log=true 값을 입력하여 사용할 것이다.
따라서 위의 경로로 이동하여 내부에 ext_plugin_log=true를 입력한다.

scouter.conf 내부에 ext_plugin_log=true 입력
vim scouter.conf

이 값을 이용하는 이유로는 변경사항을 적용하려면 서버를 재시작 해야하는 built-in plugin의 약점을 보완하기 위한 것으로,
ext_plugin_log= 값을 true나 false로 변경해 주는 것 만으로도 재시작 없이 모듈 기능을 켜고 끌 수 있다는 장점을 갖는다.



또한 메서드의 매개변수로 Pack을 기입하긴 하였으나, 로그를 찍는 본 예시에서는 딱히 쓸 일이 없는 의미없는 선언이기에 별도로 사용하진 않았다.
원래 Pack은 scouter에서 수집한 데이터들을 담아놓은 다양한 클래스(인터페이스 구현체)들 이다.

마찬가지로 어노테이션도 6개 중 아무거나(COUNTER)사용하였다.




4. etc 패키지를 생성하고, 내부에 시간 주기를 관리할 Time 클래스를 작성한다
마지막 출력 시간(lastPrinted)으로 부터 일정 시간(period)만큼 지났으면 출력하고, 마지막 출력 시간을 갱신하는 코드이다.
본 예시에선 period = 10초 간격으로 로그를 출력할 수 있게 한다.

이 클래스는 스카우터에서 직접 불러 사용하는 것이 아닌, 스카우터에서 불려지는 메서드 내부에서 호출되는 것이므로 패키지 이름의 제약은 받지 않는다. 단, public class 및 public method여야 한 것은 여전히 지켜야 한다.

package etc; public class Time { private static long period = 10000L; //주기 10초 private static long lastPrinted = -1; //초기값 음수 //주기가 지났으면 true, 아니면 false public static boolean canExecute(long curTime) { //첫 실행이면 현재 시간으로 초기화 -> false 리턴(출력 안됨) if(lastPrinted < 0) lastPrinted = curTime; return curTime - lastPrinted > period; } public static void setLastPrinted(long curTime) { lastPrinted = curTime; } }





5. etc 패키지 내부에 출력할 내용을 담은 Text클래스를 생성한다
사실 아무 내용이나 출력해도 되나, 좀 더 다양성을 추구하기 위해 랜덤으로 노래 가사를 반환하는 메서드를 담은 클래스를 별도로 만든 것이다(귀찮다면 안만들어도 됨)

사심가득
package etc; import java.util.Random; public class Text { private static final String SIGNAL[] = { "Signal 보내 signal 보내", "찌릿 찌릿 찌릿 찌릿", "난 너를 원해 난 너를 원해", "왜 반응이 없니", "만날 때 마다 마음을 담아", "찌릿 찌릿 찌릿 찌릿", "기다리잖아 다 보이잖아", "왜 알지 못하니" }; //노래가사 랜덤 반환 public static String getText() { int idx = new Random().nextInt(SIGNAL.length); return SIGNAL[idx]; } }






6. Log 클래스의 printLog() 메서드를 완성한다

일정 시간(10초)마다 랜덤 가사를 콘솔창에 찍는 코드
package scouter.plugin.server.log; import scouter.lang.pack.*; import scouter.lang.plugin.PluginConstants; import scouter.lang.plugin.annotation.ServerPlugin; import scouter.server.Configure; import scouter.server.Logger; //서버 콘솔에 로그 찍는 클래스 import etc.Time; //주기별로 출력하게 하는 클래스 import etc.Text; //출력할 텍스트를 담은 클래스 public class Log { private Configure conf = Configure.getInstance(); @ServerPlugin(PluginConstants.PLUGIN_SERVER_COUNTER) public void printLog(Pack pack) { boolean extConf = conf.getBoolean("ext_plugin_log", false); if(extConf) { long curTime = System.currentTimeMillis(); //현재 시간 /* 실행 가능하다 = 마지막 출력으로 부터 주기 만큼 지났다 */ if(Time.canExecute(curTime)) { Logger.println(Text.getText()); //랜덤 텍스트 출력 Time.setLastPrinted(curTime); //마지막 출력 시간을 현재 시간으로 갱신 } } } }



2-2. 내보내기(export)

스카우터의 built-in plugin은 jar파일이다. 따라서 작성한 코드를 jar파일로 export 시켜야 한다.
jar파일 생성을 위한 간단한 ANT 파일을 생성(build.xml) 및 작성하면 아래와 같다.
복붙하는 것을 권장한다.

build.xml 생성
본 예시에서 외부 라이브러리는 없으므로 주석 부분은 안 써도 됨
<?xml version="1.0" encoding="UTF-8"?> <project name="Build log plugin" default="packaging"> <property name="dir.target.jar" value="./out" /> <property name="dir.classes" value="./bin" /> <target name="packaging"> <mkdir dir="${dir.target.jar}" /> <jar destfile="${dir.target.jar}/scouter-plugin-server-log.jar"> <fileset dir="${dir.classes}"/> </jar> </target> </project>



이후 생성된 build.xml을 우 클릭 - Run As - 1. Ant Build 를 클릭한다.

ANT 로 jar파일 빌드



정상적으로 작성했다면, 프로젝트 폴더에 out이란 폴더가 생성되고, out 폴더 내부에 jar파일이 생성된다.

jar 파일 생성 완료

여기까지 되었으면 모든 준비가 끝난 것이다. 이제 서버에 올려서 테스트만 하면 된다.




3. 구동 테스트

3-1. 정상작동 확인

생성된 jar파일을 scouter/server/lib/ 내부로 옮겨준다.

rz -E를 이용해 옮김



이후 agent.host와 server를 실행시킨다. 반드시 2개 모두 실행시켜야 한다.

agent.host 실행
server 실행




두개 다 실행을 마쳤으면 서버 로그를 확인해 본다.
서버 로그는 server/logs/ 내부에 있다.

10초 간격으로 정상 출력되는 것을 확인할 수 있다!


로그 확인 결과 10초 간격으로 로그가 성공적으로 정상 출력됨을 확인할 수 있다.



4. 마치며...

여기까지 하여 간단한 Built-in Plugin 제작을 실습해 보았다.

사실 스카우터에서 제공하는 6가지 기능(counter, alert, object, xlog, profile, summary)를 활용하지 않은 예시였으나, 기능 활용 방법까지 포함하려면 너무 길어질 것 같아서 플러그인 제작 부분에만 집중하였다.

추가적인 플러그인 개발은 스카우터의 플러그인 가이드를 참고하면 좋을 것이다.
https://github.com/scouter-project/scouter/blob/master/scouter.document/main/Plugin-Guide_kr.md

scouter-project/scouter
scouter - Scouter is an open source APM (Application Performance Management) tool.
github.com


p.s. 가끔 스카우터 내부 스케쥴러로 인하여 한번에 여러번 출력되는 경우가 발생할 수 있다.
이 경우 AtomicInteger 등을 활용하여 락을 해주면 된다.