JMX 툴, 자바 어플리케이션 모니터링 도구

#1. JMX ( Java Management Extensions )

JDK 1.5부터 포함된 런타임 어플리케이션 상태 모니터링 API이다.

JMX를 통해 리소스를 관리하려면 MBean (Managed Bean)를 생성해야한다. 자원을 MBean으로 감싸 외부에서 API로 설정, 데이터수집, 원격제어등을 할 수 있게 만들어준다.

 

JMX Connectors등으로 MBean Server에 접근해서 사용하면 되지만, JConsole, JVisualVM등 이미 JMX를 이용해 구현된 모니터링 도구가 있기 때문에 굳이 직접 만들어 사용할 필요는 없다. 대략적으로 어떻게 돌아가는지만 알아보고 넘어가도록 하자.

 

@ JMX의 동작원리

JMX와 MBean을 사용하려면 javax.management 안에 있는 라이브러리들을 이용하면 된다.

단, MBean을 구현한 인터페이스 이름은 반드시 'XXXMBean'으로 이름을 지어야 JMX가 인식한다.

// MBean interface name = implementation class name + MBean. 
public interface HelloMBean {
	public void setMessage(String message);
	public String sayHello();
}


// MBean 인터페이스 구현체
public class Hello implements HelloMBean {
	
	private String message = null;
	
	public Hello() {
		this.message = "Hello JMX!";
	}

	public Hello(String message) {
		this.message = message;
	}

	@Override
	public void setMessage(String message) {
		this.message = message;
	}

	@Override
	public String sayHello() {
		return "JMX Message ::: " + this.message;		
	}
}

JMX는 MBean을 이용하여 자원을 API 원격에서 조종, 모니터링 하는 도구이다. 자바코드로 생성한 MBean은 어플리케이션 내부에 있는 MBeanServer에 등록해야 한다. 이는 등록된 MBean들을 관리하는 JMX Agent 역할을 수행하게 된다.

 

이렇게 MBeans에 의해 자원이 관리되도록 구현하면, MBeanServer (JMX Agent)에 의해 관리되어지게 된다.
참고로 JMX Agent에는 MBeanServer뿐만 아니라 다양한 빈 관리 서비스들을 포함하고 있다.

대략적인 그림만 보고 넘어가도록 하자.

@ 예제

>> HelloAgent 실행
HelloAgent is running...

>> HelloClient 실행
HelloDomain
JMImplementation
JMX Message ::: 방가방가~~

 

📑 HelloAgent (JMX Agent) 코드

import java.rmi.registry.LocateRegistry;

import javax.management.MBeanServer;
import javax.management.MBeanServerFactory;
import javax.management.ObjectName;
import javax.management.remote.JMXConnectorServer;
import javax.management.remote.JMXConnectorServerFactory;
import javax.management.remote.JMXServiceURL;

public class HelloAgent {
	private MBeanServer mbs = null;

	public HelloAgent() {

		// 도메인명을 문자열로 받아 MBeanServer 생성
		mbs = MBeanServerFactory.createMBeanServer("HelloDomain");

		// MBean의 인스턴스 생성
		Hello helloMBean = new Hello();

		try {
			LocateRegistry.createRegistry(7777);
			JMXServiceURL serviceUrl = 
					new JMXServiceURL("service:jmx:rmi:///jndi/rmi://localhost:7777/hello");

			// HelloWorld MBean Name 정의
			// 도메인명 : NAME=VALUE,,,,
			ObjectName helloMBeanName = new ObjectName("HelloDomain:name=helloMBean");
			
			// helloName으로 helloBean을 등록
			mbs.registerMBean(helloMBean, helloMBeanName);
			
			// Client에서 접속하도록 커넥터 생성 및 시작
			JMXConnectorServer connector = 
					JMXConnectorServerFactory.newJMXConnectorServer(serviceUrl, null, mbs);
			connector.start();

		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	/**
	 * JMX 에이전트 Main은 ManagementFactory 클래스의 getPlatformMBeanServer () 
	 * 메소드를 호출하여 플랫폼에 의해 생성되고 초기화 된 MBean Server를 가져 오는 것으로 시작.
	 */
	public static void main(String argv[]) {
		new HelloAgent();
		System.out.println("HelloAgent is running...");
	}
}

📑 HelloClient 코드

import javax.management.JMX;
import javax.management.MBeanServerConnection;
import javax.management.ObjectName;
import javax.management.RuntimeErrorException;
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorFactory;
import javax.management.remote.JMXServiceURL;

public class HelloClient {
	public static void main(String[] args) {
		foo();
	}

	public static void foo() {

		try {
			JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://localhost:7777/hello");
			JMXConnector jmxc = JMXConnectorFactory.connect(url, null);

			// MBeanServerConnection 취득
			MBeanServerConnection mbsc = jmxc.getMBeanServerConnection();

			// Get domains from MBeanServer
			String domains[] = mbsc.getDomains();
			Arrays.sort(domains);
			for (String domain : domains) {
				System.out.println(domain);
			}

			// JMX Agent에서 등록한 ObjectName 생성
			ObjectName helloMBeanName = new ObjectName("HelloDomain:name=helloMBean");

			// MBeanServerConnection을 통해 MBean을 직접 접근하는 대신
			// MBean에 대한 전용 Proxy 생성 
			HelloMBean hello = JMX.newMBeanProxy(mbsc, helloMBeanName, HelloMBean.class, true);

			// MBean의 메서드를 원격 호출
			hello.setMessage("방가방가~~");
			System.out.println(hello.sayHello());   

		} catch (RuntimeErrorException e) {
			System.out.println("Error --->" + e);
			e.printStackTrace();
		} catch (Exception e) {
			System.out.println(e);
			e.printStackTrace();
		}
	}
}

 

---

#2. 자바 모니터링 유틸리티

외부 도구들도 많이 있지만, Oracle JDK와 Open JDK 배포판에는 아래와 같은 유틸 프로그램들이 내장되어 있다.

• JConsole (jconsole.exe)

아무런 설정없이 JDK에 기본설치되는 도구. 콘솔으로 MBean을 모니터링 할 수 있다.

• Java VisualVM (jvisualvm.exe) - JDK 8까지는 내장, JDK 9부터는 별도로 설치해야함.

visualVM, 전체 VM에 대한 Thread 개수, Class개수와 기본적인 CPU와 JVM 메모리 상황을 시각적으로 모니터링 할 수 있다.

• Java Mission Control (jmc.exe)
  JConsole과 VisualVM이 기본 도구라고 생각한다면, JMC는 오라클에서 제공하는 자바 모니터링 도구이다.

• Diagnostic Command Tool (jcmd.exe)
  Java8부터 제공되는 분석도구로, 현재는 사용하지 않는 기존의 자바 JVM 진단 도구들을 통합한 형태이다.
  (jps, jmap, jstack, jinfo 등)

 

---

#3. Java Flight Recorder

JDK 8부터 실험적으로 추가된 기능으로, 독립형 프로그램(.exe)이 아니라 JDK에 내장된 도구이다.

 

@ JMC에서 JFR을 사용하던데 이건 무슨말이죠?

Java Mission Control(JMC)는 위에서 설명한 대로 자바 앱에 대한 실시간 상태 정보를 확인하는 도구이다.

JFR의 경우 이렇게 실시간으로 수집된 정보를 저장하여 문제 발생시 원인 분석 및 문제 발생시기를 분석하는데 도움되는 정보를 파일(.jfr)로 제공해주는 도구이다. 일종의 자바 앱 블랙박스.

 

사용법은 앱 시작전에 JVM 명령어로 활성화 하거나, 위에서 언급한 jcmd 명령을 이용해서 실행도중 활성화 할 수 있다.

JDK8에서는 실험적인 기능이라 별도의 활성화가 필요했으나, JDK11 부터는 앱 동작시 기본으로 사용된다.

 

JFR은 JDK 내부에서 이벤트에 대한 정보들을 flight.jfr 에 저장한다. 이 정보들을 JMC로 읽어들여 시각화 할 수 있다.

.jfr 파일을 열었을 때 모습.

 

이렇게 JFR을 활성화하면, JVM을 모니터링하여 얻은 이벤트 정보들을 .jfr에 저장한다. 다만 앱에서 이런 디스크 I/O작업은 추가적인 비용이 많이 든다. 그래서 JFR은 데이터 블록을 디스크에 저장하기 전 다양한 버퍼를 사용하여 성능 문제를 해결한다.

 

이 과정은 복잡하기에 자세하게 알 필요는 없지만, JMC에서는 생성된 시간 순서대로 시각화 해주지만 JFR 출력파일이 실제 생성된 시간은 다를 수 있다는 점만 유의해서 사용하자.

 

 

 

---

# JFR 예제

고의적으로 OutOfMemoryError를 발생시키는 프로그램을 만들어보자.

예외가 발생할 때 까지 객체를 생성하고, 예외가 발생했다면 프로그램을 1초동안 멈추도록 코드를 작성하였다.

public static void main(String[] args) {
    List<Object> items = new ArrayList<>(1);
    try {
        while (true){
            items.add(new Object());
        }
    } catch (OutOfMemoryError e){
        System.out.println(e.getMessage());
    }
    assert items.size() > 0;
    try {
        Thread.sleep(1000);
    } catch (InterruptedException e) {
        System.out.println(e.getMessage());
    }
}

 

@ JFR 활성화

그리고 해당 클래스를 컴파일 한 후, JVM에 아래와 같은 명령어로 실행시키면 된다.

➡ JDK 8의 경우, JFR은 라이선스를 필요하는 기능이기에 UnlockCommercialFeatures 옵션을 넣어주어야 한다.

➡ 아래 명령의 경우 myrecording.jfr 파일에 200초동안 MyClassName 의 정보를 저장하도록 설정하였다.

java -XX:+UnlockCommercialFeatures -XX:+FlightRecorder 
  -XX:StartFlightRecording=duration=200s,filename=myrecording.jfr 
  -cp ./out/ com.jiwon.package.MyClassName

 

만약 프로그램이 이미 실행중이라면, 아래와 같이 jcmd를 이용하여 JFR을 시작할 수 있다.

다만 UnlockCommercialFeatures 옵션이 반드시 앱 시작시에 포함되어있어야 JVM에서 JFR을 활성화 할 수 있다.

jcmd 5368 JFR.start duration=200s filename=myrecording.jfr

 

 

@ .jfr 분석

JMX를 이용하는 도구인 JMC (Java Mission Control)을 이용하면 아래와 같이 .jfr 파일을 확인할 수 있다.

메인화면에서는 CPU의 사용량에 대한 정보를 보여주는데, while 루프로 인해 사용량이 상당한 것을 확인할 수 있다.
그 외 왼쪽 탭에서 Memory, Code, Thread등 다양한 정보를 확인할 수 있다. 메소드 호출 통계등도 확인 가능하다.

분석 결과, java.util.ArrayList.grow(int) 메서드가 17번이나 호출되어 CPU와 메모리를 상당히 많이 잡아먹는 것을 알 수 있다. 이 예제에서는 단순한 정보밖에 얻을 게 없었지만, 실제로는 아래와 같은 유용한 정보를 얻을 수 있다.

• 생성된 객체에 대한 통계, GC에 의해 생성 및 등록, 소멸되는 시점
• 스레드가 잠겼거나 다시 활성화 된 시기에 대한 자세한 보고서
• 애플리케이션이 실행중인 I/O 작업들