Logging설정 for JEUS5
소개
이 문서는 JEUS 5의 웹 관리자를 사용한 logging 설정 방법 및 customization 방법, log4j 사용법 등을 설명한다.
기본logger 파일
최초 JEUS 설치 시, JEUS log는 default로 console handler를 사용하기 때문에 JEUS manager와 모든 engine container의 log message가 stdout형태로 출력된다. 또한 web container 의 access log가 $JEUS_HOME/logs/<노드명>/<노드명>_<컨테이너명>/servlet/accesslog/access.log 에 출력 된다.
웹관리자접속
웹 관리자에 접속하는 방법은 다음과 같다. 웹 관리자는 JEUS_BASEPORT + 8 의 포트를 사용하므로 JEUS_BASEPORT 가 default 로 9736이므로 웹 관리자는 9744를 사용하고, 해당 Port에 대해 방화벽이 열려 있어야 한다.
http://IPAddress:9744/webadmin/
웹 관리자로 log 설정하기
1. JEUS Server log 설정
웹관리자접속후노드명을선택하면오른쪽화면에서에러로그설정항목을볼수있다.
로거추가를 선택하면 logging level 설정 화면이 나오는데, logging level 은 다음과 같다.
FATAL<NOTICE<INFORMATION<DEBUG<SEVERE<WARNING<INFO<CONFIG<FINE<FINER<FINEST<ALL
– default level 은 INFO
– 개발자는보통 FINE
logging level 선택 후 확인을 누르면 아래와 같이 jeus logger가 추가된 것을 볼 수 있다.
추가된 jeus logger를 선택하면 로그핸들러 생성화면을 볼 수 있는데, 핸들러의 종류는 다음과 같다.
console-handler, file-handler, smtp-handler, socket-handler, user-handler
– default 는 console-handler
사용하고자 하는 핸들러를 선택하면 아래와 같이 새 로그 핸들러 생성 화면이 나타난다. 각 항목 확인 후 생성버튼을 누르면 JEUS Server log 가 생성된다.
웹관리자에서 생성한 JEUS Server log 는 $JEUS_HOME/config/<노드명>/JEUSMain.xml 에 xml 형태로 추가된다.
<<JEUSMain.xml>>
<jeus-system xmlns=”http://www.tmaxsoft.com/xml/ns/jeus”>
<node>
…
<system-logging>
<level>INFO</level>
<handler>
<file-handler>
<name>handler1</name>
<level>FINEST</level>
<valid-day>1</valid-day>
</file-handler>
</handler>
</system-logging>
위와 같이 file-handler, 1일 단위로 생성했을 경우 log 는, $JEUS_HOME/logs/<노드명> 에 JeusServer_<날짜>.log 형식으로 남게 된다. <system-logging><level>의 log level은 <handler>에서 설정한 <level> 보다 우선한다. log 를 실시간으로 확인하기 위해서 tail 명령어를 사용하거나,
test:/home/main/jeus5/logs/test> tail -f JeusServer_<날짜>.log
또는 사용자 profile 에 아래와 같이 alias 를 설정하는 방법이 있다.
alias jlog=’tail -f ${JEUS_HOME}/logs/`hostname`/JeusServer_`date +%Y%m%d`.log’
2. Container log 설정
Container log 는 Container 마다 별도로 log를 관리 할 수 있다는 장점이 있다.
Container log설정은 위와 마찬가지로 웹 관리자를 사용한다. 웹 관리자에 접속 후 컨테이너명을 선택하면 오른쪽 화면에서 에러 로그 설정 항목을 볼 수 있다.
logging 설정은 JEUS Server log 설정을 참고한다.
웹관리자에서 생성한 Container log는 $JEUS_HOME/config/<노드명>/JEUSMain.xml 에 xml 형태로 추가된다.
<<JEUSMain.xml>>
<jeus-system xmlns=”http://www.tmaxsoft.com/xml/ns/jeus”>
<node>
<name>test</name>
<engine-container>
<name>container1</name>
…
<system-logging>
<level>INFO</level>
<handler>
<file-handler>
<name>handler1</name>
<level>FINE</level>
<valid-day>1</valid-day>
</file-handler>
</handler>
</system-logging>
</engine-container>
Container log 를 file-handler, 1일 단위로 생성했을 경우 log 는, $JEUS_HOME/logs/<노드명>/<노드명>_<컨테이너명> 에 <노드명>_<컨테이너명>_<날짜>.log 형식으로 남게 된다. <system-logging><level>의 log level은 <handler>에서 설정한 <level> 보다 우선한다. log 를 실시간으로 확인하기 위해 tail 명령어를 사용하거나 사용자 profile 에 아래와 같이 alias 를 설정하는 방법이 있다.
alias clog=’tail -f ${JEUS_HOME}/logs/`hostname`/`hostname`_container1/`hostname`_container1_`date +%Y%m%d`.log’
Container log에서 ConsoleHandler 를 사용할 경우 Console로 외의 JEUS Server log에 같이 출력 된다.
JEUS logging 패턴
JEUS logging 은 JDK1.4에서 포함된 java.util.logging 패키지에 있는 Logging API를 따른다. JEUS의 logging 환경은 JEUS_HOME/bin/logging.properties 에 설정되어 있다. logging.propertis 를 보면 JEUS는 default 로 ConsoleHandler 를 사용하고, logging level 은 INFO 임을 알 수 있다. handler 를 추가할 경우는 다음과 같이 콤마로 분리한다.
handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler
또한 console 에 출력되는 log level 은 아래의 항목에서 지정할 수 있다.
java.util.logging.ConsoleHandler.level = FINE
FileHandler 를 사용할 경우, log는 기본적으로 사용자 홈 디렉토리에 출력되지만 경로나 출력 포맷 (XMLFormatter or SimpleFormatter)등을 지정할 수 있다.
java.util.logging.FileHandler.pattern = /home/main/MyLog.log
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
ConsoleHandler도 마찬가지로 log level 과 출력 포맷을 지정할 수 있고, 특정 class 에서의 log level 설정도 가능하다.
아래는 logging.properties 에 설정한 각 항목을 테스트 할 수 있는 예이다.
<<shbean.jsp>>
<%
com.SHBean a = new com.SHBean();
%>
<<SHBean.java>>
package com;
import java.util.logging.*;
public class SHBean{
Logger logger = null;
public SHBean(){
logger = Logger.getLogger(getClass().getName());
logger.setLevel(Level.FINEST);
logger.info(“info test”);
logger.severe(“severe test”);
logger.fine(“fine test”);
logger.finest(“finest test”);
}
}
logging.properties 를 아래와 같이 설정할 경우,
<<logging.properties>>
handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler
java.util.logging.FileHandler.pattern = /home/star/MyLog.log
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
java.util.logging.ConsoleHandler.level = FINE
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
…
아래와 같은 결과를 얻을 수 있다.
<<JeusServer_20080404.log>>
…
<<JeusServer_20080404.log>>
2008. 4. 4오후 6:11:16 com.SHBean <init>
정보: info test
2008. 4. 4오후 6:11:16 com.SHBean <init>
심각: severe test
2008. 4. 4오후 6:11:16 com.SHBean <init>
자세히: fine test
access log 비활성화
별도의 설정이 없을 경우 Web Container당 1개의 access-log 가 생성된다. access log 에는 Context Group에 대한 모든 요청과 사용자 접근에 관한 log가 남는다. access log의 기본 위치는, $JEUS_HOME/logs/<노드명>/<노드명>_<컨테이너명>/servlet/accesslog/<GroupName>/access.log가 기본 log file이다.
그런데 접근이 빈번한 사이트에서는 access log의 양이 클 수가 있으므로 access logging 기능을 사용하지 않는 것이 좋다. access log는 default 가 true 이기 때문에, $JEUS_HOME/config/<노드명>/<노드명>_servlet_<엔진명>/WEBMain.xml 에서 설정을 변경 할 수 있다. 아래와 같이 <logging><access-log><enable>을 false 로 하면 된다.
<<WEBMain.xml>>
<web-container xmlns=”http://www.tmaxsoft.com/xml/ns/jeus”>
<context-group>
…
<logging>
<access-log>
<enable>false</enable>
…
참고해야 할 사항은 access log 는 <valid-day> 를 명시하지 않으면 하나의 파일에 남기 때문에 1일 단위로 출력하기 위해서는 위의 태그를 명시해야 한다.
log 파일경로변경
1. log home 변경
log home디렉토리 위치 변경은 $JEUS_HOME/bin/jeus 에서 -Djeus.log.home 을 추가하고 원하는 log 위치를 명시한다.
-Djeus.log.home=/home/main/logs
2. handler가 사용할 file name설정
JEUS 4 버전까지는 전체적인 log home 경로 변경만 가능하였지만, JEUS 5에서는 사용자가 세부적인 log에 대한 위치를 정할 수 있다. 다음과 같이<file-name>태그를 통하여 handler가 사용할 file name을 설정할 수 있다.
<<JEUSMain.xml>>
<jeus-system xmlns=”http://www.tmaxsoft.com/xml/ns/jeus”>
<node>
…
<system-logging>
<level>INFO</level>
<handler>
<file-handler>
<name>handler1</name>
<level>FINEST</level>
<valid-day>1</valid-day>
<file-name>7/home/main/Mylog.log</file-name>
</file-handler>
</handler>
</system-logging>
log4j API를이용한 logging
JEUS에서 log4j를 사용할 경우 log4j-1.xxx.jar 파일은 위치는 통상적으로 다음 경로에 올 수 있다.
– $JEUS_HOME/lib/application … ①
– context 아래의 WEB-INF/lib … ②
– 임의의경로 : /home/main/log4j/log4j-1.xxx.jar
임의의경로에넣을경우, JEUSMain.xml 의 <user-class-path> 태그에위경로를설정함 … ③
그리고 log4j.properties는 classpath에 포함되는 디렉토리에 위치시키는데 다음과 같이 올 수 있다.
– $JEUS_HOME/lib/application … ①
– context 아래의 WEB-INF/classes … ②
– 파일위치 : /home/main/log4j/log4j.properties
임의의경로에넣을경우, JEUSMain.xml 의 <user-class-path> 태그에위경로를설정함 … ③
예를 들어 ①과 ② 경로에 모두 log4j.properties 가 있는 경우 ①의 위치한 log4j.properties 가 실행된다.
log4j.properties 에서 아래와 같이 로그파일의 경로를 상대경로로 설정할 경우, JEUS를 restart 할 때마다 파일의 위치는 가변적이다. 즉, restart 한 시점의 경로에 로그파일이 발생하게 된다.
<<log4j.properties>>
…
log4j.appender.dailyfile.Threshold = DEBUG
log4j.appender.dailyfile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyfile.File = logfile.log
log4j.appender.dailyfile.layout = org.apache.log4j.PatternLayout
