Spring Boot, Logback을 이용한 로그 출력하기

먼저 읽어볼만한 글

• Spring Boot, 웹 프로젝트 생성하기

라이브러리 종속성 추가

dependencies {
    compile group: 'net.logstash.logback', name: 'logstash-logback-encoder', version: '4.7'
}

• Spring Boot 기반의 애플리케이션(spring-boot-start 또는 spring-boot-start-web 아티팩트를 추가한 상태)은 기본적으로 spring-boot-starter-logging 아티팩트를 포함하므로 별도의 라이브러리 종속성을 추가할 필요가 없다. Spring Boot는 내부적으로 Logback 로깅 라이브러리를 사용하여 로그를 출력하며 개발자는 추상체인 SLF4J를 사용하여 로그를 기록하면 된다.


• 최근의 로그 관리 기법의 추세는 ELK Stack 등을 이용한 중앙집중 방식이다. ELK Stack 스택을 통해 로그를 수집할 경우 전통적인 라인 단위의 텍스트 로그보다 JSON 형식의 로그를 사용하는 것이 효율적이다. logstash-logback-encoder 아티팩트를 추가함으로서 ELK Stack에 대응하는 로그를 손쉽게 생성할 수 있다.

Decorator 작성

로그를 일반적인 문자열이 아닌 JSON 형식으로 출력하면 여러가지 장점이 있다. JSON 로그 생성시 이를 도와주는 클래스를 아래와 같이 작성한다.

/src/main/java/com/jsonobject/logback/PrettyPrintingDecorator.java 파일을 아래와 같이 작성한다.

package com.jsonobject.logback;

import com.fasterxml.jackson.core.JsonGenerator;
import net.logstash.logback.decorate.JsonGeneratorDecorator;

public class PrettyPrintingDecorator implements JsonGeneratorDecorator {

    @Override
    public JsonGenerator decorate(JsonGenerator generator) {

        return generator.useDefaultPrettyPrinter();
    }
}

/src/main/java/com/jsonobject/logback/JsonFactoryDecorator.java 파일을 아래와 같이 작성한다.

package com.jsonobject.logback;

import com.fasterxml.jackson.databind.MappingJsonFactory;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.util.ISO8601DateFormat;
import net.logstash.logback.decorate.JsonFactoryDecorator;

public class ISO8601DateDecorator implements JsonFactoryDecorator {

    @Override
    public MappingJsonFactory decorate(MappingJsonFactory factory) {

        ObjectMapper codec = factory.getCodec();
        codec.setDateFormat(new ISO8601DateFormat());

        return factory;
    }
}

로그 환경 설정

/src/main/resources/logback-spring.xml 파일을 아래와 같이 작성한다.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <property name="LOG_PATH" value="/var/log/application"/>

    <!-- 콘솔 로그 출력 -->
    <appender name="TEXT_CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <charset>UTF-8</charset>
            <Pattern>%d %-4relative [%thread] %-5level %logger{35} - %msg%n</Pattern>
        </encoder>
    </appender>

    <!-- Logstash JSON 형식으로 파일 로그 생성 -->
    <!-- /var/log/applicaion/log.json 파일에 최신 로그 생성 -->
    <!-- /var/log/applicaion/log_2016-07-15.0.json 파일에 과거 로그 보관
    <!-- 5MB 초과, 날짜 변경 시점마다 생성, 생성된지 3일 이상된 파일은 삭제 -->
    <appender name="JSON_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${LOG_PATH}/log.json</File>
        <encoder class="net.logstash.logback.encoder.LogstashEncoder">
            <jsonGeneratorDecorator class="com.jsonobject.example.logback.PrettyPrintingDecorator"/>
            <jsonFactoryDecorator class="com.jsonobject.example.logback.ISO8601DateDecorator"/>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_PATH}/log_%d{yyyy-MM-dd}.%i.json</FileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>5MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>3</maxHistory>
        </rollingPolicy>
    </appender>

    <!-- INFO 레벨 이하 로그를 콘솔 및 파일로 출력 -->
    <root level="INFO">
        <appender-ref ref="TEXT_CONSOLE"/>
        <appender-ref ref="JSON_FILE"/>
    </root>

</configuration>

• 별도의 로깅 설정을 하지 않을 경우 Spring Boot는 INFO 이하 레벨(TRACE, DEBUG를 제외한 INFO, WARN, ERROR)의 모든 로그를 콘솔에 출력한다. 로깅 설정은 /src/main/resources/logback-spring.xml 파일에 작성한다.(/src/main/resources/application.properties에 작성하는 방법도 있지만 설정이 제한적으로 추천하지 않는다.)


• Spirng Boot 애플리케이션을 서비스로 작동시키는 운영 환경이라면 ch.qos.logback.core.ConsoleAppender 어펜더는 사용하지 않아야 하며 반드시 ch.qos.logback.core.rolling.RollingFileAppender 어펜더를 정의하여 로그 파일의 롤링 및 삭제 주기를 구체적으로 명시해야 한다. 이를 소홀히 하면 디스크 용량이 가득차면서 서비스의 가동도 중단되는 아찔한 상황을 맞이할 수 있다.

SYSLOG/UDP 전송을 이용한 ELK 로그 수집하기

LogstashSocketAppender를 이용하면 syslog 원격 서버에 대한 UDP 로그 전송이 가능하다. 낮은 부하로 애플리케이션 로그를 중앙에서 실시간으로 수집할 수 있다는 장점이 있다.

<appender name="JSON_UDP" class="net.logstash.logback.appender.LogstashSocketAppender">
    <syslogHost>127.0.0.1</syslogHost>
    <port>514</port>
    <!-- 기본적으로 생성되는 필드명을 변경할 수 있다. -->
    <fieldNames>
        <!-- @timestamp 필드명으로 기본 생성되는 로그 생성 일시를 created_datetime 필드명으로 출력되도록 변경한다. -->
        <timestamp>created_datetime</timestamp>
    </fieldNames>
    <!-- 로그 앞에 서버 식별 목적의 임의의 접두어를 추가할 수 있다. -->
    <prefix class="ch.qos.logback.classic.PatternLayout">
        <pattern>someapp:</pattern>
    </prefix>
</appender>

• 접두어 패턴으로 입력한 문자열은 syslog 서버에서 programname 항목으로 인식된다. 어펜더가 생성하는 JSON 형식의 로그는 msg 항목으로 인식된다.

syslog 서버에는 아래 형식으로 전송된다.

127.0.0.1    Jul 17 04:46:53                    someapp:{"created_datetime":"2016-07-17T04:46:53.342+09:00","@version":1,"message":"Started Application in 5.689 seconds (JVM running for 6.448)","logger_name":"com.jsonobject.example.Application","thread_name":"main","level":"INFO","level_value":20000,"HOSTNAME":"dev"}

syslog 서버에서는 아래와 같이 접두어를 기반으로 로그 저장소를 설정할 수 있다.

$ vi /etc/rsyslog.conf
:programname, isequal, "someapp" -/var/log/someapp.json

• 표현식으로는 isequal, startswith, contains를 사용할 수 있다.

$template SomeAppLogFormat,"%msg%\n"
$template SomeAppLogPath,"/var/log/someapp.json"
if $programname == 'someapp' then -?SomeAppLogPath;SomeAppLogFormat

Logstash 서버에서는 아래와 같이 환경 설정을 적용한다.

# Logstash 환경 설정 파일을 작성한다.
$ vi /etc/logstash/conf.d/someapp-filter.conf
filter {
  date {
    match => [ "created_datetime", "yyyy-MM-dd'T'HH:mm:ss.SSSZZ" ]
    target => "@timestamp"
  }
}

# 설정한 환경 설정에 문제가 없는지 확인한다.
$ service logstash configtest
Configuration OK

# 환경 설정을 적용하기 위해 Logstash를 재시작한다.
$ systemctl restart logstash

• 앞서 애플리케이션에서 created_datetime 필드에 담아 전송한 로그 생성 일시를 파씽하여 @timestamp 필드로 저장한다. 따라서 Kibana에서 로그 생성 일시를 기준으로 정렬된 결과를 편리하게 확인할 수 있다. (만약 애플리케이션의 LogstashSocketAppender이 제공하는 @timestamp 필드를 그대로 사용하면 Logstash는 이를 무시하고 수집한 시간으로 일괄 갱신해버린다. Logstash의 버그로 추정된다.)



• match에 사용되는 날짜 및 시간 형식은 Joda-Time의 DateTimeFormatter의 패턴 만이 허용된다.

참고 글

• Spring Boot features - Logging
• Logback JSON encoder
• Few Recommendations on Logging
• Java Logs are Boring? Powerful and Simple Techniques to Make Them Valuable!
• LoggingThe Ultimate Guide - Java
• Logback Redis Appender
• Centralized Logging with Logstash and Kibana On CentOS 7