[java] SLF4J에서 로그 메시지 필터 요구 사항 적용

30 Nov 2023

java

SLF4J는 자바 프로그램에서 로그를 기록하기 위한 인터페이스를 제공하는 일반적으로 사용되는 로깅 라이브러리입니다. 로그 메시지 필터링은 특정 조건에 따라 로그 메시지를 필터링하고 기록할 수 있도록 함으로써 로그 파일의 크기를 제어하고, 중요한 로그만 볼 수 있는 등의 기능을 제공합니다.

이 글에서는 SLF4J에서 로그 메시지 필터링을 적용하는 방법에 대해 알아보겠습니다.

필터링을 위한 의존성 추가

먼저, SLF4J에서 제공하는 로그 메시지 필터링을 사용하기 위해서는 해당 기능을 지원하는 의존성을 추가해야 합니다.

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-ext</artifactId>
    <version>1.7.30</version>
</dependency>

위의 Maven 의존성 설정을 프로젝트의 pom.xml 파일에 추가해주세요.

로그 메시지 필터링 설정

다음으로, 로그 메시지 필터링을 적용하기 위해 SLF4J의 logback.xml 설정 파일을 수정해야 합니다.

<configuration>
    <!-- 일반적인 로그 설정 -->
    
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 로그 메시지 필터링 설정 -->
        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
            <evaluator>
                <!-- 필터 조건 설정 -->
                <expression>
                    message.contains("ERROR")
                </expression>
            </evaluator>
            <!-- 필터를 통과한 로그 메시지만 출력 -->
            <OnMismatch>NEUTRAL</OnMismatch>
            <OnMatch>DENY</OnMatch>
        </filter>
    </appender>
    
    <!-- 추가적인 설정 -->
    
</configuration>

위의 설정 파일에서 <expression> 태그 안에 원하는 로그 메시지 필터링 조건을 작성할 수 있습니다. 이 예시에서는 “ERROR”라는 문자열이 포함된 로그 메시지만 필터링되며, 필터를 통과한 경우에는 출력되지 않습니다.

필터링된 로그 메시지 확인

이제 필터링된 로그 메시지가 제대로 동작하는지 확인해보겠습니다. 아래의 예시 코드를 사용하여 로그 메시지를 기록해보세요.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ExampleClass {
    private static final Logger logger = LoggerFactory.getLogger(ExampleClass.class);

    public void logMessages() {
        logger.info("This is an info log message.");
        logger.debug("This is a debug log message.");
        logger.error("This is an error log message.");
    }
    
    public static void main(String[] args) {
        ExampleClass example = new ExampleClass();
        example.logMessages();
    }
}

위의 예시 코드에서는 세 가지 종류의 로그 메시지를 기록하고 있습니다. 필터링 조건으로 “ERROR”를 설정했으므로, “This is an error log message.”만 로그로 출력될 것입니다.

상기한 설정과 예시 코드를 참고하여 SLF4J에서 로그 메시지 필터링을 적용해보세요. 필터링된 로그 메시지는 특정 조건에 따라 단순화된 로그 파일을 생성하고 중요한 정보에 집중할 수 있도록 도와줄 것입니다.

필터링을 위한 의존성 추가

로그 메시지 필터링 설정

필터링된 로그 메시지 확인

참고 자료