5. Scouter의 실행 및 종료 파일은 어떤 원리로 동작할까?

탁돌이개발자

1. 실행파일의 구성 및 동작원리

1-1. startup.sh의 내용

당연하게도 스카우터의 서버를 실행시키기 위해서는 startup.sh (또는 startup.bat)을 실행시켜야 한다. 이 파일을 실행하면, 내부의 명령어를 통해 scouter server가 실행되는 방식이다.

내부 코드를 보면 아래와 같다.

startup.sh

3번 라인의 부분이 코드를 실행시키는 핵심 부분이다.

nohup java -Xmx512m -classpath ./boot.jar scouter.boot.Boot ./lib > nohup.out &

우선 nohup는 뒤에 실행될 명령어가 쉘이 종료되더라도 계속 실행상태를 유지할 수 있도록 하게 하는 명령어이다. 즉, nohup를 붙인 명령어는 터미널을 꺼도 계속 실행이 되게 할 수 있는 것이다.
일반적으로 remote 환경에서 ssh 등으로 작업을 많이 하는데, 이 때 ssh 접속을 종료하면 덩달아 프로그램이 다 종료되는 참변을 막기 위함이다.

다음으로 -Xmx512m을 통해 Max Heap Size를 512 MB로 설정한 것을 알 수 있다. Xmx의 디폴트 값은 6MB인데, 512로 한 이유는 아무래도 서버에서 다양한 작업을 처리하기 때문에 메모리를 많이 요구할 수 있기 때문이다.

다음으로 > nohup.out을 보면 프로그램 실행 시 나오는 출력 문구들을 전부 nohup.out이라는 파일을 생성하여 리디렉트 하고있는 것을 알 수 있다. 쉽게말해 출력 문구들을 화면에 바로 띄우지 않고, nohup.out에 저장한다는 의미이다.

마지막으로 &를 붙여서 프로그램이 백그라운드로 돌아가게 했음을 알 수 있다.

나머지 2줄은 간단하다.
먼저 3번 라인 실행 후 4번 라인을 통해 1초동안 잠깐 sleep 상태로 대기한다.
이후 5번 라인에서, nohup.out에 쓰였던 내용 중 맨 뒤의 100줄을 화면에 출력해준다.

1-2. 실행 시 Scouter 내부에서의 작업

1-1에서 살펴본 startup.sh를 통해 스카우터가 불려지면 스카우터 내부의 scouter.server.Main 이 제일 첫째로 호출된다.
Main.java의 내용 중 일부를 잘라내서 설명하자면 아래와 같다.

즉, startup.sh를 실행시키면 내부에 5371.scouter와 같이 스카우터의 프로세스 ID를 이름으로 하는 파일이 생성된다. 결국 이 파일이 있다면 스카우터가 실행중이란 뜻이 된다.

기타 플러그인 호출이나 init 과정은 본 게시글의 취지에 벗어나므로 생략하도록 하겠다. 단지 pid.scouter와 같은 파일이 실행 시 생성된다는 점만 알면 된다.

2. 종료파일의 구성 및 작동원리

2-1. stop.sh의 내용

이제 프로그램을 종료시키는 stop.sh를 살펴보면 아래와 같이 매우 단순한 형태임을 알 수 있다.

stop.sh

설명할 것도 없이 .scouter로 끝나는 모든 파일을 지우는 것임을 알 수 있다.
즉, startup.sh를 통해 생성된 .scouter파일을 단순히 stop.sh를 통해 삭제하는 형태이다.

그렇다면 .scouter 파일을 삭제하는 것으로만 어떻게 스카우터를 종료시킬 수 있는 것일까?
이전에 살펴본 소스코드에 설명을 더하자면 다음과 같다.

즉, .scouter 파일이 있는지 없는지를 검사하여 없다면 프로그램을 종료(exit(0))를 하는 방식이다.

3. 예제

위와 같은 로직을 간단하게 구현해보면 아래와 같이 나타내볼 수 있다.

import java.io.File;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.Executors;
import java.text.SimpleDateFormat;
import java.util.Date;

public class Main{
	
	public static void main(String[] args) {
		Program p = new Program();
		if(p.init() == false) {
			System.exit(1); //1234.scouter 파일 생성 실패시 비정상 종료(1)
		}
		p.run(); //5초 간격 날짜 출력하는 스레드 실행
	}
}

class Program{
	File exit = null;
	Date date = null;
	
	public boolean init() {
		exit = new File("1234.scouter"); //1234.scouter 파일 생성 시도
		
		if(exit.exists()) { //이미 있다면? -> 중복실행이므로 종료
			System.err.println("Already Exist");
			return false;
		}
		try {
			exit.createNewFile(); //새로 생성
			exit.deleteOnExit(); //스레드 종료 시 같이 삭제되게 설정
			System.out.println("Create Success");
		}
		catch(Exception e) {
			System.err.println("Create Fail");
			return false;
		}
		
		return true;
	}
	
	public void run() {
		ScheduledExecutorService executor = Executors.newScheduledThreadPool(1);
		executor.scheduleAtFixedRate(new Runnable() {
			@Override
			public void run() {
				//5초 간격으로 화면에 2018-08-18 16:23:45와 같이 출력
				System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(date = new Date()));
				
				//1234.scouter 파일이 없으면? -> 프로그램 종료
				if(exit.exists() == false) {
					System.out.println("Exit Program");
					System.exit(0);
				}
				else {
					//있으면? -> 파일의 lastModified를 최신으로 갱신
					exit.setLastModified(date.getTime());
				}
			}
		}, 0, 5, TimeUnit.SECONDS); //5초 간격으로 실행
	}
}

실행 시 1234.scouter 파일 생성 확인

1234.scouter 삭제 시 프로그램 종료

4. 마치며...

여기까지 해서 스카우터 실행 & 종료파일의 구성 및 동작원리에 대해 간단하게 알아보았다.
본 글에서는 linux환경에서의 server에 대해서만 예시를 보았으나, Windows의 .bat 파일이나, Agent의 파일들도 동일한 방식이기에 같은 방식을 적용하여 이해할 수 있을 것이다.

< Prev ofbiz 설치 (기본설치)

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

♥