기본 콘텐츠로 건너뛰기

[ JAVA ] JVM Shutdown 상황에서도 로그를 출력해 보자.

  현재 진행 중인 프로젝트는 Java Agent 를 이용해서 JVM 상에 구동되는 Application의 성능을 측정하기 위한 Custom Profiler를 구성하는 것이기에 Logging 정보가 상당히 중요하고, JVM Shutdown 되는 시점을 Hooking 하여 Agent 의 서비스들이 제대로 종료하는지를 검증하여야 한다.

  그런데 JVM Shutdown Hooking 을 하게 되면 그 시점에 java.util.logging.LogManager 를 사용하고 있다면 Logger 들이 모두 Clear 되어 버리기 때문에 완전히 종료되는 시점까지 Logging 을 처리할 수 없다.

*** 지금부터 언급하는 상황들은 java.util.logging.LogManager를 사용하는 경우에 해당하는 것이므로 다른 logging 처리를 하는 경우에는 해당되지 않는다. 다만 처리되는 상황이 궁금한 경우는 참고가 될 수도 있다.

왜? Logger 가 모두 Clear 되는 것일까?

  가장 먼저 문제가 되는 LogManager를 역 추적해 보도록 하자. 우선 어플리케이션에서 JVM Shutdown 을 Hooking 하는 방법은 아래와 같다.

// JVM Shutdown Hook Thread를 설정한다.
Thread shutdownThread = new Thread(new Runnable() {
    @Override
    public void run() {
        try {
            LOGGER.info("JVM Shutdown called");
            shutdown();
            LOGGER.info("JVM Shutdown complete");
        } catch (Exception e) {
            LOGGER.log(Level.SEVERE, "JVM Shutdown completed with errors", e);
        }
    }
}, Constants.ID_JVM_SHUTDOWN);
Runtime.getRuntime().addShutdownHook(shutdownThread);

  위의 코드는 JVM 이 Shutdown 될 때  처리할 Thread를 생성하고 “Runtime.getRuntime().addShutdownHook” 메서드에 등록하여 JVM이 Shutdown 될 때 호출이 되도록 하는 것이다.

  문제는 위의 코드 중에서 “JVM Shutdown called” 는 로그에 남겨지지만 이후 처리 중에 Logger 가 모두 Clear 되기 때문에 “JVM Shutdown complete” 는 로그에 남지 않는다는 것이다. 이 문제를 확인 하기 위해서는 LogManager를 검토해 봐야 한다. 아래의 코드는 java.util.logging.LogManager.class 의 내용으로 역시나 예상한 대로 JVM Shutdown 을 Hooking 하고 있는 것을 확인할 수 있다.

private LogManager(Void checked) {

    // Add a shutdown hook to close the global handlers.
    try {
        Runtime.getRuntime().addShutdownHook(new Cleaner());
    } catch (IllegalStateException e) {
        // If the VM is already shutting down,
        // We do not need to register shutdownHook.
    }
}

  위의 코드에서 JVM 종료시에 Cleaner 클래스를 생성하여 run 메서드가 호출되도록 설정한 것을 확인하였기 때문에 Cleaner 클래스를 찾아서 보면 아래의 코드를 확인할 수 있다.

// This private class is used as a shutdown hook.
// It does a "reset" to close all open handlers.
private class Cleaner extends Thread {
    private Cleaner() {
        /* Set context class loader to null in order to avoid
         * keeping a strong reference to an application classloader.
         */
        this.setContextClassLoader(null);
    }

    public void run() {
        // This is to ensure the LogManager. is completed
        // before synchronized block. Otherwise deadlocks are possible.
        LogManager mgr = manager;

        // If the global handlers haven't been initialized yet, we
        // don't want to initialize them just so we can close them!
        synchronized (LogManager.this) {
            // Note that death is imminent.
            deathImminent = true;
            initializedGlobalHandlers = true;
        }

        // Do a reset to close all active handlers.
        reset();
    }
}

  위의 코드를 확인하면 “reset()” 를 호출하여 모든 활성화된 Handler 들을 종료하는 것을 확인할 수 있다. 즉, Logger 가 Clear 된다고 보기 보다는 Logger 가 사용하고 있는 파일/콘솔 등의 출력 Handler 가 초기화되기 때문에 열심히 로그를 남겨봐야 출력이 되지 않는다는 것을 알 수 있다.

  그럼 이런 문제를 해결하기 위해서는 어떤 방식을 사용하여야 할까???

  해법이 전혀 없는 것은 아니다. LogManager의 정적 초기화 부분을 보면 이미 환경 (Java Options) 으로 설정된 값이 존재한다면 LogManager에 접근하면 설정된 Manager 가 재 설정되는 것을 확인할 수 있다.

...
static {
    AccessController.doPrivileged(new PrivilegedAction() {
        public Object run() {
            String cname = null;
            try {
                cname = System.getProperty("java.util.logging.manager");
                if (cname != null) {
                    try {
                        Class clz = ClassLoader.getSystemClassLoader().loadClass(cname);
                        manager = (LogManager) clz.newInstance();
                    } catch (ClassNotFoundException ex) {
                        Class clz = Thread.currentThread().getContextClassLoader().loadClass(cname);
                        manager = (LogManager) clz.newInstance();
                    }
                }
            } catch (Exception ex) {
                System.err.println("Could not load Logmanager \"" + cname + "\"");
                ex.printStackTrace();
            }
            if (manager == null) {
                manager = new LogManager();
            }

            ...
        }
    });
}
...

  위의 코드를 유추하면 사전에 “java.util.logging.manager” 에 설정된 클래스가 존재하면 LogManager  대신에 지정된 클래스의 인스턴스를 사용한다는 점이다. 이를 사용해서 LogManager를 상속한 별도의 LogManager를 사용하도록 지정하고 reset 부분을 변경하면 된다.

사용자 정의 LogManager 구성하기.

public class AgentLogger extends LogManager {
    static AgentLogger                instance;
    ...
    public AgentLogger() {
        instance = this;
    }
    ...
    private void overridedReset() {
        super.reset();
    }
    ...
    @Override
    public void reset() {
        // JVM Shutdown에서 유지될 수 있도록 제거
    }
    ...
    public static void resetFinally() {
        // JVM Shutdown 처리에서 호출되어야 함.
        if (instance != null) {
            instance.overridedReset();
        }
        shutdown();
    }
    ...
    public static void shutdown() {
        LOGGER.info("Logger shutting down");
        if (fileHandle != null) {
            try {
                fileHandle.flush();
                fileHandle.close();
                instance = null;
            } catch (Exception ex) {
                LOGGER.log(Level.WARNING, "Logger shutting down abnormally", ex);
            }
        }
    }
    ...
}
  위의 코드는 LogManager 의 "reset()" 에서는 아무 작업도 하지 않고 어플리케이션의 JVM Shutdown 처리에서 로그 처리가 끝난 후에 "resetFinally" 라는 메서드를 호출하여 Logger 처리를 Clear 하는 것이다. 별 것 아니기는 하지만 로그를 끝까지 남겨야 하는 상황에서는 하나의 해법이 될 수 있다.

  마지막으로 어플리케이션에서는 다음과 같이 호출하면 된다. 

...
// Agent 시작 시점에 LogManager에 대한 설정을 Custom LogManager로 설정한다.
System.setProperty("java.util.logging.manager", AgentLogger.class.getName());
...

// JVM Shutdown Hook Thread를 설정한다. Thread shutdownThread = new Thread(new Runnable() { @Override public void run() { try { LOGGER.info(“JVM Shutdown called”); shutdown(); LOGGER.info(“JVM Shutdown complete”); } catch (Exception e) { LOGGER.log(Level.SEVERE, “JVM Shutdown completed with errors”, e); } finally { AgentLogger.resetFinally(); } } }, Constants.ID_JVM_SHUTDOWN); Runtime.getRuntime().addShutdownHook(shutdownThread);

*** 이 해법에는 한 가지 치명적인 단점이 존재한다.

  일반적인 어플리케이션에서 사용하는 것은 상관이 없지만 Java Agent 에 구현을 하고 Tomcat 등과 같이 내부적으로 LogManager를 사용하는 다른 어플리케이션을 사용하는 경우에는 Agent 에서 Log 처리가 제대로 수행이 되지만 Tomcat 이 구동될 때 conf 폴더에 존재하는 logging.properties 파일에 설정된 “1catalina.org.apache.juli.FileHandler”, “2localhost.org.apache.juli.FileHandler” 등의 클래스를 찾을 수 없다는 Class Not Found Exception 이 발생할 수 있다. 이 오류가 발생하는 이유는 Agent 의 ClassLoader 는 Bootstrap 기준의 Class 들만을 알고 있기 때문에 java.util.logging.manager 에 설정된 AgentLogger 가 Tomcat 의 logging configuration 에 지정된 handler 들의 클래스를 찾을 수 없기 때문에 발생하게 된다. 즉, 쓰면 안된다는 것이다. ㅠㅠ

댓글

이 블로그의 인기 게시물

OData 에 대해서 알아보자.

얼마 전에 어떤 회사에 인터뷰를 하러 간 적이 있었다. 당시 그 회사는 자체 솔루션을 개발할 기술인력을 찾고 있었고 내부적으로 OData를 사용한다고 했다. 좀 창피한 이야기일 수도 있지만 나름 기술적인 부분에서는 많은 정보를 가지고 있다고 했던 것이 무색하게 OData란 단어를 그 회사 사장님에게서 처음 들었다. 작고, 단순한 사이트들만을 계속해서 작업을 하다 보니 어느덧 큰 줄기들을 잃어버린 것을 느끼기 시작했다. 명색이 개발이 좋고, 기술적인 기반을 만들려고 하는 인간이 단어조차도 모른다는 것은 있을 수 없는 것이라서 다시 새로운 단어들과 개념들을 알아보는 시간을 가지려고 한다. OData (Open Data Protocol) 란? 간단히 정리하면 웹 상에서 손쉽게 데이터를 조회하거나 수정할 수 있도록 주고 받는 웹(프로토콜)을 말한다. 서비스 제공자 입장에서는 웹으로 데이터를 제공하는 방식으로 각 포탈 사이트들이 제공하는 OPEN API 포맷을 독자적인 형식이 아니라 오픈된 공통규약으로 제공 가능하며, 개발자는 이 정보를 다양한 언어의 클라이언트 라이브러리로 어플리케이션에서 소비할 수 있도록 사용하면 된다. 공식 사이트는 www.odata.org 이며 많은 언어들을 지원하고 있다. 좀더 상세하게 정의를 해 보면 OData는 Atom Publishing Protocol  (RFC4287) 의 확장 형식이고 REST (REpresentational State Transfer) Protocol 이다. 따라서 웹 브라우저에서 OData 서비스로 노출된 데이터를 볼 수 있다. 그리고 AtomPub 의 확장이라고 했듯이 데이터의 조회만으로 한정되는 것이 아니라 CRUD 작업이 모두 가능하다. Example 웹 브라우저에서 http://services.odata.org/website/odata.svc 를 열어 보도록 하자. This XML file does not appear to have any style in...

C# 에서 Timer 사용할 때 주의할 점.

예전에 알고 지내시던 분의 질문을 받았다. Windows Forms 개발을 하는데, 주기적 (대략 1분)으로 데이터 요청을 하는 프로그램을 작성하기 위해서 Timer 를 사용하는데, 어떤 기능을 처리해야 하기 때문에 Sleep 을 같이 사용했다고 한다. 여기서 발생하는 문제는 Sleep 5초를 주었더니, Timer 까지 5초 동안 멈춘다는 것이다. Timer 라는 것은 기본적으로 시간의 흐름을 측정하는 기능이기 때문에 Sleep 을 했다고 해서 Timer 가 멈추는 일은 생겨서는 안된다. 그러나 실제 샘플을 만들어 보면 ... Timer 가 Sleep 만큼 동작이 멈추는 것을 확인할 수 있다. Windows Forms 는 UI Thread 를 사용하는 것으로 최적화 되어 있으며 여기서 Timer 를 쓰면 UI Thread 에 최적화된 System.Windows.Forms.Timer 가 사용된다. 여기서 문제의 발생이 시작되는 것이다. Sleep 을 사용하게 되면 UI Thread 가 Sleep 이 걸리기 때문에 여기에 속한 Timer 까지도 멈추는 것이다. 이런 문제를 해결하기 위해서는 System.Threading.Timer 를 사용해야 한다. 이 Timer 는 별도의 Thread 에서 동작하기 때문에 Sleep 의 영향을 받지 않는다. 언뜻 보면 쉬운 해결 방법인 것 같지만 Thread 가 분리되었기 때문에 Timer 가 돌아가는 Thread 에서 UI Thread 의 메서드나 컨트롤에 접근하기 위해서는 별도의 명령을 사용해야 하는 문제가 존재한다. 자~ 그럼 여기서 Timer 에 대해서 다시 한번 정리해 보도록 하자. .NET 에서 제공하는 Timer 들 .NET 에서는 기본적으로 3가지 Timer를 제공하고 있다. (MSDN) System.Windows.Forms.Timer - 사용자가 지정한 간격마다 이벤트를 발생시키며 Windows Forms 응용 프로그램에서 사용할 수 있도록 최적화 되어 있다. System...

[Logging] NLog 사용법 정리...

SCSF 에는 기본적으로 Enterprise Library가 사용된다. 예전에도 그랬지만 기능은 훌륭하고 많은 부분에서 최적화(?)된 것일지도 모르지만, 역시나 사용하기에는 뭔가 모르게 무겁고, 사용하지 않는 기능이 더 많다라는 느낌을 지울수가 없다. 이번 프로젝트도 SCSF를 기반으로 하고 있지만, Enterprise Library를 걷어내고 각 부분에 전문화된 오픈 소스를 사용하기로 하였다. 예전에는 Log4Net을 사용했지만, 대량 사용자 환경에서는 메모리 누수와 기타 문제점이 존재한다는 MS 컨설턴트(?)의 전해진 말을 들은 후로는 사용하지 않는다. 대안으로 사용하는 것이 NLog 이다. 조금 후에는 3.0 버전도 나온다고 홈 페이지에 기재되어 있지만, 그 때가 되면 프로젝트는 끝나기 때문에 현재 2.1.0 버전을 사용하기로 했다. [원본 출처] http://cloverink.net/most-useful-nlog-configurations-closed/ 위의 참조 자료에는 다양한 정보들이 존재하므로 꼭 링크를 통해서 관련된 정보를 확인하고 이해하는 것이 좋을 듯 하다. 여기서는 당장 필요한 부분만을 정리하도록 한다. [ Logger 찾기 ] 기본적으로 Logger가 존재하는 클래스를 기반으로 Logger 정보를 구성한다. Logger logger = LogManager.GetCurrentClassLogger(); 주로 Namespace 기반으로 Logger를 설정하는 경우에 유연하게 사용할 수 있다. 또 다른 방법으로는 지정한 문자열로 특정 Logger를 직접 선택하는 방법도 제공된다. 이를 혼용해서 Namespace와 직접 지정 방식을 같이 사용할 수도 있다. 물론 Logger 환경 설정에서 Wildcard (*)를 지정할 수도 있다. Logger logger = LogManager.GetLogger("Database.Connect"); Logger logger = LogManager.Get...