Log4J 사용법

1. LOG4J 구조

일단 log4j를 잘 모르지만 그 구조만 살짝 살펴보고 넘어갑시다
log4j는 크게 3가지 요소로 구성되며 그 구조는 다음과 같습니다

① Logger(Category) : 로그의 주체 (로그 파일을 작성하는 클래스)
     
     로깅 메세지를 Appender에 전달합니다.
     Log4j의 심장부에 위치하며, 개발자가 로그출력 여부를 런타임에 조정되도록 해준다.
     Logger는 로그레벨을 가지고 있으며, 로그의 출력여부는 로그문의 레벨과 로거의 레벨을 가지고 결정된다.

     어플리케이션을 작성하기전 어떤 로거를 사용해야 할지 정해야 한다.
     ex) static Logger logger = Logger.getLogger(SimpleLog.class);

     [참고] Commons-Logging 는 레퍼클래스도 존재함

② Appender : 로그를 출력하는 위치

     전달된 로깅 메세지를 파일에다 기록할 것인지, 콘솔에 출력할 것인지
     아니면 DB에 저장할 것인지 매개체 역활을 합니다.

     Log4J API문서의 XXXAppender로 끝나는 클래스들의 이름을 보면,
     출력위치를 어느정도 짐작할 수 있다.

     http://logging.apache.org/log4j/docs/api/index.html

③ Layout : Appender의 출력포맷

　　Appender가 어디에 출력할 것인지 결정했다면 어떤 형식으로 출력할 것이지
　　출력 layout을 결졍합니다.

　　일자, 시간, 클래스명등 여러가지 정보를 선택하여 로그정보내용으로 지정할 수 있다.
　　자세한 패턴은 아래의 클래스정보를 살펴보면 알수있다.

　　※ Layout의 종류

  　　  1) DateLayout
 　　   2) HTMLLayout
 　　   3) PatternLayout ( 일반적으로 PatternLayout을 사용하는 것이 디버깅에 가장 적합함 )
  　　  4) SimpleLayout
  　　  5) XMLLayout

2. LOG4J 로깅 레벨

log4j는 다양한 로깅레벨을 지원합니다.

① FATAL : 가장 크리티컬한 에러가 일어 났을 때 사용합니다.
② ERROR : 일반 에러가 일어 났을 때 사용합니다.
③ WARN : 에러는 아니지만 주의할 필요가 있을 때 사용합니다.
④ INFO : 일반 정보를 나타낼 때 사용합니다.
⑤ DEBUG : 일반 정보를 상세히 나타낼 때 사용합니다.

레벨을 설정하면 그 이상의 레벨만 로깅하게 된다.
예를 들어 INFO로 설정한 경우 INFO, WARN, ERROR, FATAL이 로깅된다.

3. 샘플코드

파일명 : TestServlet.java

import javax.servlet.*;
import javax.servlet.http.*;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class TestServlet extends HttpServlet {
    static Logger logger = Logger.getLogger(TestServlet.class);

    public void init(ServletConfig config) throws ServletException {
         super.init(config);
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
         try {
              ...
              logger.info("Hellow World~");
              ...

          } catch (Exception e) {
              logger.error("Error at TestServlet", e);
          }
     }
}

4. LOG4J 설정

log4j.properties를 만들어 /WEB-INF/classes 밑에 놓으세요

파일명 : log4j.properties

log4j.rootLogger=INFO, stdout, rolling
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %-5p [%t] %-17c{2} (%13F:%L) %3x - %m%n
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=output.log
# 기본 경로는 %CATALINA_HOME%bin 디렉토리이다.
# 경로를 바꾸고 싶을 때에는 다음과 같이 C:/web/WEB-INF/logs/ssg.log 바꾼다.
log4j.appender.file.Append=true
log4j.appender.file.MaxFileSize=500KB
log4j.appender.file.DatePattern='.'yyyy-MM-dd
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d %-5p [%t] %-17c{2} (%13F:%L) %3x - %m%n

** 설명

#최상위 카테고리에 INFO로 레벨 설정 및 appender로 stdout, file을 정의
log4j.rootLogger=INFO, stdout, file

#stdout 어펜더는 콘솔에 뿌리겠다는 정의
log4j.appender.stdout=org.apache.log4j.ConsoleAppender

#stdout 어펜더는 patternlayout을 사용하겠다는 정의
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

#페턴은 다음과 같이 포맷팅 하겠다는 것을 정의
log4j.appender.stdout.layout.ConversionPattern=%d %-5p [%t] %-17c{2} (%13F:%L) %3x - %m%n

#역시나 rolling 어펜더는 파일로 처리한다라고 정의
log4j.appender.rolling=org.apache.log4j.RollingFileAppender

#로그 파일 이름은 output.log
log4j.appender.rolling.File=output.log

#true면 톰캣을 내렸다 올려도 파일이 리셋되지 않습니다.
log4j.appender.rolling.Append=true

#파일 최대 사이즈는 500KB로 설정
log4j.appender.rolling.MaxFileSize=500KB

#파일 포맷은 output.log.2005-03-10 으로 관리하겠다고 정의
log4j.appender.rolling.DatePattern='.'yyyy-MM-dd

#역시나 rolling 어펜더는 패턴 레이아웃을 사용하겠다고 정의
log4j.appender.rolling.layout=org.apache.log4j.PatternLayout

#rolling 어펜더는 패턴 레이아웃 포맷
log4j.appender.rolling.layout.ConversionPattern=%d %-5p [%t] %-17c{2} (%13F:%L) %3x - %m%n

☆☆☆☆☆☆☆☆☆☆☆☆☆
log4j.xml 관련 내용 추가 예정
☆☆☆☆☆☆☆☆☆☆☆☆☆


5. 설정 포맷

① 로그파일명 포맷 (DatePattern)

로그파일명 포맷입니다. 날짜, 시간 및 분단위로까지 로그 파일을 분리할 수 있습니다.
  
   ※ 형식 설명
      '.'yyyy-MM 매달 첫번째날에 로그파일을 변경합니다 
      '.'yyyy-ww 매주의 시작시 로그파일을 변경합니다.  
      '.'yyyy-MM-dd 매일 자정에 로그파일을 변경합니다. 
      '.'yyyy-MM-dd-a 자정과 정오에 로그파일을 변경합니다. 
      '.'yyyy-MM-dd-HH 매 시간의 시작마다 로그파일을 변경합니다.
      '.'yyyy-MM-dd-HH-mm 매분마다 로그파일을 변경합니다. 

② PatternLayout 포맷

로그자체를 어떤 포맷으로 남길지 결정합니다.
layout에는 HTMLLayout, PatternLayout, SimpleLayout, XMLLayout등이 있으며
PatternLayout이 일반적으로 가장 많이 쓰입니다.

형식	설명
%p	debug, info, warn, error, fatal 등의 priority 가 출력된다.
%m	로그내용이 출력됩니다
%d	로깅 이벤트가 발생한 시간을 기록합니다. 포맷은 %d{HH:mm:ss, SSS}, %d{yyyy MMM dd HH:mm:ss, SSS}같은 형태로 사용하며 SimpleDateFormat에 따른 포맷팅을 하면 된다
%t	로그이벤트가 발생된 쓰레드의 이름을 출력합니다.
%%	% 표시를 출력하기 위해 사용한다.
%n	플랫폼 종속적인 개행문자가 출력된다. \r\n 또는 \n 일것이다.
%c	카테고리를 표시합니다 예) 카테고리가 a.b.c 처럼 되어있다면 %c{2}는 b.c가 출력됩니다.
%C	클래스명을 포시합니다. 예) 클래스구조가 org.apache.xyz.SomeClass 처럼 되어있다면 %C{2}는 xyz.SomeClass 가 출력됩니다
%F	로깅이 발생한 프로그램 파일명을 나타냅니다.
%l	로깅이 발생한 caller의 정보를 나타냅니다
%L	로깅이 발생한 caller의 라인수를 나타냅니다
%M	로깅이 발생한 method 이름을 나타냅니다.
%r	어플리케이션 시작 이후 부터 로깅이 발생한 시점의 시간(milliseconds)
%x	로깅이 발생한 thread와 관련된 NDC(nested diagnostic context)를 출력합니다.
%X	로깅이 발생한 thread와 관련된 MDC(mapped diagnostic context)를 출력합니다.

예시) (같은 색끼리 보시면 됩니다)

위의 test.jsp를 다음 포맷으로 출력해본다면
[%c] [%C] [%d] [%F] [%l] [%L] [%m] [%M] [%n] [%p] [%r] [%t] [%x] [%X]는 다음과 같다

[test.jsp] [org.apache.jsp.test_jsp] [2005-03-10 12:37:23,561] [test_jsp.java] [org.apache.jsp.test_jsp._jspService(test_jsp.java:64)] [64] [fatal!!] [_jspService] [개행] [FATAL] [765567] [http-8080-Processor25] [] []

[출처 : http://www.ssial.com/162]