스프링부트 로그 남기기

slf4j

자체적인 로깅 프레임워크가 아니다. logger추상체로써 다른 로깅 프레임워크를 바꾸면서 쓸 수 있게 해주는 프레임워크 → 코드를 바꾸지 않고 다른 로깅 프레임워크를 사용할 수 있다.

log4j

가장 오래된 프레임워크 (2015년 이후 개발이 중단됨)

logback

자바의 오픈소스 로깅 프레임워크다. 앞으로 저희가 사용할 Slf4j의 구현체다. Springboot에서는 spring-boot-starter-logging안에 기본적으로 포함되어 있어서 따로 dependency를 추가하지 않고 사용 가능하다. 

log4j2

가장 최근에 나온 로깅 프레임워크로 Multi Thread환경에서 비동기 로거는 다른 프레임워크에 비해 처리량이 많고 대기시간이 짧다.

Springboot에서의 로그설정

springboot-seb-starter에 기본적으로 logback이 설정되어있다.

 Springboot 로그 설정

1. resourece 디렉터리 밑에 logback-spring.xml을 읽고, 로그를 만든다. 
2. 위의 logback-spring.xml이 없다면,. yml파일 혹은. properties 파일을 읽고, 로그를 만든다. 
3. 만약 두 개 다 있다면,. yml파일 먼저 읽고, logback-spring.xml 파일에서 추가되는 부분을 사용한다. 

로그 레벨

총 5가지의 레벨이 있다. 왼쪽이 가장 낮은 레벨이고, 오른쪽이 가장 높은 레벨이다. 

TRACE  <  DEBUG  <  INFO  <  WARN  <  ERROR

1) ERROR : 요청을 처리하는 중 오류가 발생한 경우 표시한다.
2) WARN  : 처리 가능한 문제, 향후 시스템 에러의 원인이 될 수 있는 경고성 메시지를 나타낸다.
3) INFO  : 상태 변경과 같은 정보성 로그를 표시한다.
4) DEBUG : 프로그램을 디버깅하기 위한 정보를 표시한다. 
5) TRACE : 추적 레벨은 Debug보다 훨씬 상세한 정보를 나타낸다. 
만약 log 레벨을 INFO로 설정했다면, INFO부터 ~ERROR까지 자신보다 높은 로그까지 찍게 된다.

application-log.yml 로그 적용

logging:
  level: # 적용할 곳과 레벨
    root: warn
    com.example: debug
  file: # 로그 파일에 대한 명시, 주의점 name과 path중 하나만 사용해야함. path 사용을 권장
    name: # 로그 파일의 이름
    path: # 로그 파일의 위치 절대 경로
  logback:
    rollingpolicy:
      file-name-pattern: # 로그 파일의 이름을 설정하는 패턴 (파일명+날짜)
      clean-history-on-start: # 애플리케이션 재실행시 로그 파일을 초기화 여부 설정
      max-file-size: # 로그 파일의 최대 크기이며, 크기가 넘어가면 새로운 로그파일 작성
      max-history: # 로그 파일의 최대 수
      total-size-cap: # 로그 파일의 총 크기이며, 넘어갈 시 가장 오래된 로그 파일 삭제
  pattern:
    console: # 콘솔 창에 출력될 로그의 패턴
    level: # 출력 로그 레벨 지정
    file: # 로그 파일에 사용될 로그 패턴
    dateformat: # 로그의 date에 대한 디폴트 설정

logback-spring.xml 로그 적용

<?xml version="1.0" encoding="UTF-8"?>
<!-- 60초마다 설정 파일의 변경을 확인 하여 변경시 갱신 -->
<configuration scan="true" scanPeriod="60 seconds">
    <!--springProfile 태그를 사용하면 logback 설정파일에서 복수개의 프로파일을 설정할 수 있다.-->
    <springProfile name="local">
        <property resource="logback-local.properties"/>
    </springProfile>
    <springProfile name="dev">
        <property resource="logback-dev.properties"/>
    </springProfile>
    <!--Environment 내의 프로퍼티들을 개별적으로 설정할 수도 있다.-->
    <springProperty scope="context" name="LOG_LEVEL" source="logging.level.root"/>
 
    <!-- log file path -->
    <property name="LOG_PATH" value="${log.config.path}"/>
    <!-- log file name -->
    <property name="LOG_FILE_NAME" value="${log.config.filename}"/>
    <!-- err log file name -->
    <property name="ERR_LOG_FILE_NAME" value="err_log"/>
    <!-- pattern -->
    <property name="LOG_PATTERN" value="%-5level %d{yy-MM-dd HH:mm:ss}[%thread] [%logger{0}:%line] - %msg%n"/>
 
    <!-- Console Appender -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
 
    <!-- File Appender -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 파일경로 설정 -->
        <file>${LOG_PATH}/${LOG_FILE_NAME}.log</file>
 
        <!-- 출력패턴 설정-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
 
        <!-- Rolling 정책 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- .gz,.zip 등을 넣으면 자동 일자별 로그파일 압축 -->
            <fileNamePattern>${LOG_PATH}/${LOG_FILE_NAME}.%d{yyyy-MM-dd}_%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 파일당 최고 용량 kb, mb, gb -->
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거-->
            <maxHistory>30</maxHistory>
            <!--<MinIndex>1</MinIndex>
            <MaxIndex>10</MaxIndex>-->
        </rollingPolicy>
    </appender>
 
    <!-- 에러의 경우 파일에 로그 처리 -->
    <appender name="Error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <file>${LOG_PATH}/${ERR_LOG_FILE_NAME}.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
        <!-- Rolling 정책 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- .gz,.zip 등을 넣으면 자동 일자별 로그파일 압축 -->
            <fileNamePattern>${LOG_PATH}/${ERR_LOG_FILE_NAME}.%d{yyyy-MM-dd}_%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 파일당 최고 용량 kb, mb, gb -->
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거-->
            <maxHistory>60</maxHistory>
        </rollingPolicy>
    </appender>
 
    <!-- root레벨 설정 -->
    <root level="${LOG_LEVEL}">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="Error"/>
    </root>
 
    <!-- 특정패키지 로깅레벨 설정 -->
    <logger name="org.apache.ibatis" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="Error"/>
    </logger>
</configuration>