[Spring Boot][Total-Back-Office Project] Log Back을 이용한 Discord에 Exception 정보 보내기 및 Data Base 저장 feat.MyBatis & Test Code(JUnit 5) - ① Log Back 설정

 

 

 

 

 

스프링 부트 3 백엔드 개발자 되기 : 자바 편

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

🗂 목차

🧑‍💻 코딩

✅  [Spring Boot][Total-Back-Office Project] AOP, Annotation을 이용한 API 동작 시간 측정
✅ [Spring Boot][Total-Back-Office Project] AOP, Annotation을 이용한 API 요청 이용자 정보 가져오기 feat.MyBatis & Test Code(JUnit 5) (https://junyharang.tistory.com/457)
✅ [Spring Boot][Total-Back-Office Project] Log Back을 이용한 Discord에 Exception 정보 보내기 및 Data Base  저장 feat.MyBatis & Test Code(JUnit 5) - ① Log Back 설정
✅ [Spring Boot][Total-Back-Office Project] Log Back을 이용한 Discord에 Exception 정보 보내기 및 Data Base 저장 feat.MyBatis & Test Code(JUnit 5) - ② 디스코드로 로그 정보 발송
✅ [Spring Boot][Total-Back-Office Project] Log Back을 이용한 Discord에 Exception 정보 보내기 및 Data Base 저장 feat.MyBatis & Test Code(JUnit 5) - ③ 로그 및 요청 이용자, 요청 정보 데이터 베이스에 저장

 

🚚 배포

⚠️ 아래 목차 중 몇몇개의 링크가 걸리지 않는 문제로 글 맨 하단에 다음 글로 이동할 수 있게 해 두었습니다.

✅ [CI/CD] Jenkins와 Gitea 연동
✅ [CI/CD] Jenkins Trigger 정보 Discord로 보내기
✅ [CI/CD] 정적 코드 분석 툴 SonarQube와 Jenkins 연동
✅ [CI/CD] SonarQube를 통해 Code Convention 적용
✅ [DevOps] JAVA Gradle JaCoCo (Code coverage) 설정하기 
✅ [DevOps] JAVA Gradle JaCoCo (Code coverage) 설정하기 (추가)(https://junyharang.tistory.com/392)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ① Application Linuxt(Ubuntu)에 SSH를 이용한 파일 전송
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ② Create Docker Image And BackUp
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (① Application 도커 존재 여부 확인)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (② Application Docker Run)(https://junyharang.tistory.com/406)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (③ Application Docker Health Check)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (① NGINX 각 종 설정) 
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (② NGINX Docker 존재 여부 확인) 
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (③ NGINX Docker Run & Health Check)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (③ NGINX 재 설정)

 

 

💾 Git Hub Repository : https://github.com/junyharang-personal-project/junyss-total-back-office

GitHub - junyharang-personal-project/junyss-total-back-office: [Back-Office] 디스코드 봇과 Logback, AOP 등을 이용하

 

 

 

 

🚀 Log Back을 이용한 Discord에 Exception 정보 보내기 및 Data Base 저장

    🔽 개요

        📦 소개

개발자가 API를 만들고, 실제 서비스 할 때, 이용자 요청이 잘 못 되거나, 악의적인 요청 등을 즉각적으로 확인할 수 있는 방법이 무엇일까? 를 고민해 보았어요.

많은 회사에서 여러 SNS를 이용해서 사내 커뮤니티 용으로 사용하고 있는데, 대표적으로 Slack, Discord, Telegram 등이 있어요.

그 중 주니는 화상 회의도 가능하고, 보다 편리하다고 생각되는 디스코드를 통해 사이드 프로젝트 SNS로 활용하고 있는데, Log Back을 이용하여 디스코드에 Exception 정보를 보낼 수 있고, 이를 Data Base에 저장한 뒤 이를 디스코드 봇을 통해 조회할 수 있도록 만들면 좋겠다고 생각했어요.

Java를 이용하여 디스코드 봇 만드는 방법은 이 곳에 준비해 두었어요.

https://junyharang.tistory.com/381

그럼 Log Back을 통해 디스코드에 Exception 정보 보내는 방법에 대해 정리해 볼게요.

참고로 주니가 개발한 API 구동 환경은 Local, Dev(개발 환경), Prod(운영 환경)으로 나누었고, Prod로 구성한 내용을 토대로 정리해 보려고 합니다.

 

 

    🔽 소스 코드 분석 (구현부)

        📦 logback-prod.xml

최초 주니가 작성한 logback 설정은 아래와 같아요.

<?xml version="1.0" encoding="UTF-8" ?>
<!-- 60초마다 설정 파일의 변경을 확인 하여 변경시 갱신 -->
<configuration scan="true" scanPeriod="60 seconds">
    <!--springProfile 태그를 사용하면 logback 설정파일에서 복수개의 프로파일을 설정할 수 있다.-->
    <springProfile name="local">
        <property resource="application-local-logback.yml"/>
        <property resource="application-local-environment.yml"/>
    </springProfile>
    <springProfile name="dev">
        <property resource="application-dev-logback.yml"/>
        <property resource="application-dev-environment.yml"/>
    </springProfile>
    <springProfile name="prod">
        <property resource="application-prod-logback.yml"/>
        <property resource="application-prod-environment.yml"/>
    </springProfile>
    <springProperty name="DISCORD_WEBHOOK_URI" source="logging.discord.webhook-uri"/>
    <property name="LOG_ROOT_PATH" value="log"/>
    <springProperty name="SERVER_NAME" source="server.name"/>
    <springProperty name="ENVIRONMENT" source="server.environment"/>
    <springProperty name="PORT" source="server.port"/>
    <property name="LOG_PATH_NAME" value="${LOG_ROOT_PATH}/${SERVER_NAME}/${ENVIRONMENT}-${PORT}/%d{yyyy-MM-dd}"/>
    <springProperty scope="context" name="LOG_LEVEL" source="logging.level.root"/>
    <property name="ERR_LOG_FILE_NAME" value="Error"/>
    <property name="LOG_FILE_NAME" value="Info"/>
    <property name="FILE_LOG_PATTERN" value="%-5level %d{yy-MM-dd HH:mm:ss} [%thread] [%logger{0}:%line] - %msg%n"/>

    <!--DiscordAppender 적용 -->
    <appender name="DISCORD"
              class="com.giggalpeople.backoffice.chatops.logback.appender.discord.append.DiscordAppender">
        <discordWebhookURL>${DISCORD_WEBHOOK_URI}</discordWebhookURL>
    </appender>

    <!-- Console appender 설정 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--     날짜       시간   로그레벨  로거이름  프로세스 ID  [로깅 발생 파일명]메소드 명,호출지 정보,(라인 수) 로그메세지 -->
            <pattern>[%d{yyyy-MM-dd}] [%d{HH:mm:ss.SSS}] [%p] ${PID:-} [%F] %M (%L\) : %m%n</pattern>
        </encoder>
    </appender>

    <!-- Log File 저장 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH_NAME}/${SERVER_NAME}.log</file>

        <!-- 출력패턴 설정-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>

        <!-- Rolling 정책 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH_NAME}/${LOG_FILE_NAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 파일당 최고 용량 kb, mb, gb -->
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거-->
            <maxHistory>180</maxHistory>
        </rollingPolicy>
    </appender>

    <!-- 에러의 경우 파일에 로그 처리 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <file>${LOG_PATH_NAME}/${ERR_LOG_FILE_NAME}-%d{yyyy-MM-dd}.%i.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_NAME}/${ERR_LOG_FILE_NAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 파일당 최고 용량 kb, mb, gb -->
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거-->
            <maxHistory>180</maxHistory>
        </rollingPolicy>
    </appender>

    <appender name="ASYNC_DISCORD" class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="DISCORD"/>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>WARN</level>
        </filter>
    </appender>

    <!-- 모든 로그 출력 (디코/파일) -->
    <root level="${LOG_LEVEL}">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="ASYNC_DISCORD"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="ERROR_FILE"/>
    </root>

    <!-- 특정패키지 로깅레벨 설정 -->
    <logger name="org.hibernate.SQL" level="DEBUG" additivity="false">
        <appender-ref ref="FILE"/>
        <appender-ref ref="ERROR_FILE"/>
    </logger>
</configuration>

최초 설정부에 대해 확인해 볼게요.

logback-prod.xml 1 ~ 16번째 줄

일단 위 내용은 각 구동 환경 (Profile)에 따른 설정 파일들에 내용을 참조하도록 설정 된 부분이에요.
해당 파일들을 통해 Application의 Logging 및 환경 설정을 구성할 수 있어요.

각 Tag에 대해 알아 볼게요.

Tag	내   용
<configuration>	설정 파일의 루트 요소로 scan 속성을 사용하여 설정 파일의 변경을 주기적으로 감지하여 변경 시 갱신할 지 여부를 지정해준다. scanPeriod 속성은 변경 감지 주기 설정부로 위 코드에서는 60초단위로 변경 감지 진행.
<springProfile>	프로파일 지정 시 사용되는 것으로 name 속성은 프로파일의 이름을 나타내며, 로깅 및 환경 설정 파일 참조를 위해 사용.
<property>	각 프로파일에 해당하는 로깅과 환경 설정 파일의 경로와 이름 지정하는 것으로 resource 속성을 사용하여 파일 경로 및 이름 지정.

주니는 위 Tag를 사용하여 각각의 구동 환경별로 참조되어야 하는 설정 파일들을 다르게 하고,
해당 내용을 참조하게 해 주었어요.

이렇게 하면 애플리케이션 프로파일에 따라 다른 로깅 및 환경 설정을 제공하여 개발, 테스트 및 운영 환경에 맞게 적합한
설정을 할 수 있게 된답니다.

 

logback-prod.xml 17 ~ 29번째 줄

위 내용은 로깅 관련 설정에 대한 내용인데, 해당 설정은 <property>와 <springProperty> 태그를 사용하여 정의하였고, 다양한 속성들을 이용하여 로그 파일의 경로, 이름, 로깅 패턴 등을 지정해 주었어요.

Tag	속성	속성 상세
<springProperty>	name="DISCORD_WEBHOOK_URI"	디스코드 Webhook URI를 logging.discord.webhook-uri 소스에서 가져와 환경 변수로 설정
	name="SERVER_NAME"	서버 이름 즉, 애플리케이션 구동 서버 이름을 설정 파일의 server.name에서 가져와 환경 변수로 설정.
	name="ENVIRONMENT"	서버 구동 환경을 설정 파일 server.environment 소스에서 가져와 환경 변수로 설정.
	name="PORT"	서버 구동 Listening Port를 설정 파일 server.port 소스에서 가져와 환경 변수로 설정
	name="LOG_LEVEL"	Log Level을 설정 파일 logging.level.root 소스에서 가져와 환경 변수로 설정. 이 때, scope="context"로 지정되어 Spring Context 범위 내 동작.
<property>	name="LOG_ROOT_PATH"	Log File이 저장될 Log Root 경로를 /log로 설정.
	name="LOG_PATH_NAME"	Log File 경로를  ${LOG_ROOT_PATH}/${SERVER_NAME}/${ENVIRONMENT}-${PORT}/%d{yyyy-MM-dd} 로 설정. ${} 부분은 앞 서 정의한 환경 변수를 참조하겠다는 의미로 실제 사용되는 Log File 경로는 각 환경 변수 값에 따라 결정.
	name="ERR_LOG_FILE_NAME"	Error Log File 이름을 Error로 설정.
	name="LOG_FILE_NAME"	Information Level Log File 이름을 Info로 설정.
	name="FILE_LOG_PATTERN"	File Log Pattern을  %-5level %d{yy-MM-dd HH:mm:ss} [%thread] [%logger{0}:%line] - %msg%n로 설정. 해당 Pattern은 Log Level, Log 발생 날짜 및 시간, Thread Info, Logger Name, Line Number, Log Detail Message 등 Log File 출력 형식 지정.

728x90

위와 같이 설정된 환경 변수와 프로퍼티들은 스프링에서 해당하는 값을 주입 받아 로깅 시스템을 구성할 수 있게 해준답니다.
각 환경에 맞는 서버 이름, 환경, 포트, 로깅 수준 등에 따라 다른 로그 파일 경로와 이름이 생성될 것이고, 특정 서버의 로그는 해당 경로에 저장되게 될 거에요.

또한, 디스코드 웹훅 URI를 통해 로그를 특정 채널로 전달할 수 있게 설정해 줄거에요.

logback-prod.xml 37 ~ 43번째 줄

최초 32 ~ 35번째 줄의 내용은 <appender> 태그를 이용하여 로그 출력 방식을 정의해준 부분이에요. 로그 출력 방식은 com.giggalpeople.backoffice.chatops.logback.appender.discord.append.DiscordAppender
Java Class를 사용하여 디스코드로 로그를 전송하는 방식을 설정해 준 부분이에요.

Tag 및 속성	상 세 내 용
name=DISCORD"	해당 appender Tag의 이름을 DISCORD로 지정. 위 이름은 Log 설정에서 해당 appender Tag를 참조할 때, 사용.
class="com.gi...."	해당 appender Tag가 사용할 Java Class인 DiscordAppender 지정. 해당 Class는 디스코드로 Log 전송 시 필요한 기능 담당.
<discordWebhookURL>	DiscordAppender Class에서 사용할 디스코드 웹훅의 URL 설정 부분. 이 URL은 위에서 정의한 ${DISCORD_WEBHOOK_URI} 환경 변수 사용하여 동적 지정. 즉, 애플리케이션에서 사용되는 실제 디스코드 웹훅 URL이 ${DISCORD_WEBHOOK_URI} 의 값에 따라 결정.

 

위 설정을 통해 DISCORD 라는 이름의 appender를 이용하여 애플리케이션의 로그를 디스코드 채널로 전송할 수 있게 해 주었어요. 디스코드 웹훅 URL은 환경 별수에 의해 동적으로 결정되기 때문에 다른 환경에서는 해당 디스코드 채널로 로그 전송하도록 쉽게 구성할 수 있게 해 주었답니다.


이번에는 38 ~ 43번째 줄 내용이에요.

위 내용은 또 다른 로그 출력 방식인 STDOUT (표준 출력) appender를 정의하고 있는 부분이에요.
즉, 로그를 콘솔에 출력하는 방식을 설정해 준 부분이에요.

태그 및 속성	요소	상 세 내 용
name="STDOUT"		해당 appender 이름을 STDOUT으로 지정. 이 이름은 로그 설정에서 이 appender 참조 시 사용.
class="ch.qos.log..."		해당 appender가 사용할 클래스인 ConsoleAppender 지정. 이 클래스는 콘솔에 로그를 출력하는 기능 담당.
<encoder class="">		Log 출력 형식 지정 시 사용되는 인코더 설정.
<pattern>		로그 메시지 출력 형식 지정 패턴 설정.
	%d{yyyy-MM-dd}	로그 메시지의 날짜를 연도-월-일 형식으로 표시.
	%d{HH:mm:ss.SSS}	로그 메시지 시간을 시:분:초.밀리초 형식으로 표시.
	%p	로그 레벨 (로그 메시지 우선 순위) 표시.
	${PID:-}	프로세스 ID 표시. 환경 변수 ${PID} 가 설정 되어 있지 않을 경우 빈 문자열 출력.
	[$F]	로깅 발생 파일명 출력.
	%M	로깅 발생 메소드 이름 출력.
	(%L)	로그 메시지 발생 라인 번호 출력.
	%m	로그 메시지 자체 출력.
	%n	줄 바꿈 문자 표시.

 

위 설정을 통해 STDOUT 이라는 이름의 appender를 사용하여 애플리케이션 로그를 콘솔에 출력하도록 설정해 주었어요.
로그 형식은 패턴을 통해 지정되기 때문에 로그 메시지에 원하는 정보를 표시되도록 설정해 준 부분이에요.

 

logback-prod.xml 45 ~ 64번째 줄

위 내용은 파일로 로그를 기록하는 FILE appender를 정의하고 있는 부분이에요.

이 appender는 로그를 시간 및 크기 기반으로 롤링하면서 여러 파일에 기록하는 방식으로 설정해 주었어요.

태그 및 속성	상 세 내 용
name="FILE"	해당 appender 이름을 FILE으로 지정. 이 이름은 로그 설정에서 이 appender 참조 시 사용.
class="ch.qos.log..."	해당 appender가 사용할 클래스인 RollingFileAppender 지정. 이 클래스는 로그를 롤링하여 여러 파일에 기록 기능 담당.
<file>	Log File 경로와 이름 설정. 앞서 정의한 ${LOG_PATH_NAME}, ${SERVER_NAME} 환경 변수 이용하여 실제 사용되는 Log File의 경로와 이름 결정.
<encoder>	로그 출력 형식 지정 시 사용되는 인코더 설정.
<pattern>	앞서 정의한 ${FILE_LOG_PATTERN} 을 통해 Log Message 출력 형식 지정.
<rollingPolicy>	롤링 정책 설정 부로 시간 기반 롤링 정책 사용.
<fileNamePattern>	롤링된 Log File의 File 이름 Pattern 지정. ${LOG_PATH_NAME}, ${LOG_FILE_NAME} 환경 변수와 시간 패턴을 사용하여 실제 File 이름 결정.
<timeBaseFileNamingAndTriggeringPolicy>	File 롤링 조건을 시간과 크기로 지정하는 정책 설정.
<maxFileSize>	File 최대 용량 100MB로 설정. 이 크기를 초과할 경우 새로운 File로 롤링.
<maxHistory>	일자별 Log File 최대 보관 주기 설정. 해당 설정일 이상으로 된 File은 자동 제거. 위에서는 180일로 지정되어 있기 때문에 180일 이상된 Log File은 삭제.

반응형

위 설정을 통해 FILE 이라는 이름의 appender를 사용하여 애플리케이션 로그를 파일에 기록하고, 로그를 일정 기간 또는 크기에 따라 롤링하면서 보존할 수 있도록 구성해 주었어요.

롤링된 파일들은 설정된 경로와 이름 패턴에 따라 생성되게 됩니다.

 

logback-prod.xml 66 ~ 89번째 줄

위 내용은 에러 레벨의 로그 파일로 기록하는 ERROR_FILE appender를 정의해 준 부분이에요.
해당 appender는 로그 레벨이 WARN 이상인 로그를 기록하고, 일정 기간 또는 크기에 따라 롤링하면서 여러 파일에 기록되도록 설정해 주었어요.

태그 및 속성	상 세 내 용
name="ERROR_FILE"	해당 appender 이름을 ERROR_FILE으로 지정. 이 이름은 로그 설정에서 이 appender 참조 시 사용.
class="ch.qos.log..."	해당 appender가 사용할 클래스인 RollingFileAppender 지정. 이 클래스는 로그를 롤링하여 여러 파일에 기록 기능 담당.
<filter>	로그 필터를 설정. 해당 필터는 WARN 레벨 이상 로그만 기록하도록 설정. ∙ <level>WARN</level>: WARN 레벨 이상의 로그만 기록하도록 필터 설정. ∙ <onMatch>ACCEPT</onMatch>: 필터와 일치하는 로그 레벨에 대해 기록 허용. ∙ <onMismatch>DENY</onMismatch>: 필터와 일치하지 않는 로그 레벨에 대해 기록 거부.
<file>	Log File 경로와 이름 설정. 앞서 정의한 ${LOG_PATH_NAME}, ${ERR_LOG_FILE_NAME} 환경 변수와 시간 패턴 이용하여 실제 사용되는 Log File의 경로와 이름 결정.
<encoder>	로그 출력 형식 지정 시 사용되는 인코더 설정.
<pattern>	앞서 정의한 ${LOG_PATTERN} 을 통해 Log Message 출력 형식 지정.
<rollingPolicy>	롤링 정책 설정 부로 시간 기반 롤링 정책 사용.
<fileNamePattern>	롤링된 Log File의 File 이름 Pattern 지정. ${LOG_PATH_NAME}, ${ERR_LOG_FILE_NAME} 환경 변수와 시간 패턴을 사용하여 실제 File 이름 결정.
<timeBaseFileNamingAndTriggeringPolicy>	File 롤링 조건을 시간과 크기로 지정하는 정책 설정.
<maxFileSize>	File 최대 용량 100MB로 설정. 이 크기를 초과할 경우 새로운 File로 롤링.
<maxHistory>	일자별 Log File 최대 보관 주기 설정. 해당 설정일 이상으로 된 File은 자동 제거. 위에서는 180일로 지정되어 있기 때문에 180일 이상된 Log File은 삭제.

 

위 설정을 통해 ERROR_FILE이라는 이름의 appender를 이용하여 애플리케이션의 에러 레벨 로그 파일에 기록하고, 로그를 일정 기간 또는 크기에 따라 롤링하면서 보존 되도록 해 주었어요.

롤링된 로그 파일등은 설정된 경로와 이름 패턴에 따라 생성되고, 로그 레벨 필터를 통해 WARN 이상의 로그만 기록되기 때문에 에러 레벨 로그만 해당 appender에 기록되게 해 준 부분이에요.

 

logback-prod.xml 91 ~ 96번째 줄

위 내용은 비동기 방식으로 디스코드로 로그를 전송하는 ASYNC_DISCORD appender를 정의해준 부분이에요.
해당 appender는 기존 DISCORD appender를 사용하면서 로그 레벨을 WARN 이상으로 제한하는 필터를 적용하여 WARN 이상의 로그만 디스코드로 전송될 수 있게 해 준 설정이에요.

태그 및 속성	상 세 내 용
name="ASYNC_DISCORD"	해당 appender 이름을 ASYNC_DISCORD로 지정. 이 이름은 로그 설정에서 이 appender 참조 시 사용.
class="ch.qos.log..."	해당 appender가 사용할 클래스인 AsyncAppender 지정. 이 클래스는 로그를 비동기적으로 전송하는 기능 담당.
<filter>	로그 필터를 설정. 해당 필터는 WARN 레벨 이상 로그만 전송하도록 설정. ∙ <level>WARN</level>: WARN 레벨 이상의 로그만 기록하도록 필터 설정.

 

위 설정을 통해 ASYNC_DISCORD라는 이름의 appender를 이용하여 애플리케이션의 WARN 이상의 로그를 비동기 방식으로 디스코드로 전송할 수 있도록 설정해 주었어요.

비동기 방식으로 로그를 처리하기 때문에 로그 기록과 전송이 별개의 Thread에서 처리 되어 로그 작업이 애플리케이션 주 Thread를 차단하지 않도록 설정해 주었어요.

이를 통해 로그 작업의 성능과 응답성을 향상 시킬 수 있을거에요.

 

logback-prod.xml 98 ~ 111번째 줄

위 내용은 로그의 루트 설정과 특정 패키지(org.hibernate.SQL) 로깅 레벨 설정을 정의해준 부분이에요.

root와 logger 요소를 사용하여 각각 전체 로그 및 특정 패키지 로그에 대해 설정을 구성해 주었답니다.

태그 및 속성	상 세 내 용
<root level="${LOG_LEVEL}">	애플리케이션 전체 root Log 설정 정의. ∙ level"=${LOG_LEVEL}: ${LOG_LEVEL} 환경 변수 값에 따라 root Log Level 설정 ${LOG_LEVEL} 환경 변수는 앞서 정의한 환경 변수 중 LOG_LEVEL에 해당. ∙ <appender-ref ref="STDOUT"/>: root Logger STDOUT appender 추가. 이로 인해 root Log는 Console에 출력. ∙ <appender-ref ref="ASYNC_DISCORD"/>: root Logger에 ASYNC_DISCORD appender 추가. 이로 인해 root Log는 비동기 방식으로 디스코드에 전송. ∙<appender-ref ref="FILE"/>: root Logger에 FILE appender 추가. 이로 인해 root Log는 File에 기록. ∙ <appender-ref ref="ERROR_FILE"/>: root Logger에 ERROR_FILE appender 추가. 이로 인해 root Log 중 WARN 이상의 Log는 따로 File에 저장.
<logger name="org.hibernate.SQL" level="DEBUG" additivity="false">	특정 패키지인 org.hibernate.SQL에 대한 Log 설정. ∙ name="org.hibernate.SQL": 해당 Logger 이름을 org.hibernate.SQL로 설정. ∙ level="DEBUG": org.hibernate.SQL Package에 대한 Log Level을 DEBUG로 설정. ∙ additivity="false": 추가적인 Logger에게 Event 전파되지 않도록 설정. 이 Logger에서 기록된 Log Event는 부로 Logger로 전파되지 않음.

 

위 설정을 통해 애플리케이션 전체 로그 레벨과 각 로거(루트 로거 및 org.hibernate.SQL 로거)에 대해 로그 레벨과 출력 방식 정의해 주었어요.

로그 레벨, 출력 방식 및 비동기 설정을 조합하여 로깅 시스템을 유연하고, 효과적으로 구성해 보았습니다.

 

 

 

        📦 application-logback.yml

이번에는 환경 설정 부분을 살펴 볼게요.

logging:
  config: classpath:logback-${spring.profiles.active}.xml
  discord:
    webhook-uri: {디스코드 웹훅 URI}

  level:
    root: WARN

    org:
      hibernate:
        type:
          descriptor:
            sql:
              BasicBinder: TRACE
        SQL: INFO
  logback:
    rollingpolicy:
      max-history: 180
      max-file-size: 100MB

log:
  file:
    path: /var/log/Giggal-Total-Back-Office/*/Error_0.log

위의 내용을 통해 Log Back 환경 설정을 해 주었어요.

최초 Log Back 설정은 아래와 같아요.

 

속성	상 세 내 용
logging.config	Logback 설정 파일 위치를 classpath:logback-${spring.profiles.active}.xml로 지정. ${spring.profiles.active}는 스프링 프로필을 나타내며, 해당 값에 따라 실제 logback 설정 파일 결정.
logging.discord	디스코드 웹훅(Webhook) URI를 설정하는 부분. 이는 로깅 이벤트를 디스코드로 보내기 위한 설정.
logging.level	log level 설정부. ∙ root: Root Logger Level을 WARN으로 설정. Root Logger는 다른 Logger의 상위    Logger로써, 모든 Log Event를 받는다. 이 설정을 통해 WARN Level 이상의 Log만    기록하도록 설정. ∙org.hibernate: org.hibernate Package에 대한 Log Level 설정.   - type.descriptor.sqlBasicBinder:      org.hibernate.type.descriptor.sql.BasicBinder      클래스에 대한 Log Level을 TRACE로 설정. TRACE Level은 가장 상세한 Log Level로      SQL Parameter Binding과 관련된 모든 Log 기록을 위해 설정.  - SQL: org.hibernate.SQL: 클래스에 대한 Log Level을 INFO로 설정. INFO Level은 SQL     문장들을 기록하기 위하여 설정.
logging.logback	Logback 설정 추가 속성 지정. ∙rollingpolicy Log File Rolling 정책 설정.  - rollingpolicy: Log File Rolling 정책 설정부.  - max-history: Log File 최대 보관 기간 180일로 설정.  - max-file-size: 하나의 Log File 최대 크기를 100MB로 설정.

 

그런 뒤 로그 파일 설정은 로그 파일이 저장될 경로 /var/log/....Error_0.log로 설정해 주었어요.
이는 Docker Container로 배포할 예정이고, 해당 Container 안에 위 디렉터리에 로그를 저장하기 위함이에요.

* 와일드카드로, 어떤 값이 들어오더라도 해당 위치의 로그 파일을 사용하겠다고 해 주었어요.

주니는 스프링 부트에서 Logback을 취와 같이 설정해 주었고, 고르 레벨 및 파일 롤링 정책 등을 설정하여 로깅을 조정하고, 디스코드 웹훅을 이용하여 로그 이벤트를 디스코드로 전송할 수 있도록 준비해 주었어요.

다음 글에서는 본격적으로 디스코드로 로그 정보를 보내고, 이를 데이터 베이스에 저장하는 방법에 대해 분석해 볼게요!