Logback은 Slf4j이 구현체 중 하나로 로깅을 위한 라이브러리 입니다.
Logback 은 log4j 에 비해 향상된 필터링 정책, 기능, 로그 레벨 변경 등에 대해
서버를 재시작할 필요 없이 자동 리로딩을 지원하기 때문에 최근에는 Logback을 더 많이 사용합니다.
spring-boot-starter-web를 사용하면 기본적으로 Logback Dependencies가 받아집니다.
logback-classic와 logback-access 모듈을 위한 기반 역할을 하는 모듈입니다.
Appender, Layout 인터페이스가 이 모듈에 속합니다.
logback-core에서 확장된 모듈로 logback-core를 가지며 Slf4j를 구현합니다.
Logger 클래스가 이 모듈에 속합니다.
logback-classic에 포함된 라이브러리들은 해당artifact의 올바른 버전 사용이 필요하고, 모두 명시적으로 선언하는 것이 좋기 때문에 이걸 사용할 때는exclude해주는 것이 좋다고 합니다.
Servlet Container와 통합하여 HTTP 액세스에 대한 로깅 기능을 제공합니다.
웹 애플리케이션 레벨이 아닌 컨테이너 레벨에 설치되어야 합니다.
실제 로깅을 수행하는 구성요소 입니다.
| Level | 설명 |
|---|---|
Fatal |
매우 심각한 에러로 프로그램이 종료되는 경우가 많음 |
Error |
의도치 않은 에러가 발생한 경우. 프로그램이 종료되지는 않음 |
Warn |
에러가 될 수 있는 잠재적 가능성이 있는 경우 |
Info |
명확한 의도가 있는 에러. 요구사항에 따라 시스템 동작을 보여줄 때 |
Debug |
Info 레벨보다 더 자세한 정보가 필요한 경우. Dev 환경 |
Trace |
Debug 레벨보다 더 자세한 정보가 필요한 경우. Dev 환경에서 버그를 해결하기 위해 사용 |
Logback은Fatal을 제외하고 5개의 레벨을 가집니다.
Error>Warn>Info>Debug>Trace예를 들어
Info레벨로 설정 시,Debug,Trace레벨은 출력 되지 않습니다.
로그 메세지가 출력 될 대상을 결정합니다.
Logger는 Appender에게 로그 이벤트를 위임합니다
ConsoleAppender: 콘솔에 출력FileAppender: 파일에 출력RollingFileAppender: 파일을 일정 조건에 맞게 따로 저장
외에도 로그를 메일로 보내는 Appender 등 더 있지만,
주로 사용 될 Appender는 위의 3개이므로 이외에 Appender는 필요시 찾아서 적용하면 될 것 같습니다.
로그 이벤트를 바이트 배열로 변환하고 해당 바이트 배열을 OutPutStream에 쓰는 작업을 담당합니다.
즉, Appender에 포함되며 사용자가 지정한 형식으로 로그를 변환하는 역할을 합니다.
@Slf4j
@RestController
@RequestMapping("/members")
public class MemberController {
@GetMapping
private void getMember() {
log.trace("trace: member");
log.debug("debug: member");
log.info("info: member");
log.warn("warn: member");
log.error("error: member");
}
}2022-08-14 16:31:13.682 INFO 1951 --- [nio-8080-exec-1] c.j.logback.member.MemberController : info: member
2022-08-14 16:31:13.682 WARN 1951 --- [nio-8080-exec-1] c.j.logback.member.MemberController : warn: member
2022-08-14 16:31:13.682 ERROR 1951 --- [nio-8080-exec-1] c.j.logback.member.MemberController : error: member아무런 설정을 하지 않고 각 레벨별로 기록했는데 Info 레벨 부터 나오는 이유는 기본 값이 Info이기 때문입니다.
@Slf4j는Lombok에서 제공하는 기능으로 아래 처럼 로깅 필드를 생성해주는 역할을 합니다.private Logger log=LoggerFactory.getLogger(MemberController.class);
로그 레벨을 변경하는 방법 두 가지가 있습니다.
application.yml(properties)logback-spring.xml
logging.level.root='trace'application.properties 파일에 위 처럼 설정하면 trace까지 모두 출력되는 것을 확인할 수 있습니다.
application.properties은 간단하지만 세부적인 설정을 하기에는 한계가 있기 때문에
logback-spring.xml을 사용하여 로그를 관리하는 것이 더 좋습니다.
src/main/resources하위에 logback-spring.xml으로 파일을 생성합니다. 그러면 Spring Boot가 자동으로 설정을 읽어 적용합니다.
여기서 파일 위치와 이름은 정해져있는 것이기 때문에 다르게 사용하면 안됩니다.
아래 예제는 운영 환경이 아니면 INFO레벨 이상은 콘솔에 출력하고
운영 환경이라면 INFO레벨만 파일에 로깅 되도록 구성한 것입니다.
이외에 다른 레벨은 아래 예제에서 수정하여 사용하면 될 것 같습니다.
logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- 모든 설정은 해당 태그 하위에 작성합니다. -->
<configuration>
<!-- 날짜 포맷 지정 -->
<timestamp key="BY_DATE" datePattern="yyyy-MM-dd"/>
<!-- 로그 출력 패턴 변수 -->
<property name="LOG_PATTERN"
value="[%d{yyyy-MM-dd HH:mm:ss}:%-4relative] %green([%thread]) %highlight(%-5level) %boldWhite([%C.%M:%yellow([%L])) - %msg%n"/>
<!-- Profile에 따라 실행되도록 구축 -->
<springProfile name="!prod">
<include resource="console-appender.xml"/>
<!-- 해당 레벨 이상이면 실행 -->
<root level="INFO">
<!-- 해당 Appender를 참조 -->
<appender-ref ref="CONSOLE"/>
</root>
</springProfile>
<springProfile name="prod">
<include resource="file-info-appender.xml"/>
<include resource="console-appender.xml"/>
<root level="INFO">
<appender-ref ref="FILE_INFO"/>
</root>
<!-- 특정 패키지 이하만 지정 -->
<logger name="com.jojiapp.logback.member" level="INFO">
<appender-ref ref="CONSOLE"/>
</logger>
</springProfile>
</configuration>console-appender.xml
<!-- 타 xml에서 include하기 위해서는 included 태그를 사용해야 함 -->
<included>
<!-- 콘솔 Appender 지정, 여기서 name은 appender-ref에서 사용됨 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!-- 어떻게 출력할지 지정 -->
<encoder>
<!-- 로그 출력 패턴 -->
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>
</included>file-info-appender.xml
<included>
<!-- RollingFileAppender 지정 -->
<appender name="FILE_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 로그가 작성될 파일 경로 -->
<file>./logs/info-${BY_DATE}.log</file>
<!-- 로깅 조건 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 필터링 할 레벨 지정 -->
<level>INFO</level>
<!-- 위의 레벨 이상이면 true -->
<onMatch>ACCEPT</onMatch>
<!-- 위의 레벨과 일치하지 않으면 로깅 안함 -->
<!-- INFO레벨 이상만 로깅하고 싶다면 해당 조건을 제거하면 됨 -->
<onMismatch>DENY</onMismatch>
</filter>
<!-- 어떻게 출력할지 지정 -->
<encoder>
<!-- 로그 출력 패턴 -->
<pattern>${LOG_PATTERN}</pattern>
</encoder>
<!-- 특정 사이즈 및 시간에 따라 로그 파일이 분리되도록 정책 지정 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 위 file 태그에서 지정한 로그 파일이 아래 조건에 만족하여 초과하면 복사되어 저장될 경로 -->
<fileNamePattern>./backup/info/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 로그 파일 최대 사이즈 지정. 해당 사이즈가 되면 복사됨 -->
<maxFileSize>100MB</maxFileSize>
<!-- 한 파일의 최대 저장 기한 -->
<!-- 주의: 일 단위면 30일, 월 단위면 30개월이 됨 -->
<maxHistory>30</maxHistory>
<!-- 파일 모두 합쳐 3GB 까지만 허용. 그 이상이 되면 오래된 것부터 삭제 됨 -->
<totalSizeCap>3GB</totalSizeCap>
</rollingPolicy>
</appender>
</included>%logger: 패키지 포함 클래스 정보%logger{0}: 패키지를 제외한 클래스 이름만 출력%logger{length}: Logger name을 축약할 수 있음. {length}는 최대 자리 수%-5level: 로그 레벨, -5는 출력의 고정폭 값(5글자)${PID:-}: 프로세스 아이디%d: 로그 기록시간 출력%p: 로깅 레벨 출력%F: 로깅이 발생한 프로그램 파일명 출력%M: 로깅일 발생한 메소드의 명 출력%line: 로깅이 발생한 호출지의 라인%L: 로깅이 발생한 호출지의 라인%thread: 현재 Thread 명%t: 로깅이 발생한 Thread 명%c: 로깅이 발생한 카테고리%C: 로깅이 발생한 클래스 명%m: 로그 메시지%msg: 로그 메시지 (=%message)%n: 줄바꿈(new line)%%: %를 출력%r: 애플리케이션 시작 이후부터 로깅이 발생한 시점까지의 시간(ms)%d{yyyy-MM-dd-HH:mm:ss:sss}: %d는 date를 의미하며 중괄호에 들어간 문자열은 dateformat을 의미%-4relative: 초 아래 단위 시간(밀리초)을 나타냄
()으로 감싸 범위를 지정합니다.
ex) %highlight(-5level)
%highlight: 로그 레벨별로 컬러 자동 지정%black%red%green%green%yellow%blue%magenta%cyan%white%gray%boldXxx: 컬러 앞에 bold를 붙여 굵게 표시할 수 있음