[java] Log4j의 XML 설정 파일

23 Nov 2023

java

Log4j은 자바 애플리케이션의 로깅을 위한 인기 있는 라이브러리입니다. Log4j을 사용하여 애플리케이션의 로그를 관리하고 출력을 구성할 수 있습니다. 이를 위해 Log4j은 XML 형식의 설정 파일을 사용합니다. 이 포스트에서는 Log4j의 XML 설정 파일 작성에 대해 알아보겠습니다.

Log4j의 XML 설정 파일 구조

Log4j의 XML 설정 파일은 다음과 같은 구조를 가지고 있습니다.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

   <!-- Output Appenders -->
   <appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
      <param name="Target" value="System.out" />
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%-5p %c{1}:%L - %m%n" />
      </layout>
   </appender>

   <!-- Loggers -->
   <logger name="com.example">
      <level value="DEBUG" />
   </logger>

   <!-- Root Logger -->
   <root>
      <level value="INFO" />
      <appender-ref ref="CONSOLE" />
   </root>

</log4j:configuration>

위의 코드는 기본적인 Log4j 설정 파일의 예시입니다. 설정 파일은 <log4j:configuration> 요소로 시작하고, <!DOCTYPE> 선언과 네임스페이스 선언이 따라옵니다.

appender: 출력 앱던더를 정의하는 요소입니다. 여기서는 ConsoleAppender를 사용하여 콘솔에 로그를 출력하도록 설정되어 있습니다.
logger: 로그를 기록할 클래스나 패키지를 정의하는 요소입니다. 여기서는 com.example 패키지의 로그레벨을 DEBUG로 설정하고 있습니다.
root: 기본 로거를 정의하는 요소입니다. 여기서는 로그레벨을 INFO로 설정하고, CONSOLE 앱던더를 참조하도록 설정되어 있습니다.

설정 파일 작성 가이드라인

Log4j의 XML 설정 파일을 작성할 때는 다음 가이드라인을 따르는 것이 좋습니다.

파일 이름: 설정 파일은 보통 log4j.xml 또는 log4j2.xml로 저장합니다.
파일 위치: 설정 파일은 애플리케이션 클래스패스 루트 또는 설정 파일을 명시적으로 지정하는 옵션을 사용하여 애플리케이션과 함께 배포되는 것이 좋습니다.
설정 요소: 설정 파일은 여러 <appender>, <logger>, <root> 요소를 포함할 수 있습니다. 적절한 요소를 사용하여 로깅 출력을 구성하고 로거를 설정하세요.
로그레벨: 각 로거 또는 앱던더에는 로그레벨을 설정할 수 있습니다. DEBUG, INFO, WARN, ERROR 등 다양한 레벨을 사용할 수 있으며, 로그레벨에 따라 출력이 결정됩니다.

Log4j의 XML 설정 파일 구조

설정 파일 작성 가이드라인

참고 자료