Log

로그는 표시를 위해 남긴다. 프로그램 개발이나 운영 시 발생하는 문제점을 추적 하거나 운영 상태를 모니터링 하는 정보를 기록하는 것이다.

저희 팀은 access, api, db, error 4개의 파일 형태로 로그를 남기기로 했고, 추후에 ELK를 적용하여 로그를 검색할 예정입니다.
현재는 logback을 사용하고 있는데 추후에 성능이 더 좋은 log4j2로 마이그레이션 할 예정입니다.

logback

java spring 자체에서 제공하는 logback을 사용하기 위해서는 logback-spring.xml로 파일을 생성해주어야 합니다.
다른 설정을 사용하여 logback.xml 사용도 가능합니다.

logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- 60초마다 설정 파일의 변경을 확인 하여 변경시 갱신 -->
<configuration scan="true" scanPeriod="60 seconds">
    <springProperty scope="context" name="LOG_LEVEL" source="${logging.level.root}"/>
    <!-- pattern 간략히 보여줌 -->
    <property name="LOG_PATTERN" value="%-5level %d{yy-MM-dd HH:mm:ss} - %msg%n"/>
    <!-- API -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 파일경로 설정 -->
        <file>${LOG_PATH}/api.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}/api.%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>
        <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.%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>
        </rollingPolicy>
    </appender>
    <!-- DB -->
    <appender name="DB" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 파일경로 설정 -->
        <file>${LOG_PATH}/db.log</file>
        <!-- 출력패턴 설정-->
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
        <!-- Rolling 정책 -->
        <rollingPolicy
                class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- .gz,.zip 등을 넣으면 자동 일자별 로그파일 압축 -->
            <fileNamePattern>${LOG_PATH}/db.%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>

    <!-- root레벨 설정 -->
    <root level="${LOG_LEVEL}">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="Error"/>
    </root>

    <logger name="org.hibernate.SQL" level="DEBUG" additivity="false">
        <appender-ref ref="DB"/>
    </logger>
    <logger name="org.hibernate.type" level="TRACE" additivity="false">
        <appender-ref ref="DB"/>
    </logger>
</configuration>

tomcat을 이용한 logback

application.yml에 아래와 같은 설정으로 access.log를 남길 수도 있습니다.

server:
  tomcat:
    accesslog:
      directory: /[access log path]/
      enabled: true
      file-date-format: .yyyy-MM-dd
      max-days: 14
      pattern: '%h %l %u %t "%r" %s %b %D'
      prefix: test_access
      rotate: true
      suffix: .log
    basedir: /[tomcat base directory]/

저희 팀의 로그 전략에 맞는 파일 생성과 패턴을 활용하기 위해 logback-access.xml을 활용하는 방법을 사용했습니다.
tomcat을 이용하여 logback을 사용하기 위해서는 tomcat에 logbackValve를 연결해야 합니다.
web.xml을 활용하는 방법이 있는데 springboot에서는 configuration을 이용하여 web.xml에 설정을 추가해야하기 때문에 tomcat만 설정하는 코드를 구현했습니다.

@Configuration
public class TomcatConfig implements WebServerFactoryCustomizer {
    @Override
    public void customize(WebServerFactory factory) {
        TomcatServletWebServerFactory containerFactory = (TomcatServletWebServerFactory)factory;

        LogbackValve logbackValve = new LogbackValve();
        logbackValve.setFilename("src/main/resources/logback/logback-access.xml");
        containerFactory.addContextValves(logbackValve);
    }
}

logback-access.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener"/>

    <appender name="ACCESS_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/access.log</file>
        <encoder>
            <pattern>%fullRequest%fullResponse</pattern>
        </encoder>
        <rollingPolicy
                class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/access.%d{yyyy-MM-dd}_%i/.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <appender-ref ref="ACCESS_FILE"/>
</configuration>

api.log 출력

모든 Controller의 메서드 호출을 log로 남기기 위해 interceptor를 이용하여 log를 남겼습니다.
interceptor에서 prehandle에서 내용을 출력하게 시도해보았는데 되지 않았고, afterComletion에 구현해야 로그가 남겨졌습니다.
그 요청에 해당하는 params, request body, response body를 출력하기 위해 filter를 사용했습니다.
tomcat에서 httpservletrequet, response의 값을 한번 읽어들이면 그 이후부터는 값들을 읽어올 수 없기 때문에 filter에서 값을 cache하여 사용합니다.

public class LogServletWrappingFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(
        HttpServletRequest request,
        HttpServletResponse response,
        FilterChain filterChain
    ) throws ServletException, IOException {
        ContentCachingRequestWrapper wrappingRequest = new ContentCachingRequestWrapper(request);
        ContentCachingResponseWrapper wrappingResponse = new ContentCachingResponseWrapper(response);
        filterChain.doFilter(wrappingRequest, wrappingResponse);
        wrappingResponse.copyBodyToResponse();
    }
}

@Override
    public void afterCompletion(
        HttpServletRequest request,
        HttpServletResponse response,
        Object handler,
        Exception exception
    ) throws Exception {
        ContentCachingRequestWrapper cachingRequest = (ContentCachingRequestWrapper)request;
        ContentCachingResponseWrapper cachingResponse = (ContentCachingResponseWrapper)response;

        String params = request.getParameterMap()
            .entrySet()
            .stream()
            .map(entry -> String.format("{\"%s\":\"%s\"}", entry.getKey(), Arrays.toString(entry.getValue())))
            .collect(Collectors.joining(","));
        log.warn("Params : {}", params);
        log.warn(
            "RequestBody : {} / ResponseBody : {}",
            objectMapper.readTree(cachingRequest.getContentAsByteArray()),
            objectMapper.readTree(cachingResponse.getContentAsByteArray())
        );
    }

Log - woowacourse-teams/2020-zeze GitHub Wiki

log

logback

tomcat을 이용한 logback

api.log 출력

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️