이상을 꿈꾸는 몽상가.. 프로그래밍을 좋아함..


SLF4J Logger 사용법 & 잘못된 사용법: Binding Parameters, Logging Exception Stack Trace

SLF4J Logo
(이미지 출처 : http://www.slf4j.org/)

Logger의 잘못된 사용법은 어플리케이션의 성능에 큰 영향을 줍니다.
이러한 문제는 개발 과정 중에는 발견되지 않으며 성능 테스트에서야 발견이 가능합니다.
성능 테스트 케이스에서 누락된 경우, 운영 중에 많은 부하를 받게 되었을 때 문제를 일으킬 소지가 있습니다.

이 글은 SLF4J의 올바른 사용법에 대해서 기술합니다. 특히, 파라미터 바인딩과 exception의 stack trace를 로깅하는 올바른 방법에 대해서 기술합니다.

SLF4J(Simple Logging Facade for Java)를 이용해서 로그를 남기는 것을 가정하고 글을 작성합니다.

샘플은 Github에 올려뒀습니다.
샘플에서 SLF4J 와 연동한 로그 솔루션은 Log4J 2 입니다. 설정에 대한 설명은 아래 링크를 참고하시기 바랍니다.

최악의 방법

java.lang.System.out, java.lang.System.err을 이용한 로깅은 로그 레벨을 관리할 수 없기 때문에 문제가 됩니다.


    // worst
    System.out.println("Hello " + userName + ".");

Exception의 stack trace를 로깅할 때도 ex.printStackTrace()를 이용하면 안됩니다.
참고로, ex.printStackTrace()은 내부적으로 java.lang.System.err를 이용해서 로그를 남기게 됩니다.


    try {
        throw new Exception("Something is wrong.");
    } catch(Exception ex) {

        // worst
        ex.printStackTrace();
    }

Binding Parameters

Binding One Parameter

아래 4개의 방법은 모두 동일한 결과를 출력합니다. 그리고 INFO, WARN, ERROR 로그 레벨과 처럼 DEBUG보다 상위 레벨일 경우 4개 방법 모두 출력이 일어나지 않습니다.
하지만 모두 출력이 일어나지 않음에도 불구하고 어떤 경우는 성능 차이가 납니다.


    private void bindOneParameter(String userName) {

        // poor performance, poor readability
        logger.debug("Hello " + userName + ".");

        // always good performance, poor readability
        if(logger.isDebugEnabled()) {
            logger.debug("Hello " + userName + ".");
        }

        // always good performance, good readability
        if(logger.isDebugEnabled()) {
            logger.debug("Hello {}.", userName);
        }

        // good performance, best readability - I recommend this.
        logger.debug("Hello {}.", userName);
    }


문자열 직접 연산 방법

        // poor performance, poor readability
        logger.debug("Hello " + userName + ".");

가용 로그 레벨을 DEBUG에서 INFO로 조절하면 로그가 남는 과정이 생략되기 때문에 성능 개선을 이뤄집니다.
하지만 logger.debug() 메소드가 실행되기 전에 "Hello " + userName + "." 이라는 문자열 연산이 먼저 일어나서 문자열 연산만큼의 성능 악화가 발생됩니다.

+와 같은 문자열 연산만의 문제가 아니라
logger.debug() 메소드 실행 이전에 어떠한 연산이라도 일어나게 되면 동일한 낭비가 발생됩니다.

가용 로그 레벨 체크

        // always good performance, poor readability
        if(logger.isDebugEnabled()) {
            logger.debug("Hello " + userName + ".");
        }

가용 로그 레벨이 INFO라면 logger.debug() 메소드가 실행되지 않을 뿐만 아니라 문자열 연산도 일어나지 않기 때문에 성능 낭비가 없습니다.

가용 로그 레벨 체크 & SLF4J 치환문자 사용

        // always good performance, good readability
        if(logger.isDebugEnabled()) {
            logger.debug("Hello {}.", userName);
        }

두번째 방법과 동일하게 성능 낭비가 없습니다.

게다가 SLF4J의 치환문자({})를 이용해서 가독성이 높아져 출력될 로그의 결과가 쉽게 예상됩니다.

SLF4J 치환문자 사용

        // good performance, best readability - I recommend this.
        logger.debug("Hello {}.", userName);

먼저 첫번째 방법과 비교하면,
logger.debug() 메소드가 실행되기 전에 +와 같은 연산은 없어서 성능 개선이 있습니다. 또한 로그의 가독성이 높아졌습니다.

세번째 방법과 비교하면,
"Hello {}." 문자열 생성과 같은 연산이 발생하기 때문에 성능이 약간 떨어집니다.

그리고 logger.debug() 메소드는 실행되지만 해당 메소드 내에서 가장 먼저 가용 로그 레벨을 체크하는 과정이 가장 먼저 일어나기 때문에 Object.toString()과 같은 추가적인 연산은 발생하지 않습니다.

다만, 로그 솔루션에 대한 필터를 등록한 경우에는 로그 가용 레벨 체크 전에 필터가 먼저 수행됩니다.
그렇기 때문에 필터를 작성시에 로그 레벨 체크를 고려해서 작성 해야한다는 주의 항목이 발생하긴 합니다.


package org.apache.logging.slf4j;

...(skipped)

public class Log4jLogger implements LocationAwareLogger, Serializable {

    private transient ExtendedLogger logger;

    ...(skipped)

    @Override
    public void debug(String format, Object o) {
        logger.logIfEnabled(FQCN, Level.DEBUG, (org.apache.logging.log4j.Marker)null, format, o);
    }

    ...(skipped)
}

Log4J 2의 경우, 아래와 같이 가용 로그를 가장 먼저 체크 합니다.


package org.apache.logging.log4j.spi;

...(skipped)

public abstract class AbstractLogger implements ExtendedLogger, Serializable {


    ...(skipped)

    @Override
    public void logIfEnabled(String fqcn, Level level, Marker marker, String message, Object p0) {
        if (isEnabled(level, marker, message, p0)) {
            logMessage(fqcn, level, marker, message, p0);
        }

    }

    ...(skipped)
}

다시 한번 살펴보면,
네번째 방법은 세번째 방법보다 문자열 생성이라는 약간의 성능 낭비가 발생합니다. 그리고 필터 작성시에 주의해야할 항목이 생깁니다.
하지만 그럼에도 불구하고 코드의 간결성을 위해 저는 네번째 방법을 선호하고 권장합니다.
그러한 이유로 앞으로 설명하는 내용들에서도 가용 로그 레벨을 먼저 체크하는 방법에 대해서는 생략하고 설명을 진행하겠습니다.

만약 성능이 너무 중요한 어플리케이션이거나 너무 긴 문자열 생성이 발생하는 경우라면 가용 로그 레벨을 먼저 체크하는 방법을 사용하시기 바랍니다.

Binding Two Parameters


    private void bindTwoParameters(User user) {

        // poor performance, poor readability
        logger.debug("Hello " + user.getName() + "(" + user.getEmail() + ")");

        // poor performance, good readability
        logger.debug(String.format("Hello %s(%s)", user.getName(), user.getEmail()));

        // good performance, good readability - I recommend this.
        logger.debug("Hello {}({}).", user.getName(), user.getEmail());
    }

파라미터가 1개 일때보다 2개의 경우, 가독성이 좋아진 것이 확실하게 비교됩니다.
그리고 첫번째, 두번째 방법은 앞서 설명했던 것 처럼 문자열 연산이 가장 먼저 일어나기 때문에 성능 악화가 발생합니다.

성능과 가독성을 모두 만족시켜주는 세번째의 SLF4J 치환문자({}) 사용 방법을 권장합니다.

Binding Many Parameters

    private void bindManyParameters(User user) {

        // little poor performance, good readability
        logger.debug("User id : {}, email : {}, job : {}", user.getName(), user.getEmail(), user.getJob());

        // good performance, good readability, uncomfortable
        logger.debug("User name : {}", user.getName());
        logger.debug("User email : {}", user.getEmail());
        logger.debug("User job : {}", user.getJob());

        // good performance, good readability - I recommend this.
        logger.debug("User : {}", user);
    }

세 방법 모두 SLF4J의 치환문자({})를 사용하는 방법입니다.
첫번째 경우는 파라미터의 개수가 여러개이고 두번째, 세번째 경우는 파라미터가 1개입니다.
파라미터 개수가 3개 이상이면 가용 로그 레벨을 체크하기 전에 Object[] 를 생성하는 비용이 발생합니다.

However, this variant incurs the hidden(and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for DEBUG


package org.slf4j;

...(skipped)

public interface Logger {

    ...(skipped)

    /**
     * Log a message at the DEBUG level according to the specified format
     * and arguments.
     * <p/>
     * <p>This form avoids superfluous string concatenation when the logger
     * is disabled for the DEBUG level. However, this variant incurs the hidden
     * (and relatively small) cost of creating an <code>Object[]</code> before invoking the method,
     * even if this logger is disabled for DEBUG. The variants taking
     * {@link #debug(String, Object) one} and {@link #debug(String, Object, Object) two}
     * arguments exist solely in order to avoid this hidden cost.</p>
     *
     * @param format    the format string
     * @param arguments a list of 3 or more arguments
     */
    public void debug(String format, Object... arguments);

    ...(skipped)
}

그렇기 때문에 최대한 파라미터의 개수를 2개 이하로 맞추기 위해 노력해야 합니다.

다만, 두번째 방법은 로그가 한줄에 출력되는 것이 아니라 세줄로 나눠서 출력되기 때문에 로그가 한곳에 모여있지 않을 수 있습니다. 다른 쓰레드의 로그가 세줄의 로그 사이에 끼어들게 될 것입니다. 만약 파일에 로깅을 하는 상황에서 심할 때는 세줄이 각각 다른 파일에 로깅될 경우도 있을 것입니다. 로깅시 함께 남긴 thread id로 검색해서 확인을 해야할 수 도 있습니다.

세번째 방법은 로그도 한줄에 남고 성능도 제일 좋으며 가독성도 좋습니다.
User 객체의 Object.toString() 메소드에 대한 override 작업은 필요합니다. (대부분의 IDE에서 자동생성 기능이 제공됩니다.)

public class User {

    private final String email;
    private final String name;
    private final String job;

    ...(skipped)

    @Override
    public String toString() {
        return "User{" +
                "email='" + email + '\'' +
                ", name='" + name + '\'' +
                ", job='" + job + '\'' +
                '}';
    }
}

Logging Exception

Logging Exception Stack Trace

SLF4J는 Throwable 객체를 마지막 파라미터로 넘기게 되면 stack trace를 로깅시켜 줍니다. 다만, 첫번째 파라미터는 String으로 넘겨주셔야 합니다.

    private void printExceptionStackTrace(User user) {

        try {
            throw new Exception("Something is wrong.");
        } catch(Exception ex) {

            // good performance, poor information
            logger.error("", ex);

            // good performance, good information - I recommend this.
            logger.error("User : {}", user, ex);
        }
    }

위의 모두 아래와 같이 동일한 stack trace가 로깅 됩니다.

java.lang.Exception: Something is wrong.
	at io.dveamer.sample.manual.ManualController.printExceptionStackTrace(ManualController.java:87) [main/:?]
	at io.dveamer.sample.manual.ManualController.manual(ManualController.java:23) [main/:?]
	at jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[?:?]
	at jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[?:?]
	at jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[?:?]
	at java.lang.reflect.Method.invoke(Method.java:566) ~[?:?]
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:190) [spring-web-5.2.6.RELEASE.jar:5.2.6.RELEASE]
  ...(skipped)

하지만 첫번째 방법은 stack trace만 남기 때문에 문제 해결에 필요한 정보가 부족합니다.
두번째 방법은 아래와 같이 User 객체의 정보가 함께 로깅 되기 때문에 보다 빠른 문제 해결이 가능합니다.

2020-06-27 23:54:41,974 ERROR i.d.s.m.ManualController [http-nio-8080-exec-1] User : User{email='dveamer@gmail.com', name='Dveamer', job='developer'}
java.lang.Exception: Something is wrong.
	at io.dveamer.sample.manual.ManualController.printExceptionStackTrace(ManualController.java:87) [main/:?]
	at io.dveamer.sample.manual.ManualController.manual(ManualController.java:23) [main/:?]
	at jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[?:?]
	at jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[?:?]
	at jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[?:?]
	at java.lang.reflect.Method.invoke(Method.java:566) ~[?:?]
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:190) [spring-web-5.2.6.RELEASE.jar:5.2.6.RELEASE]

Binding Many Parameters 때와 마찬가지로 파라미터는 exception을 포함해서 2개 이하로 맞추기 위해 노력해야합니다.

Logging Exception Message


    private void printExceptionMessage(User user) {

        try {
            if(user.getName() == null) {
                throw new IllegalArgumentException("user name is required parameter.");
            }
        } catch(IllegalArgumentException ex) {

            // good performance, poor information
            logger.warn(ex.getMessage());

            // poor performance, good information
            logger.warn("{} - User : {}", ex.getMessage(), user.toString());

            // good performance, good information - I recommend this.
            logger.warn("{} - User : {}", ex.getMessage(), user);
        }
    }

첫번째 방법은 예외 처리 메시지는 잘 기록 되지만 상황에 대한 정보가 부족합니다.
ex.getMessage()의 경우에도 가용 로그 레벨 체크보다 먼저 수행되지만
일반적인 exception들의 getMessage() 메소드는 getter의 역할만 하기 때문에 비용 발생이 거의 없습니다.

두번째 방법은 필요한 정보가 모두 기록되지만 가용 로그 레벨 체크보다 user.toString()이 먼저 수행되기 때문에 성능 낭비가 발생합니다.

세번째 방법은 가용 로그 레벨 체크가 user.toStirng()보다 먼저 수행되기 때문에 성능 낭비가 발생하지 않습니다.
이 경우에도 역시 Binding Many Parameters 때와 마찬가지로 파라미터는 exception을 포함해서 2개 이하로 맞추기 위해 노력해야합니다.


Associated Posts

관련된 주제를 살펴볼 수 있도록 동일한 Tag를 가진 글들을 모아뒀습니다. 제목을 눌러주세요.

  • 홈페이지 현황 ( Log4J 2 관련 대박사건 )


    Apache Logging Service Logo
    ( 이미지 출처 : https://logging.apache.org )

    Log4J 공식사이트- Articles and Tutorials에서 제 블로그 글을 링크 걸어두고 있던 것을 발견하여 기록합니다.

    큰 의미가 있는 것은 아니지만 개인적으로 기분이 좋네요. (저한테만 대박사건 ㅋ)


  • SLF4J 와 Log4j 2 연동하기


    SLF4J Logo Apache Logging Service Logo
    (이미지 출처 : http://www.slf4j.org/, https://logging.apache.org)

    SLF4J와 Log4j2를 연동하기 위한 Gradle dependencies설정에 대해서 알아봅니다.

    Log4j2 xml 설정은 Log4j 2 설정하기 글을 참고하시기 바랍니다.


  • Log4j 2 설정하기


    Apache Logging Service Logo
    ( 이미지 출처 : https://logging.apache.org )

    Configuration 파일을 어디다가 둬야 혹은 어떻게 처리해야 Log4j 를 사용할 수 있을까요?
    저는 예전에는 이것 때문에 굉장히 애를 먹었습니다.

    분명 Spring을 쓸 때는 src/main/resources 아래에 두면 잘 돌아갔었습니다.
    근데 프레임워크가 없는 레거시 시스템에 적용하려고보니 당연히도 src/main/resources가 없죠.
    알고보니 WAS의 web.xml 에서 설정해야 하더군요.
    또 다른 프로젝트로 가서 적용하려다보니 Daemon으로 돌리는 시스템이라 WAS가 없고 web.xml이 없더군요.

    Log4j 를 접하면 저는 항상 당황스러움이 가장 먼저 떠오릅니다.

    그래서 가장 우선적으로 configuration을 적용하는 방법을 설명합니다.
    그리고 Log4j 2 에서 제공하는 강력한 성능의 비동기방식 로깅처리에 대해서 알아보겠습니다.
    Configuration 작성법은 샘플을 통해서 간략히 설명하겠습니다.


i