4-09. 로깅 관련

• 서버 로그의 문제점
• 서버 로그 분리
  • start.sh 변경
  • 사용자 로그

---

4-09. 로깅

---

점프 투 스프링부트 - WikiDocs

---

pahkey/sbb3 - 4-09

스프링부트는 기본적으로 logback이라는 로깅 툴을 사용하여 로그를 출력한다. STS의 콘솔에 출력되는 문자열과 서버에서 sbb.log 파일에 출력되는 문자열이 모두 logback에 의해 출력되는 로그이다.

---

서버 로그의 문제점

하지만 현재 서버에 생성되는 로그 파일에는 다음과 같은 몇가지 문제가 있다.

• SBB 서비스를 재 실행할 경우 이전 로그가 삭제된다. (stop.sh을 하고 start.sh을 실행할 경우)
• 로그 파일이 쌓일수록 로그파일의 사이즈가 커지며 무한대로 증가할수 있다.
• 로그의 시간이 시스템 시간이 아닌 UTC시간으로 출력된다.

---

서버 로그 분리

위에서 말한 서버 로그의 문제점을 해결하려면 다음과 같이 application-prod.properties 파일을 수정해야 한다.

파일명: /sbb/src/main/resources/application-prod.properties

# DATABASE
spring.h2.console.enabled=true
spring.h2.console.path=/h2-console
spring.h2.console.settings.web-allow-others=true
spring.datasource.url=jdbc:h2:~/local
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=1234

# JPA
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.H2Dialect
spring.jpa.hibernate.ddl-auto=update
spring.jpa.properties.hibernate.format_sql=true
spring.jpa.properties.hibernate.show_sql=true

# logging
logging.logback.rollingpolicy.max-history=30
logging.logback.rollingpolicy.max-file-size=100MB
logging.file.name=logs/sbb.log
logging.logback.rollingpolicy.file-name-pattern=${LOG_FILE}.%d{yyyy-MM-dd}-%i.log
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS,Asia/Seoul

.application-prod.properties 파일에 위와 같이 logging 설정을 추가했다. 각각의 항목에 대해서 알아보자.

• logging.logback.rollingpolicy.max-history: 로그 파일을 유지할 기간(일수)을 설정한다. (30일간의 로그만 유지하도록 했다.)
• logging.logback.rollingpolicy.max-file-size: 로그 파일의 한 개의 최대 사이즈를 설정한다. (100MB로 설정했다.)
• logging.file.name: 로그 파일의 이름을 설정한다. logs/sbb.log는 logs 디렉터리의 하위에 sbb.log라는 이름으로 로그파일을 생성하라는 의미이다.
• logging.logback.rollingpolicy.file-name-pattern: 로그 파일의 사이즈가 설정한 용량을 초과하거나 날짜가 변경될 경우 명명할 로그파일의 이름에 대한 설정이다.
• logging.pattern.dateformat: 로그 출력시 출력하는 날짜와 시간에 대한 포맷과 타임존(timezone)을 설정한다. 타임존을 설정하지 않을 경우 UTC 시간을 기준으로 출력한다. 이와 같이 수정하고 배포 파일(sbb-0.0.3.jar)을 새로 작성하여 서버에 업로드하자.

start.sh 변경

서버의 로깅 설정을 변경했으므로 서버의 start.sh 파일도 다음과 같이 수정하자.

파일명: /home/ubuntu/sbb/start.sh

#!/bin/bash

JAR=sbb-0.0.3.jar
LOG=/dev/null
export spring_profiles_active=prod

nohup java -jar $JAR > $LOG 2>&1 &

.start.sh 실행시 생성되는 로그 파일을 sbb.log 에서 /dev/null로 변경했다. 왜냐하면 로깅설정을 통해 logs 디렉터리 하위에 로그파일이 생성되도록 설정했기 때문이다. 자바 프로그램의 출력을 /dev/null로 지정하면 콘솔 출력이 무시된다.

그리고 기존의 로그는 더이상 필요하지 않으므로 다음과 같이 삭제하자.

rm sbb.log

그리고 SBB 서비스를 다음과 같이 재시작하자.

stop.sh
start.sh

그러면 다음처럼 logs 디렉터리가 생성되고 logs 디렉터리 밑에 sbb.log 파일이 생성되는 것을 확인할수 있다.

ls
#
# sbb.log

이제 기존 로그도 사라지지 않고 30 일간의 로그가 날짜별(사이즈별)로 유지되며 출력되는 시간도 한국시간 기준으로 잘 출력될 것이다.

사용자 로그

지금까지는 스프링부트 프레임워크가 출력하는 로그들에 대해서 알아보았다. 하지만 사용자가 직접 코드를 작성하여 로그를 출력할 수도 있다. 그 방법에 대해서 알아보자.

다음은 질문 목록 조회시 GET으로 요청되는 page, kw 파라미터의 입력값을 로그로 출력하는 예제이다.

파일명: /sbb/src/main/java/com/mysite/sbb/question/QuestionController.java

package com.mysite.sbb.question;

// (... 생략 ...)
import lombok.extern.slf4j.Slf4j;

@Slf4j
@RequiredArgsConstructor
@Controller
@RequestMapping("/question")
public class QuestionController {

    // (... 생략 ...)

    @GetMapping("/list")
    public String list(Model model, @RequestParam(value = "page", defaultValue = "0") int page, 
            @RequestParam(value = "kw", defaultValue = "") String kw) {
        log.info("page:{}, kw:{}", page, kw);
        Page<Question> paging = this.questionService.getList(page, kw);
        model.addAttribute("paging", paging);
        model.addAttribute("kw", kw);

        return "question_list";
    }

    // (... 생략 ...)
}

롬복이 제공하는 @Slf4 애너테이션을 사용하면 log 객체를 사용할수 있다. log 객체를 사용하여 debug, error 등의 로그를 출력할 수 있다. 로그 레벨은 다음과 같이 6단계로 구성된다. 각 단계의 로그는 log.trace, log.debug, log.info, log.warn, log.error, log.fatal 로 출력할 수 있다.

• trace (1단계) - debug 보다 훨씬 상세한 정보를 나타낼 경우에 사용
• debug (2단계) - 디버깅 목적으로 사용
• info (3단계) - 일반 정보를 출력할 목적으로 사용
• warn (4단계) - 경고 정보를 출력할 목적으로(작은 문제) 사용
• error (5단계) - 오류 정보를 출력할 목적으로(큰 문제) 사용
• fatal (6단계) - 아주 심각한 문제를 출력할 목적으로 사용

설명에서 짐작할 수 있듯이 로그 레벨의 순서는 다음과 같다.

TRACE < DEBUG < INFO < WARN < ERROR < FATAL

로그는 설정한 레벨 이상의 로그만 출력된다. 예를 들어 application.properties 파일에 logging.level.root=info로 설정하면 TRACE, DEBUG 로그는 출력되지 않고 INFO 이상의 로그만 출력된다. 즉, log.trace 또는 log.debug로 출력하는 로그는 출력되지 않고 logging.info, logging.warn, logging.error, logging.fatal로 출력한 로그만 출력된다는 말이다. 만약 로그 레벨을 logging.level.root=error로 설정한다면 logging.error, logging.fatal로 출력한 로그만 출력될 것이다.

logging.level.root의 디폴트 값은 info이다. 특별히 설정하지 않으면 info로 설정된다.

---