[Spring] - 로깅: Log4j, Log4j2, Slf4j, Logback

📎 Logging - Log4j, Log4j2, Slf4j, Logback

 로그(Log) 는 기록을 남기는 것을 의미합니다. 로그를 통해 소프트웨어의 개발이나 운영 시 발생하는 문제점을 파악할 수 있습니다.

오류가 발생했을때 가장 먼저 확인하는 것이 로그를 보는 것이므로, 로그를 남기는 것은 굉장히 중요하다고 생각합니다.

실제 소프트웨어에서 문제가 발생했을때, 적재적소에 로그가 출력이 되고있다면 문제의 원인에 대해 정확한 파악이 가능합니다.

Java에서는 Log4j, Log4j2, Slf4j, Logback 등 다양한 로깅 프레임워크가 존재하는데요, 이에 대해 간략히 알아보겠습니다.

 

 

 

💻 Log4j

---

 Apache Log4j 는 다른 로깅 프레임워크에 비해 아파치 재단의 가장 오래된 프레임워크입니다. 콘솔 및 파일 출력의 형태로 로그를 남길 수 있으며, xml이나 properties 환경으로 구성할 수 있습니다.  Apache 공식문서에서는 2015년 8월을 끝으로 Log4j는 개발이 중단되었으며, Log4j2로 업그레이드 할 것을 권장한다고 합니다.

http://logging.apache.org/log4j/1.2/

Log4j는 다음과 같은 구성 및 로그 레벨을 가지고 있습니다.

 

 

Log4j 구성

요소	설명
Logger	출력할 메시지를 Appender에게 전달
Appender	전달된 로그를 출력할 대상을 지정(File, Console, JDBC 등)
Layout	로그를 출력할 형식을 지정

 

 

Log4j의 로그 레벨

로그 레벨	설명
FATAL	아주 심각한 에러가 발생한 상태. 일반적인 어플리케이션에서는 사용할 일이 없음
ERROR	요청을 처리하는 중 문제가 발생한 상태
WARN	실행에는 문제가 없으나 향후 에러가 발생할 수 있는 경고성 메시지
INFO	로그인, 상태변경과 같은 정보성 메시지
DEBUG	디버그 용도로 사용하는 메시지
TRACE	디버그 레벨보다 상세한 이벤트를 나타내는 메시지
로그 레벨은 FATAL > ERROR > WARN > INFO > DEBUG > TRACE 순서를 가지며, DEBUG을 로그 레벨로 지정하면 상위 레벨인 FATAL ~ DEBUG까지 로그가 출력이 됩니다.

 

 

Log4j 예제

의존성 추가

// gradle
implementation group: 'log4j', name: 'log4j', version: '1.2.17'

// maven
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

 

 

resources 디렉토리 하위에 log4j.xml 파일 추가(Console)

<log4j:configuration debug="false">
    <!--Console appender -->
    <appender name="stdout" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %p %m%n"/>
        </layout>
    </appender>

    <root>
        <level value="DEBUG"/>
        <appender-ref ref="stdout"/>
    </root>
</log4j:configuration>

 

 

예제 코드

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

public class Logging {

    private static final Logger logger = Logger.getLogger(Logging.class);

    public static void main(String[] args) {
        logger.setLevel(Level.DEBUG);

        logger.fatal("FATAL Logging");
        logger.error("ERROR Logging");
        logger.warn("WARN Logging");
        logger.info("INFO Logging");
        logger.debug("DEBUG Logging");
        logger.trace("TRACE Logging");
    }
}

 

 

※ 다음과 같이 {}에 인자를 넣어줌으로써 출력을 할 수 있습니다.

// logger.info("요청 URL: " + request.getRequestUrl());

logger.info("요청 URL: {}",request.getRequestUrl());
logger.info("요청 시간: {}",LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
logger.info("요청 IP: {}",request.getRemoteAddr());

String의 더하기 연산(+)을 통해 문자열을 연결하지 않고 위와 같이 사용하는 것이 성능상으로 이점을 가져가게 된다고 하니, 위와 같이 사용하는 것을 추천드립니다.

 

 

 

💻 Log4j2

---

 Apache Log4j2 는 이전 버전인 Log4j 1.x에 비해 상당히 개선된 Log4j의 업그레이드 된 버전으로 Logback 아키텍쳐에 내재된 몇 가지 문제를 해결하면서 Logback에서 사용할 수 있는 로깅 프레임워크입니다.

Logback처럼 필터링 기능과 자동 리로딩을 지원하며, 차이점은 멀티 스레드 환경에서 비동기 로거(Async Logger)는 다른 로깅 프레임워크보다 처리량이 훨씬 많고, 대기 시간이 훨씬 짧습니다. 또한 Java8에 도입된 람다식을 지원하고, Lazy Evaluation을 지원합니다.

 

Log4j 1.x 버전과의 차이점은 다음과 같습니다.

• 신뢰성 향상: Log4j 1.x이나 Logback과 같이 프레임워크를 재구성하는 동안 메시지가 손실되지 않습니다
• 확장성: Log4j2는 사용자가 커스텀 컴포넌트를 구성하고 정의할 수 있도록 플러그인 시스템을 지원합니다.
• 간단한 구성 문법
• xml, json, yaml, properties 속성 지원
• 개선된 filters
• 환경파일, 시스템 속성, 환경 변수, ThreadContextMap, 이벤트에 정의된 값에 대한 Property 조회 지원
• 다중 API 지원: Log4j2는 Log4j2, Log4j, Slf4j, Commong Logging 및 julva.util.logging(JUL) API를 사용하는 응용 프로그램과 함께 사용할 수 있습니다.
• 사용자 커스텀 로그 레벨
• "Lazy Logging"을 위한 Java8 스타일의 람다 지원
• 향상된 속도

 

출처: https://en.wikipedia.org/wiki/Log4j

 

 

 

 

💻 Slf4j

---

 Slf4j(Simple Logging Facaed for Java) 는 자체적인 로깅 프레임워크가 아닌 logger의 추상체로서 다른 로깅 프레임워크가 접근할 수 있도록 도와주는 추상화 계층입니다. 즉, Log4j나 Logback와 같은 로깅 프레임워크의 인터페이스 역할을 합니다.

따라서 Slf4j를 이용하면 로깅 프레임워크가 다른 구현체로 변경되더라도 코드를 유연하게 수정할 수 있는 장점이 있습니다.

※ 참고: 디자인 패턴 - 퍼사드 패턴(Facade Pattern)

 

출처: http://www.slf4j.org/manual.html

 

 

 

 

💻  Logback

---

 Logback 은 Log4j보다 향상된 로깅 프레임워크로 가장 널리 사용되고 있습니다. 이전에 소개드린  Slf4j 의 구현체로써 동작하는 Logback은 제가 주로 사용하고 있는 스프링부트의 경우 spring-boot-starter-web 의존성 내부에 logback 라이브러리가 기본적으로 포함되어 있기 때문에 추가적인 설정 없이 사용이 가능합니다.

 

 

Logback 예제

의존성 추가

compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
implementation('org.slf4j:jcl-over-slf4j')
implementation('ch.qos.logback:logback-classic')

 

resources 디렉토리 하위에 logback.xml 파일 추가(File)

<?xml version="1.0" encoding="UTF-8"?>

<configuration>

    <!-- 콘솔로 로그를 남김 -->
    <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <charset>UTF-8</charset>
            <Pattern>
                %d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n
            </Pattern>
        </encoder>
    </appender>

    <!-- 파일로 로그를 남김 -->
    <appender name="fileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>/Users/juhyun/Desktop/study/logback.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <Pattern>
                %d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n
            </Pattern>
        </encoder>

        <!-- 로그 파일이 10KB가 넘으면 새로운 로그 파일로 만드는 정책 -->
        <triggeringPolicy
                class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10KB</MaxFileSize>
        </triggeringPolicy>

        <!-- 파일을 덮어쓰는 정책 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <FileNamePattern>/Users/juhyun/Desktop/study/logback2.%i.log.zip</FileNamePattern>
            <!--
                MinIndex, MaxIndex => 로그 파일 정책
                logback2.1.log.zip, logback2.2.log.zip, ...
            -->
            <MinIndex>1</MinIndex>
            <MaxIndex>10</MaxIndex>
        </rollingPolicy>
    </appender>

    <!-- com.juhyun 하위 패키지 -->
    <logger name="com.juhyun"  level="info" additivity="false">
        <appender-ref ref="fileAppender" />
    </logger>

</configuration>

위 파일에 대해 주석을 추가했지만, 간략하게 설명드리겠습니다.

 

<appender name="fileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">

• RollingFileAppender 클래스는 FileAppender 클래스를 상속받으며 로그 파일을 롤오버 하능 기능입니다.

출처: http://logback.qos.ch/manual/appenders.html

 

%d{HH:mm:ss.SSS}

• 로그가 출력되는 시간을 기록하는 설정입니다.

 

[%thread]

• 로그를 출력하는 스레드를 기록합니다.

 

%-5level

• 로그 레벨을 출력합니다.
• -5는 5칸을 차지하는 것을 의미합니다.
  
  

%logger{5}

• 로그를 출력할 java 파일명을 나타내며, {5}은 파일명의 포맷팅 형식입니다.

 

%msg%n

• 메시지와 개행(줄바꿈)을 의미합니다.

 

 

예제 코드

package com.juhyun;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class Logging {
    public static void main(String[] args) {
        log.debug("Logging - Debug log");
        log.info("Logging - Info log");
        log.warn("Logging - Warn log");
        log.error("Logging - Error log");
    }
}

위 코드를 실행해보면 아래와 같이 xml파일에 설정한 경로에 log 파일이 생성되는걸 확인할 수 있습니다.

file에 출력할 로그 레벨을 info로 설정했기 때문에, 하위 레벨인 Debug는 출력이 되지 않습니다.

 

 

 

 

📝  정리

---

이상으로 간략하게 로깅에 대해 정리를 해보았습니다.

다양한 옵션을 추가하면 클래스별로 로그 파일을 남기거나, 로그 레벨을 설정하여 좀 더 정확한 로그를 남길 수 있습니다.

개발을 하며 오류를 해결할 수 있는 가장 중요한 방법 중 하나가 로그를 남기는 것이라고 생각하기 때문에 로그는 최대한 상세히 해당 오류에 대해 남겨주는게 좋다고 생각합니다.

 

 

 

 

References

• https://logging.apache.org/log4j/2.x/
• https://minkwon4.tistory.com/161
• https://logging.apache.org/log4j/2.x/performance.html
• https://www.baeldung.com/log4j-no-appenders-found
• http://www.slf4j.org/manual.html
• http://logback.qos.ch/manual/appenders.html