[Spring Batch] Logback 설정하기

현재 Spring Batch를 통한 간단한 배치 프로그램을 만들고 있습니다.

API를 통해 데이터를 DB에 업데이트를 하는 작업을 진행하는데, 현재 테스트 기간이라 해당 프로그램이 잘 동작하는지에 대한 확인이 필요했습니다. 현재 회사에서 사용하는 slf4j를 사용할까 고민하였지만, 저만의 사이드 프로젝트기도 하고, logback에 대한 성능이 slf4j보다 앞서다는 글을 보았습니다. 공부할 겸 logback를 이용하여 로그를 쌓기로 했습니다.

그래서 Spring Boot에서 Logback을 설정하는 방법, 실제로 적용하면서 발생하였던 이슈에 대해 간략하게 서술하려 합니다.
정정이 필요한 부분에 대해서는 아낌 없는 댓글 부탁드립니다.
(Spring Boot에 대한 포스팅은.. 언젠가..)

사용하는 기술 버전

• Spring Batch 4.2 (Spring Boot 2.2)
• Logback 1.2.3

1. Logback 설정하기

(제가 알기로는) spring-boot-starter-batch의 의존성은 다음과 같습니다.

spring-boot-starter
ㄴ spring-boot-starter-batch

spring-boot-starter내에는 기본적으로 사용할 수 있도록 로그 시스템(logback, slf4j 등)을 제공하고 있습니다.
(그래서 현재 필자의 프로젝트에는 logback-core-1.2.3.jar, logback-classic-1.2.3.jar가 depend되어 있습니다.)

만약 logback의 다른 버전을 사용하려거나, 혹은 spring-boot-starter-batch 내에 포함이 되어있지 않다면,
pom.xml에 다음 dependency를 적용하면 됩니다.
(물론 <repository />로 설정해둔 레파지토리 주소 내에 logback이 있어야 합니다.)

...(중략)
<dependencies>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
    </dependency>
</dependencies>
...(후략)

2. logback-spring.xml 생성하기

logback를 사용하기 위해서는, 그에 해당하는 설정파일을 생성해야 합니다.
${프로젝트경로}/src/main/resources 경로에 logback-spring.xml 파일을 만들어주면, 애플리케이션이 구동 될 때 logback에서 해당 파일을 읽어옵니다.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <!-- 로그가 저장될 경로 -->
  <property name="LOG_PATH" value="/log" />

  <!-- 파일로 로그를 작성할 때 -->
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>log/ldata.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>log/ldata.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
      <pattern>%date %level [%thread] %msg%n</pattern>
    </encoder>
  </appender>

  <!-- 콘솔에서 로그를 작성할 때 -->
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
     <!--  <pattern>%msg%n</pattern> -->
      <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
    </encoder>
  </appender>

  <!-- 프로그램에서 적용될 로그 레벨 -->
  <root level="INFO">
    <appender-ref ref="FILE" />
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

<configuration/>, <appender/>에 관련된 설명은 공식 홈페이지에 잘 나와있답니다. (영어라서 문제..)
위에 작성된 logback-spring.xml에 대한 해석은 다음과 같습니다.

1. 파일로 로그를 작성할 때
   • file의 이름은 ldata.log로 작성한다.
   • 오늘 이후, 하루가 지나갈 때마다 이름을 다르게 작성한다.
     • 파일명의 패턴은 다음과 같이 지정한다 : ldata.2019-11-15.log
     • 이 파일들은 최대 30일까지만 보유하며, 이후 자동으로 삭제한다.
   • file 내에 적혀질 로그들은 다음과 같이 작성한다 : 2019-11-14 [INFO] step : [updateStep] executed in 529ms
2. 콘솔에서 로그를 보여줄 때
   • console 내에서 보여줄 로그들은 다음과 같이 작성한다 : 2019-11-14 [INFO] [main] o.s.b.c.l.s.JobLauncher [JobLauncher.java:149] Job: [SimpleJob: [name=updateJob]] status: [COMPLETED] in 698ms
3. 현재 이 프로젝트의 로그 레벨은 INFO

3. logback 사용하기

이제 logback에 대한 설정까지 마쳤다면, 실제 애플리케이션 단계에서 로그를 참조해야 합니다.
(해당 부분에 대한 설명이 틀릴 수 있으므로, 이 글을 확인하시는 분이시라면 아낌 없는 피드백을 부탁드립니다...)

실제로 작성하고 있는 Application단에서 다음과 같이 코드를 작성합니다.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@EnableBatchProcessing
@SpringBootApplication
public class Application {
    private static final Logger logger = LoggerFactory.getLogger(Application.class);
    public static void main (String[] args) {
        logger.info("INFO...");
        logger.error("ERROR...");
    }
}

위 코드에 대한 실행 결과를 간략하게 적자면 다음과 같습니다.

2019-11-15 [INFO] INFO...
2019-11-15 [ERROR] ERROR...

4. 이슈..라기 보다는 발생했던 문제점

1.XML을 작성했더니 애플리케이션 구동시 에러가 발생함

 1.1 내가 작성했던 코드

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>ldata.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!-- daily rollover -->
      <fileNamePattern>ldata-%d{yyyy-MM-dd}.log</fileNamePattern>
      <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
      <maxFileSize>100MB</maxFileSize> 
      <!-- keep 30 days' worth of history capped at 3GB total size -->
      <maxHistory>30</maxHistory>
      <totalSizeCap>2GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
      <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
    </encoder>
  </appender>

 1.2 나타났던 오류

    2019-11-14 16:12:45,568 ERROR [main] o.s.b.SpringApplication [SpringApplication.java:826] Application run failed
java.lang.IllegalStateException: Logback configuration error detected: 
ERROR in ch.qos.logback.core.joran.spi.Interpreter@11:20 - no applicable action for [maxFileSize], current ElementPath  is [[configuration][appender][rollingPolicy][maxFileSize]]
    at org.springframework.boot.logging.logback.LogbackLoggingSystem.loadConfiguration(LogbackLoggingSystem.java:169)
    at org.springframework.boot.logging.AbstractLoggingSystem.initializeWithConventions(AbstractLoggingSystem.java:80)
    at org.springframework.boot.logging.AbstractLoggingSystem.initialize(AbstractLoggingSystem.java:60)
    at org.springframework.boot.logging.logback.LogbackLoggingSystem.initialize(LogbackLoggingSystem.java:118)
    at org.springframework.boot.context.logging.LoggingApplicationListener.initializeSystem(LoggingApplicationListener.java:312)
    at org.springframework.boot.context.logging.LoggingApplicationListener.initialize(LoggingApplicationListener.java:287)
    at org.springframework.boot.context.logging.LoggingApplicationListener.onApplicationEnvironmentPreparedEvent(LoggingApplicationListener.java:245)
    at org.springframework.boot.context.logging.LoggingApplicationListener.onApplicationEvent(LoggingApplicationListener.java:222)
    at org.springframework.context.event.SimpleApplicationEventMulticaster.doInvokeListener(SimpleApplicationEventMulticaster.java:172)
    at org.springframework.context.event.SimpleApplicationEventMulticaster.invokeListener(SimpleApplicationEventMulticaster.java:165)
    at org.springframework.context.event.SimpleApplicationEventMulticaster.multicastEvent(SimpleApplicationEventMulticaster.java:139)
    at org.springframework.context.event.SimpleApplicationEventMulticaster.multicastEvent(SimpleApplicationEventMulticaster.java:127)
    at org.springframework.boot.context.event.EventPublishingRunListener.environmentPrepared(EventPublishingRunListener.java:76)
    at org.springframework.boot.SpringApplicationRunListeners.environmentPrepared(SpringApplicationRunListeners.java:53)
    at org.springframework.boot.SpringApplication.prepareEnvironment(SpringApplication.java:345)

- no applicable action for [maxFileSize] 가 핵심 문구

1.3 오류의 원인 및 해결방안
- 공식 문서를 보며 예제를 붙이는 과정에서, `TimeBasedRollingPolicy` 클래스가 틀린 것을 확인하게 됨. (^^)
- 현재 rollingPolicy의 class는 `TimeBasedRollingPolicy`이나 내가 작성한 속성들(`maxFileSize`, `totalSizeCap`)`을 사용하려면 class를 `SizeAndTimeBasedRollingPolicy`로 지정해주어야 오류가 나지 않습니다!

- 그러므로 저와 비슷한 오류가 발생하였다면
    1. XML을 올바르게 작성하였는지 (열어놓고 닫은 태그는 없는지, / 가 빠졌다던지 등등..)
    2. 각 Class에 해당하는 속성을 올바르게 작성하였는지
  꼭 확인을 해주세요.