로깅(Logging)

로깅(Logging)이란 프로그램 개발이나 운영 시 발생하는 문제점을 추적하거나 운영 상태를 모니터링 하기 위한 텍스트 형태의 데이터를 말합니다.

자카르타 Commons 로깅

아파치 그룹의 자카르타 commons-logging 팩키지는 개발자들에게 공통 로깅 API를 제공하기 위해 만들어진 프레임워크로 애플리케이션이 특정 로깅 API에 종속되는 것을 막아줍니다. 현재 많은 서드 파티 로깅 프레임워크들이 commons-logging 기반으로 구현되어 있습니다.

commons-logging 사용법

http://commons.apache.org/downloads/download_logging.cgi 에서 commons-logging.jar 파일을 다운로드합니다.
commons-logging 은 자체적으로 로깅을 지원한다기보다는 여러 로깅 API를 표준화된 방법으로 사용할 수 있게 해주는 개념이기 때문에, 실제 로깅 처리 를 위한 별도의 로깅 구현 솔루션이 필요합니다. 대표적으로 Log4j가 있습니다.
기본적으로 포함되어 있는 로깅 구현체는 SimpleLog 클래스로, 콘솔을 이용한 출력만을 지원합니다.

설정은 주로 프로퍼티 파일을 이용한 방법을 사용하는데 여기서는 Log4j 를 이용하도록 설정한 예입니다.
각각의 프로퍼티 파일을 CLASSPATH 가 잡힌 곳에 생성합니다. Log4j 를 사용하기 위해서는
http://logging.apache.org/log4j/1.2/download.html 에서 Log4j 바이너리 파일을 다운로드 한 후 jar 파일을 프로젝트에 추가해야 합니다.

commons-logging.properties

org.apache.commons.logging.Log = org.apache.commons.logging.impl.Log4JLogger

log4j.properties

log4j.rootLogger = DEBUG,console,file
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.layout = org.apache.log4j.SimpleLayout

log4j.appender.file = org.apache.log4j.FileAppender
log4j.appender.file.File = c:/debug.log
log4j.appender.file.layout = org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern = %5p [%t] (%F:%L) - %m%n

로깅 프로퍼티 속성 설명

Logger(Category) : 로깅 메세지를 Appender에 전달
Appender : 전달된 로깅 메세지의 출력 대상을 지정
Layout : Appender가 어디에 출력할 것인지 결정했다면 어떤 형식으로 출력할 것이지 출력 layout을 결졍

log4j.properties 속성 설명

log4j.rootLogger : 최상위 로그 설정으로, 로그레벨, Appender 지정
log4j.appender.xxx : rootLogger에서 설정한 Appender 이름(xxx)에 대한 실질적인 클래스 지정
log4j.appender.xxx.layout : 해당 Appender 를 통해 출력되는 로그 메시지 형태를 관리할 Layout 클래스 지정

Log 처리 메시지 및 로그 레벨

FATAL : 가장 심각한 오류, 콘솔에 출력
ERROR : 일반적인 오류, 콘솔에 출력
WARN : 주의를 요하는 경우, 콘솔에 출력
INFO : 런타임 시 관심있는 이벤트, 콘솔에 출력
DEBUG : 시스템 흐름과 관련된 상세정보, 로그 파일로만 출력
TRACE : 가장 상세한 형태의 정보, 로그 파일로만 출력

Log4j Appender 주요 클래스

ConsoleAppender : 콘솔에 로그 메시지 출력
FileAppender : 파일에 로그 메시지 기록
RollingFileAppender : 파일에 로그 메시지 기록하고, 파일 크기가 일정 수준 이상이 되면 다른 이름의 새파일을 생성하고 기록
DailyRollingFileAppender : 파일에 로그 메시지 기록하고, 하루 단위로 로그 파일을 변경해서 기록
SMTPAppender : 로그 메시지를 이메일로 전송
NTEventAppender : 윈도우즈 시스템 이벤트 로그로 메시지 전송

Log4j Layout 클래스

DateLayout : 로그 메시지를 날짜 중심으로 간단하게 기록
HTMLLayout : 로그 메시지를 HTML 형식으로 기록
PatternLayout : 로그 메시지를 사용자 정의 패턴에 따라 기록
SimpleLayout : 레벨-메시지 형식의 가장 간단하게 로그 기록
XMLLayout : 로그 메시지를 XML 형식으로 기록

Log4j PatternLayout 형식

%c : 카테고리를 출력
%p : 로깅 레벨을 출력
%m : 로그 내용
%d : 로깅 이벤트가 발생한 시간, yyyy-MM-dd, HH:mm:ss 등 시간 형식을 사용
%t : 로깅 이벤트를 발생한 스레드의 이름
%% : %
%n : 개행
%C : 클래스 이름
%F : 로깅이 발생한 파일 이름
%I : 로깅이 발생한 호출자 정보
%L : 로깅이 발생한 라인수
%M : 로깅이 발생한 메소드 이름
%r : 애플리케이션 시작 이후부터 로깅이 발생한 시점의 시간
%x : 로깅이 발생한 스레드와 과련된 NDC
%X : 로깅이 발생한 스레드와 과련된 MDC

자카르타 commons 로깅 API 사용법

// 팩키지 import 
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

.. 중간 생략 ..

// Log 클래스 레퍼런스 구하기
Log log = LogFactory.getLog(NamecardDAO.class);

.. 중간 생략 ...

// 로깅 사용
if ( log.isDebugEnabled() ) {
  //log.debug( "Error Source:NamecardDAO.addNamecard(Namecard) : SQLException" );
  log.debug( "SQLState : " + e.getSQLState() );
  log.debug( "Message : " + e.getMessage() );
  log.debug( "Oracle Error Code : " + e.getErrorCode() );
  log.debug( "Query : " + sql );
}