[Spring] Spring Boot Logback / 스프링 로그 설정

 

 

 

Spring With LogBack

📔Springboot 에 Logback 적용하기

📄시작 계기?

우리 팀 업무의 편의성을 위한 프로세스를 고민하다가 점심 시간에 가볍게 만든 프로젝트(등록 자료 자동 검수, 운영 프로세스 이상 유무 체크, RM 발송 등의 기능을 탑재한 자동 배치 시스템)를 팀에서 격하게 환영해주어 개발계에서 스테이징으로 옮기기로 했다 ㅎㅎ

 

배치 프로세스이다 보니 Scheduled 기능을 가진 프로젝트다.

Linux OS 에서 jar로 가볍게 구동할 계획이었고, 기존에는 Tomcat에 war로 빌드해서 lombok의 로그를 찍었었다.

이제는 별도 Log 파일로 관리할 예정 이기에 로그 경로는 따로 잡아주어야 했다.

 

📝logback-spring.xml

감사하게도 SpringBoot 에서는 파일 명칭만으로 자동으로 인식해주는 편의성을 제공한다.

그 이름하여.. "logback-spring.xml "

 

👨‍💻💻⌨xml 내용은 아래와 같다.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	<!-- properties 로 모든 설정을 관리하고 싶어서 별도로 property에 추가했다.
    특히나 Log의 Level을 설정할 때, properties 수정만으로 진행하고 싶었던게 크다.
    -->
    <property resource="application.properties"/>
    <!-- properties에 있는 값을 따로 맵핑해주고 싶었다..-->
    <property name="LOG_ROOT_LEVEL" value="${logging.root.level}"/>
    <property name="LOG_FILE_PATH" value="${logging.file.path}"/>
    <property name="LOG_FILE_NAME" value="${logging.file.name}"/>

	<!-- 즐겨쓰는 로그 포맷인데, 어느새 팀에서도 아래 포맷을 사용하고 있다.-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>[%d{HH:mm:ss}] [%-5level] %logger{36}[line: %L] - %msg%n</Pattern>
        </layout>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logging.file.path}/springBatchApi.log</file>
        <encoder>
            <Pattern>[%d{HH:mm:ss}] [%-5level] %logger{36}[line: %L] - %msg%n</Pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE_PATH}/${LOG_FILE_NAME}</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 파일 사이즈는 5MB를 넘기지 않도록 해서 용량을 크게 차지하지 않도록 한다. 
                부가서비스인 만큼 로그는 최대한 필수적인 내용만 담고, 필요없는 부분은 과감하게 생략했다.
                -->                
                <maxFileSize>5MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 한 달 주기의 최대치인 31-->
            <maxHistory>31</maxHistory>
        </rollingPolicy>
    </appender>

    <root level="${LOG_ROOT_LEVEL}">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE" />
    </root>
    <logger name="kr.co.ooweat.springBatchApi" level="${LOG_ROOT_LEVEL}">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE" />
    </logger>

</configuration>

📝application.properties

어느정도 구색은 갖추는게 좋겠다.

#Logging 부분으로 구분하여 따로 등록해주었다.

"application.properties"

 

👨‍💻💻⌨properties 내용은 아래와 같다.

server.port=17882
#Logging
logging.root.level=INFO
logging.file.path=/app/service/springBatchApi/logs
logging.file.name=springBatchApi_%d{yyyy-MM-dd}_%i.log

#Use Flag
smtp.use.flag=y
kakao.use.flag=y

#Schedule
batch.morning.crond=0 40 7-9/1 * * ?
batch.halfHours.crond=0 */30 9-18/1 * * ?
batch.hours.crond=0 0 */1 * * ?

---

📚추가

뭐, 이 글을 참고하는 이가 프로젝트에서 기존에 lombok 을 사용하거나 Logger를 사용했었다면 딱히 어려운 점은 없을 것 같다.