[Management] 날짜 별 로그 생성

 

로그 관리

날짜별로 로그를 관리하고, 에러 로그도 따로 관리하기 위해
일정 날짜가 지나면 자동으로 로그를 모아주는 기능과
에러 로그를 모아서 관리하는 기능을 추가하였습니다.

 

 

1. /src/main/resources application.properties

#로그레벨설정
logging.level.root=info
logging.level.com.test.box=info
logging.level.com.test.box.controller=debug
logging.level.web:info

#logging config
logging.config=classpath:logging-spring.xml //아래 생성하는 xml 파일 이름

 

2. /src/main/resources logging-spring.xml 파일 생성

LOG_PATH와 LOG_FILE_NAME이 적용되지 않고, LOG_FILE_IS_UNDEFINED 오류가 발생하여, 직접 입력했습니다. 위에 오류는 properties에 정의한 logging.path를 가져오지 못해서 생기는 오류이며 추후에 수정할 예정입니다.

<?xml version="1.0" encoding="UTF-8"?>
<!-- 60초마다 설정 파일의 변경을 확인 하여 변경시 갱신 -->
<configuration scan="true" scanPeriod="60 seconds">

<!--springProfile 태그를 사용하면 logback 설정파일에서 복수개의 프로파일을 설정할 수 있다.-->
<!--    <springProfile name="local">-->
<!--        <property resource="logback-local.properties"/>-->
<!--    </springProfile>-->

<!--    <springProfile name="dev">-->
<!--        <property resource="logback-dev.properties"/>-->
<!--    </springProfile>-->

    <!--Environment 내의 프로퍼티들을 개별적으로 설정할 수도 있다.-->
    <springProperty scope="context" name="LOG_LEVEL" source="logging.level.root"/>

    <!-- log file path -->
    <property name="LOG_PATH" value="C:/Users/log"/>
    <!-- log file name -->
    <property name="LOG_FILE_NAME" value="daily_log"/>
    <!-- err log file name -->
    <property name="ERR_LOG_FILE_NAME" value="err_log"/>
    <!-- pattern -->
    <property name="LOG_PATTERN" value="%-5level %d{yy-MM-dd HH:mm:ss}[%thread] [%logger{0}:%line] - %msg%n"/>

    <!-- Console Appender -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- File Appender -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 파일경로 설정 -->
        <file>${LOG_PATH}/${LOG_FILE_NAME}.log</file>
        <!-- 출력패턴 설정-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>

        </encoder>
        <!-- Rolling 정책 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- .gz,.zip 등을 넣으면 자동 일자별 로그파일 압축 -->
            <fileNamePattern>${LOG_PATH}/${LOG_FILE_NAME}.%d{yyyy-MM-dd}_%i.zip</fileNamePattern>
            <!-- 파일당 최고 용량 kb, mb, gb -->
            <maxFileSize>10MB</maxFileSize>
            <!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거-->
            <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_NAME}.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
        <!-- Rolling 정책 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- .gz,.zip 등을 넣으면 자동 일자별 로그파일 압축 -->
            <fileNamePattern>${LOG_PATH}/${ERR_LOG_FILE_NAME}.%d{yyyy-MM-dd}_%i.log</fileNamePattern>
            <!-- 파일당 최고 용량 kb, mb, gb -->
            <maxFileSize>10MB</maxFileSize>
            <!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거-->
            <maxHistory>60</maxHistory>
        </rollingPolicy>
    </appender>

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

    <logger name="org.apache.ibatis" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="Error"/>
    </logger>

    <!-- log4jdbc 옵션 설정 -->
    <logger name="jdbc" level="OFF"/>
    <!-- 커넥션 open close 이벤트를 로그로 남긴다. -->
    <logger name="jdbc.connection" level="OFF"/>
    <!-- SQL문만을 로그로 남기며, PreparedStatement일 경우 관련된 argument 값으로 대체된 SQL문이 보여진다. -->
    <logger name="jdbc.sqlonly" level="OFF"/> <!-- SQL문과 해당 SQL을 실행시키는데 수행된 시간 정보(milliseconds)를 포함한다. -->
    <logger name="jdbc.sqltiming" level="DEBUG"/>
    <!-- ResultSet을 제외한 모든 JDBC 호출 정보를 로그로 남긴다. 많은 양의 로그가 생성되므로 특별히 JDBC 문제를 추적해야 할 필요가 있는 경우를 제외하고는 사용을 권장하지 않는다. -->
    <logger name="jdbc.audit" level="OFF"/>
    <!-- ResultSet을 포함한 모든 JDBC 호출 정보를 로그로 남기므로 매우 방대한 양의 로그가 생성된다. -->
    <logger name="jdbc.resultset" level="OFF"/>
    <!-- SQL 결과 조회된 데이터의 table을 로그로 남긴다. -->
    <logger name="jdbc.resultsettable" level="OFF"/>

</configuration>

추가 적으로 RollingPollicy 부분은 요구 조건을 충족하면 발생하기 때문에 daily_log에 로그가 쌓이다가 지정한 파일 크기 또는 다음 날짜로 넘어갔을 때 지정된 파일 형태로 생성됩니다.

 

3. 적용 완료 & 테스트

 

 

SQL 로그 관리 (log4jdbc)

hibernate가 생성하는 query를 로그에 저장하기 위한 설정

 

4. gradle dependency 추가

implementation group: 'org.bgee.log4jdbc-log4j2', name: 'log4jdbc-log4j2-jdbc4.1', version: '1.16'
implementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.36'
testImplementation group: 'org.slf4j', name: 'slf4j-log4j12', version: '1.7.36', ext: 'pom'

 

5. application.properties 수정

<수정전>
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/dbname?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Seoul

<수정후>
spring.datasource.driver-class-name=net.sf.log4jdbc.sql.jdbcapi.DriverSpy
spring.datasource.url=jdbc:log4jdbc:mysql://localhost:3306/dbname?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Seoul

 

6.  /src/main/resources log4jdbc.log4j2.properties 생성

log4jdbc.spylogdelegator.name=net.sf.log4jdbc.log.slf4j.Slf4jSpyLogDelegator

 

7. 작업 완료 및 테스트

DEBUG 22-10-24 11:09:26[http-nio-8080-exec-4] [sqltiming:368] -  com.zaxxer.hikari.pool.ProxyPreparedStatement.executeQuery(ProxyPreparedStatement.java:52)
1. select customer0_.id as id1_5_0_, customer0_.created_date as created_2_5_0_, customer0_.created_id 
as created_3_5_0_, customer0_.modified_date as modified4_5_0_, customer0_.modified_id as modified5_5_0_, 
customer0_.address as address6_5_0_, customer0_.business_category as business7_5_0_, customer0_.business_condition 
as business8_5_0_, customer0_.business_register_number as business9_5_0_, customer0_.code as 
code10_5_0_, customer0_.contact_point as contact11_5_0_, customer0_.email_address as email_a12_5_0_, 
customer0_.english_address as english13_5_0_, customer0_.fax_number as fax_num14_5_0_, customer0_.is_valid 
as is_vali15_5_0_, customer0_.manager as manager16_5_0_, customer0_.memo as memo17_5_0_, customer0_.name 
as name18_5_0_, customer0_.owner_name as owner_n19_5_0_, customer0_.telephone as telepho20_5_0_, 
customer0_.type as type21_5_0_ from customer customer0_ where customer0_.id=1 
 {executed in 1 msec}

 

[참고]

1. 스프링 빠르게 로그파일 만들기