feat: ✨ Log System Implementation (#221)

* chore: ignore log directory * feat: logging xml * chore: add log property in the external-api-module * chore: external-api logging setting * chore: external-api logback-spring.xml * fix: external-api log total-size-cap to 10mb * chore: add file max capacity * chore: ignore logs directory * chore: socket log config setting * chore: socket server logback setting
CollaBu · Jan 15, 2025 · 0c3a98f · 0c3a98f
1 parent dd54569
commit 0c3a98f
Show file tree

Hide file tree

Showing 6 changed files with 200 additions and 2 deletions.
diff --git a/pennyway-app-external-api/.gitignore b/pennyway-app-external-api/.gitignore
@@ -42,4 +42,7 @@ bin/
 .DS_Store
 
 ## Test API
-src/main/java/kr/co/pennyway/api/apis/test
+src/main/java/kr/co/pennyway/api/apis/test
+
+## Log Files
+**/logs
diff --git a/pennyway-app-external-api/src/main/resources/application.yml b/pennyway-app-external-api/src/main/resources/application.yml
@@ -35,6 +35,10 @@ springdoc:
     groups:
       enabled: true
 
+log:
+  config:
+    filename: app-local
+
 ---
 spring:
   config:
@@ -53,6 +57,13 @@ springdoc:
     groups:
       enabled: true
 
+log:
+  config:
+    filename: app-dev
+    maxHistory: 7
+    maxFileSize: 10MB
+    totalSizeCap: 500MB
+
 ---
 spring:
   config:

diff --git a/pennyway-app-external-api/src/main/resources/logback-spring.xml b/pennyway-app-external-api/src/main/resources/logback-spring.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <!-- 프로파일별 설정 파일 로드 -->
+    <springProfile name="local,dev,prod">
+        <property resource="application.yml"/>
+    </springProfile>
+
+    <!-- 로그 설정 프로퍼티 -->
+    <property name="LOG_PATH" value="./pennyway-app-external-api/src/main/resources/logs"/>
+    <springProperty name="LOG_FILE_NAME" source="log.config.filename"/>
+    <springProperty name="LOG_MAX_FILE_SIZE" source="log.config.maxFileSize"/>
+    <springProperty name="LOG_MAX_HISTORY" source="log.config.maxHistory"/>
+    <springProperty name="LOG_TOTAL_SIZE_CAP" source="log.config.totalSizeCap"/>
+
+    <!-- 로그 패턴에 색상 적용 -->
+    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
+
+    <!-- 로그 패턴 설정 -->
+    <property name="CONSOLE_LOG_PATTERN"
+              value="[%d{yyyy-MM-dd HH:mm:ss}:%-3relative]  %clr(%-5level) %clr(${PID:-}){magenta} %clr(---){faint} %clr([%15.15thread]){faint} %clr(%-40.40logger{36}){cyan} %clr(:){faint} %msg%n"/>
+    <property name="FILE_LOG_PATTERN"
+              value="[%d{yyyy-MM-dd HH:mm:ss}:%-3relative] %-5level ${PID:-} --- [%15.15thread] %-40.40logger{36} : %msg%n"/>
+
+    <!-- 콘솔 출력 설정 -->
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <layout class="ch.qos.logback.classic.PatternLayout">
+            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
+        </layout>
+    </appender>
+
+    <!-- 파일 출력 설정 -->
+    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <!--        <file>${LOG_PATH}/${LOG_FILE_NAME}.log</file>-->
+        <encoder>
+            <pattern>${FILE_LOG_PATTERN}</pattern>
+        </encoder>
+
+        <!-- 에러 발생시 무시하도록 설정 -->
+        <prudent>true</prudent>
+
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <!-- 롤링된 파일 명명 규칙 -->
+            <fileNamePattern>${LOG_PATH}/%d{yyyy-MM-dd}/${LOG_FILE_NAME}.%i.log</fileNamePattern>
+            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+                <!-- 파일당 최대 크기 -->
+                <maxFileSize>${LOG_MAX_FILE_SIZE}</maxFileSize>
+            </timeBasedFileNamingAndTriggeringPolicy>
+            <!-- 보관 주기 -->
+            <maxHistory>${LOG_MAX_HISTORY}</maxHistory>
+            <!-- 총 파일 크기 제한 -->
+            <totalSizeCap>${LOG_TOTAL_SIZE_CAP}</totalSizeCap>
+        </rollingPolicy>
+    </appender>
+
+    <!-- 프로파일별 로그 설정 -->
+    <springProfile name="local">
+        <root level="info">
+            <appender-ref ref="CONSOLE"/>
+        </root>
+    </springProfile>
+
+    <springProfile name="dev">
+        <root level="info">
+            <appender-ref ref="CONSOLE"/>
+        </root>
+
+        <logger name="org.springframework.web" level="debug" additivity="false">
+            <appender-ref ref="FILE"/>
+        </logger>
+    </springProfile>
+
+    <springProfile name="prod">
+        <root level="info">
+            <appender-ref ref="CONSOLE"/>
+        </root>
+        <logger name="org.springframework.web" level="debug" additivity="false">
+            <appender-ref ref="FILE"/>
+        </logger>
+    </springProfile>
+</configuration>
diff --git a/pennyway-socket/.gitignore b/pennyway-socket/.gitignore
@@ -43,4 +43,7 @@ bin/
 
 ### Test ###
 src/main/resources/compose.yml
-src/main/resources/static/
+src/main/resources/static/
+
+## Log files ##
+**/logs
diff --git a/pennyway-socket/src/main/resources/application.yml b/pennyway-socket/src/main/resources/application.yml
@@ -39,12 +39,23 @@ spring:
     activate:
       on-profile: local
 
+log:
+  config:
+    filename: socket-local
+
 ---
 spring:
   config:
     activate:
       on-profile: dev
 
+log:
+  config:
+    filename: socket-dev
+    maxHistory: 7
+    maxFileSize: 10MB
+    totalSizeCap: 500MB
+
 ---
 spring:
   config:

diff --git a/pennyway-socket/src/main/resources/logback-spring.xml b/pennyway-socket/src/main/resources/logback-spring.xml
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <!-- 프로파일별 설정 파일 로드 -->
+    <springProfile name="local,dev,prod">
+        <property resource="application.yml"/>
+    </springProfile>
+
+    <!-- 로그 설정 프로퍼티 -->
+    <property name="LOG_PATH" value="./pennyway-socket/src/main/resources/logs"/>
+    <springProperty name="LOG_FILE_NAME" source="log.config.filename"/>
+    <springProperty name="LOG_MAX_FILE_SIZE" source="log.config.maxFileSize"/>
+    <springProperty name="LOG_MAX_HISTORY" source="log.config.maxHistory"/>
+    <springProperty name="LOG_TOTAL_SIZE_CAP" source="log.config.totalSizeCap"/>
+
+    <!-- 로그 패턴에 색상 적용 -->
+    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
+
+    <!-- WebSocket 서버용 로그 패턴 설정 - 세션 ID와 연결 상태 정보 포함 -->
+    <property name="CONSOLE_LOG_PATTERN"
+              value="[%d{yyyy-MM-dd HH:mm:ss}:%-3relative]  %clr(%-5level) %clr(${PID:-}){magenta} %clr(---){faint} %clr([%15.15thread]){faint} %clr(%-40.40logger{36}){cyan} %clr(:){faint} %msg%n"/>
+    <property name="FILE_LOG_PATTERN"
+              value="[%d{yyyy-MM-dd HH:mm:ss}:%-3relative] %-5level ${PID:-} --- [%15.15thread] %-40.40logger{36} : %msg%n"/>
+
+    <!-- 콘솔 출력 설정 -->
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <layout class="ch.qos.logback.classic.PatternLayout">
+            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
+        </layout>
+    </appender>
+
+    <!-- 파일 출력 설정 -->
+    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <encoder>
+            <pattern>${FILE_LOG_PATTERN}</pattern>
+        </encoder>
+
+        <!-- 에러 발생시 무시하도록 설정 -->
+        <prudent>true</prudent>
+
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <!-- 롤링된 파일 명명 규칙 -->
+            <fileNamePattern>${LOG_PATH}/%d{yyyy-MM-dd}/${LOG_FILE_NAME}.%i.log</fileNamePattern>
+            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+                <!-- 파일당 최대 크기 -->
+                <maxFileSize>${LOG_MAX_FILE_SIZE}</maxFileSize>
+            </timeBasedFileNamingAndTriggeringPolicy>
+            <!-- 보관 주기 -->
+            <maxHistory>${LOG_MAX_HISTORY}</maxHistory>
+            <!-- 총 파일 크기 제한 -->
+            <totalSizeCap>${LOG_TOTAL_SIZE_CAP}</totalSizeCap>
+        </rollingPolicy>
+    </appender>
+
+    <!-- 프로파일별 로그 설정 -->
+    <springProfile name="local">
+        <root level="info">
+            <appender-ref ref="CONSOLE"/>
+        </root>
+    </springProfile>
+
+    <springProfile name="dev">
+        <root level="info">
+            <appender-ref ref="CONSOLE"/>
+        </root>
+
+        <!-- WebSocket 관련 로거 설정 -->
+        <logger name="org.springframework.web.socket" level="debug" additivity="false">
+            <appender-ref ref="FILE"/>
+        </logger>
+
+        <logger name="org.springframework.messaging" level="debug" additivity="false">
+            <appender-ref ref="FILE"/>
+        </logger>
+    </springProfile>
+
+    <springProfile name="prod">
+        <root level="info">
+            <appender-ref ref="CONSOLE"/>
+        </root>
+
+        <!-- WebSocket 관련 로거 설정 -->
+        <logger name="org.springframework.web.socket" level="debug" additivity="false">
+            <appender-ref ref="FILE"/>
+        </logger>
+
+        <logger name="org.springframework.messaging" level="debug" additivity="false">
+            <appender-ref ref="FILE"/>
+        </logger>
+    </springProfile>
+</configuration>