※ 들어가기에 앞서, Spring Framework, maven, jboss(wildfly) 환경에서 log4j설정하는 법은 이곳을 참고.
log4j.xml 파일을 아래와 같이 설정한다.
※ pom.xml 및 기타 설정은 되어있다 가정
[log4j.xml]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<Console name="console" target="SYSTEM_OUT">
<PatternLayout pattern="%-5p: %c - %m%n" />
</Console>
</Appenders>
<Loggers>
<Root level="INFO">
<AppenderRef ref="console" />
</Root>
</Loggers>
</Configuration>
|
cs |
위에 설정한 콘솔 로그를 출력하기 위해 아래와 같이 Sample.class 를 만들어준다.
[Sample.class]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
package com.log;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Sample {
protected static final Logger logger = LoggerFactory.getLogger(Sample.class);
protected static final Logger fileLogger = LoggerFactory.getLogger("fileLogger");
public static void main(String[] args) {
logger.info("Sample.class logger print with info level");
fileLogger.info("fileLogger logger print with info level");
}
}
|
cs |
"fileLogger 를 name 으로 하는 logger 가 없는데?" 라는 생각이 들겠지만 일단 main 메소드를 실행시켜보자.
[Sample.class 실행결과]
INFO : com.log.Sample - Sample.class logger print with info level
INFO : fileLogger - fileLogger logger print with info level
Exception을 찍거나, 혹은 아무것도 찍지 않을 줄 알았던 fileLogger.info(~); 가 로그를 정상적으로 찍고 있다.
이를 이해하려면 log4j 의 위계구조 (hierarchy) 에 대한 이해가 필요하다.
[log4j 위계구조 (hierarchy)]
1. 모든 로거의 최상위 부모는 Root 로거이다.
2. class 에서 로그를 출력하는데 사용된 logger가 log4j.xml 에 존재하지 않는다면, 부모 로거를 찾는다.
: Sample.class 9번 라인의 fileLogger 는 "fileLogger" 라는 name을 갖는 로거를 log4j.xml 에서 찾았으나, 해당 이름의 로거가 존재하지 않으므로 부모인 Root 로거를 타게된 것. (마찬가지 이유로, Sample.class 에서 8번라인의 ~.getLogger(Sample.class) 부분을 ~.getLogger("") 과 같이 바꿔도 로거는 정상출력된다)
이번엔 log4j 를 다음과 같이 수정 후, 위의 Sample.class 메인메소드를 다시 실행해보자.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<Console name="console" target="SYSTEM_OUT">
<PatternLayout pattern="%-5p: %c - %m%n" />
</Console>
</Appenders>
<Loggers>
<Logger name="com" level="INFO" >
<AppenderRef ref="console" />
</Logger>
<Logger name="com.log" level="INFO" >
<AppenderRef ref="console" />
</Logger>
<Logger name="com.log.Sample" level="INFO" >
<AppenderRef ref="console" />
</Logger>
<Root level="INFO">
<AppenderRef ref="console" />
</Root>
</Loggers>
</Configuration>
|
cs |
[실행 결과]
INFO : com.log.Sample - Sample.class logger print with info level
INFO : com.log.Sample - Sample.class logger print with info level
INFO : com.log.Sample - Sample.class logger print with info level
INFO : com.log.Sample - Sample.class logger print with info level
INFO : fileLogger - fileLogger logger print with info level
com.log 패키지 경로에 있는 Sample.class (Sample.class 의 1번라인 참고)는 자신의 클래스명과 일치하는 name을 가진 Logger를 찾는다.
com.log.Sample 로거의 appender 로 로그가 찍히고,
com.log 로거의 appender 로 로그가 찍히고,
com 로거의 appender 로 로그가 찍히고,
Root 로거의 appender 로 로그가 찍혀 총 4번의 로그가 찍혔다. (fileLogger 제외)
(부모 > Root > com > com.log > com.log.Sample > 자식)
이번엔 아래와 같이 com.log 로거에 additivity="false" 속성을 추가해보자
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<Console name="console" target="SYSTEM_OUT">
<PatternLayout pattern="%-5p: %c - %m%n" />
</Console>
</Appenders>
<Loggers>
<Logger name="com" level="INFO" >
<AppenderRef ref="console" />
</Logger>
<Logger name="com.log" level="INFO" additivity="false">
<AppenderRef ref="console" />
</Logger>
<Logger name="com.log.Sample" level="INFO" >
<AppenderRef ref="console" />
</Logger>
<Root level="INFO">
<AppenderRef ref="console" />
</Root>
</Loggers>
</Configuration>
|
cs |
[실행결과]
INFO : com.log.Sample - Sample.class logger print with info level
INFO : com.log.Sample - Sample.class logger print with info level
INFO : fileLogger - fileLogger logger print with info level
com.log.Sample 로거의 appender 로 로그가 찍히고,
com.log 로거의 appender 로 로그가 찍히고 끝이난다.
additivity 값을 false 로 주면 부모 로거로의 전달을 막게된다. (default 값은 true)
[실제 응용]
1. 특정 레벨의 로그는 별도의 파일로 관리
콘솔로그는 INFO 레벨 이상(INFO < WARN < ERROR...)인 경우 출력,
ERROR(ERROR < FATAL) 레벨 이상의 로그는 별도의 파일에 작성하여 관리하고자 하는 경우
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<Console name="console" target="SYSTEM_OUT">
<PatternLayout pattern="%-5p: %c - %m%n" />
<ThresholdFilter level="INFO"/>
</Console>
<RollingFile name="logFile" fileName="/logs/api.log" filePattern="/logs/$${date:yyyyMM}/app_%d{yyyyMMdd}-%i.log.gz">
<PatternLayout pattern="%-5p: %m%n" />
<Policies>
<TimeBasedTriggeringPolicy interval="1" />
<SizeBasedTriggeringPolicy size="100MB"/>
</Policies>
<ThresholdFilter level="ERROR"/>
</RollingFile>
</Appenders>
<Loggers>
<Logger name="com" additivity="false">
<AppenderRef ref="console" />
<AppenderRef ref="logFile" />
</Logger>
<Root level="INFO">
<AppenderRef ref="console" />
</Root>
</Loggers>
</Configuration>
|
cs |
FileAppender 는 로그를 파일에 작성하기 위해,
RollingFileAppender 는 로그를 파일에 저장 + 롤아웃(백업) 하기 위해 사용한다.
이외에도 다양한 Appender 들이 지원되니 다른 appender 가 필요하다면 공식 document 를 참고하면된다.
TimeBasedTriggeringPolicy 는 시간에 의한 백업
SizeBasedTriggeringPolicy 는 로거 파일 용량에 의한 백업
filePattern 은 백업 파일형식
ThresholdFilter 는 appender 의 로그 레벨을 지정
위 설정은 아래와 같다.
com 밑의 모든 class 에서 출력하는 INFO 레벨 이상의 콘솔 로그를 %-5p: %c - %m%n 포맷으로 찍는다.
com 밑의 모든 class 에서 출력하는 ERROR 레벨 이상의 콘솔 로그를 %-5p: %m%n 포맷으로 /logs/api.log 파일에 기록한다.
용량이 100MB 초과할 경우, 혹은 하루가 지난 경우(매일) 로그 파일을 /logs/년월/app_년월일-백업시퀀스.log.gz 이름으로 압축한다.
※ logback에서의 설정은 아래와 같다
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- doc : http://logback.qos.ch/documentation.html -->
<!-- xml example : https://mkyong.com/logging/logback-xml-example/ -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<appender name="FILE_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>/boot_jpa_log/log_stats.log</file>
<encoder>
<pattern>%m%n</pattern>
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>/boot_jpa_log/old/log_stats_%d{yyyyMMdd}.log</fileNamePattern>
</rollingPolicy>
</appender>
<logger name="com" level="DEBUG" additivity="false">
<appender-ref ref="STDOUT" />
</logger>
<logger name="org.springframework.boot.autoconfigure" level="WARN">
<appender-ref ref="STDOUT"/>
</logger>
<logger name="fileLogger" level="INFO" additivity="false">
<appender-ref ref="FILE_APPENDER" />
</logger>
<root level="INFO">
<appender-ref ref="STDOUT" />
</root>
</configuration>
|
cs |
[위와 같이 설정한 경우 Sample.class]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
package com.sample.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Sample {
protected static final Logger logger = LoggerFactory.getLogger(Sample.class);
public static void main(String[] args) {
logger.info("Sample.class logger print with info level");
logger.error("fileLogger logger print with error level");
}
}
|
cs |
main 메소드를 실행시 logger.error 로 찍은 로그는 /logs/api.log 파일에 write 되어 있으며, 콘솔에선 찍히지 않는다.
[실행 결과 : 콘솔]
INFO : com.sample.controller.Sample - Sample.class logger print with info level
[실행 결과 : /logs/api.log 파일]
ERROR : fileLogger - fileLogger logger print with error level
2. 특정 로거에서 출력한 로그는 파일로 저장하기
기존의 console 로그 이외에 로거를 하나 추가로 두고,
추가한 로거를 사용하여 로그를 찍는 경우, 별도의 파일로 저장하고자 하는 경우
fileLogger 를 로거로 추가하고, 파일 어팬더를 주입.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<Console name="console" target="SYSTEM_OUT">
<PatternLayout pattern="%-5p: %c - %m%n" />
</Console>
<RollingFile name="logFile" fileName="/logs/api.log" filePattern="/logs/$${date:yyyyMM}/app_%d{yyyyMMdd}-%i.log.gz">
<PatternLayout pattern="%-5p: %c - %m%n" />
<Policies>
<TimeBasedTriggeringPolicy />
<SizeBasedTriggeringPolicy size="100MB"/>
</Policies>
</RollingFile>
</Appenders>
<Loggers>
<Root level="INFO">
<AppenderRef ref="console" />
</Root>
<Logger name="fileLogger" level="INFO" additivity="false">
<AppenderRef ref="logFile" />
</Logger>
</Loggers>
</Configuration>
|
cs |
Sample.class는 아래와 같다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
package com.sample.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Sample {
protected static final Logger logger = LoggerFactory.getLogger(Sample.class);
protected static final Logger fileLogger = LoggerFactory.getLogger("fileLogger");
public static void main(String[] args) {
logger.info("Sample.class logger print with info level");
fileLogger.info("fileLogger logger print with info level");
}
}
|
cs |
[실행결과 : 콘솔]
INFO : com.sample.controller.Sample - Sample.class logger print with info level
[실행결과 : /logs/api.log]
INFO : fileLogger - fileLogger logger print with info level
참고:
https://logging.apache.org/log4j/2.x/manual/architecture.html
https://logging.apache.org/log4j/2.x/manual/appenders.html
