[java] Log4j의 로그 필터 패턴 설정 방법

23 Nov 2023

java

Log4j는 자바에서 로깅을 위해 널리 사용되는 라이브러리입니다. 로깅 필터는 로그 이벤트를 필터링하여 원하는 조건에 맞는 로그만 기록하도록 설정할 수 있습니다. 이 글에서는 Log4j의 로그 필터 패턴 설정 방법에 대해 알아보겠습니다.

1. 로그 필터 패턴 소개

로그 필터 패턴은 로그 이벤트의 특정 속성과 비교하여 해당 속성을 가진 이벤트만 필터링하는 기능입니다. 일반적으로 로그 이벤트의 레벨, 메시지, 클래스명, 메소드명 등을 기반으로 필터링할 수 있습니다.

2. Log4j XML 파일 수정

Log4j를 사용하기 위해서는 먼저 Log4j XML 파일을 수정해야 합니다. 아래는 예시로 Log4j XML 파일의 내용입니다.

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%-5level] [%thread] %logger{1} - %msg%n" />
    </Console>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="Console" />
    </Root>
  </Loggers>
</Configuration>

3. 로그 필터 패턴 추가

로그 필터 패턴을 추가하기 위해서는 <Appender> 태그 내에 <Filters> 태그를 추가하고 필터를 정의해야 합니다. 아래는 예시로 필터 패턴을 추가한 Log4j XML 파일의 내용입니다.

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%-5level] [%thread] %logger{1} - %msg%n" />
      <Filters>
        <ThresholdFilter level="info" onMatch="ACCEPT" />
      </Filters>
    </Console>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="Console" />
    </Root>
  </Loggers>
</Configuration>

위 예제에서는 <ThresholdFilter>를 사용하여 로그 레벨이 info 이상인 로그만 필터링하도록 설정하였습니다. level 속성을 이용하여 필터링할 로그 레벨을 지정할 수 있으며, onMatch 속성을 통해 필터 조건과 일치할 때 로그를 기록할지 거부할지를 설정할 수 있습니다.

4. 다양한 로그 필터 패턴 사용하기

Log4j에서는 로그 메시지, 로거 이름, 스레드 이름, 클래스 이름, 메소드 이름 등 다양한 속성을 이용하여 로그 필터 패턴을 설정할 수 있습니다. 필요한 속성에 따라 필터 패턴을 추가하고 원하는 조건에 맞게 로그를 필터링할 수 있습니다.

예를 들어, 아래의 예시는 로그 메시지에 특정 단어가 포함된 경우만 필터링하는 필터 패턴 설정 방법입니다.

<Filters>
  <RegexFilter regex=".*error.*" onMatch="ACCEPT" />
</Filters>

위 예시에서는 <RegexFilter>를 사용하여 로그 메시지에 “error”라는 단어가 포함된 경우만 필터링하도록 설정하였습니다. 필요한 조건에 따라 로그 필터 패턴을 설정하여 원하는 로그만을 기록할 수 있습니다.

참고 자료

Log4j 2 - Filtering

이 글에서는 Log4j의 로그 필터 패턴 설정 방법에 대해 알아보았습니다. 로그 필터 패턴을 사용하면 로그 이벤트를 조건에 맞게 필터링하여 원하는 로그만을 기록할 수 있습니다. Log4j의 필터링 기능을 적절히 활용하여 개발 및 운영시 유용한 로그를 추출할 수 있습니다.