feat: 로깅 추가

Author: jinwon1234

.github/workflows/deploy.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - feat/logging
 
 jobs:
   deploy:
@@ -68,7 +69,9 @@ jobs:
           key: ${{ secrets.EC2_PRIVATE_KEY }}
           script_stop: true
           script: |
-            docker pull ${{ steps.login-ecr.outputs.registry }}/music:${{env.date}}
-            docker stop music || true
-            docker rm music || true
-            docker run -d -e TZ=Asia/Seoul --name music -p 8080:8080 ${{ steps.login-ecr.outputs.registry }}/music:${{env.date}}
+            docker run -d \
+            -e TZ=Asia/Seoul \
+            --name music \
+            -p 8080:8080 \
+            -v /home/ubuntu/logs:/app/logs \
+            ${{ steps.login-ecr.outputs.registry }}/music:${{env.date}}

build.gradle

@@ -53,6 +53,9 @@ dependencies {
 
 	// validation
 	implementation 'org.springframework.boot:spring-boot-starter-validation'
+
+	// logstash
+	implementation 'net.logstash.logback:logstash-logback-encoder:7.4'
 }
 
 tasks.named('test') {

src/main/java/apptive/team5/config/SecurityConfig.java

@@ -74,6 +74,7 @@ public CorsConfigurationSource corsConfigurationSource() {
     private final String[] whiteList =
             {
                     "/api/jwt/exchange",
-                    "/api/oauth2/**"
+                    "/api/oauth2/**",
+                    "/api/users/throw"
             };
 }

src/main/java/apptive/team5/config/WebConfig.java

@@ -1,11 +1,25 @@
 package apptive.team5.config;
 
+import apptive.team5.filter.LoggingFilter;
+import org.springframework.boot.web.servlet.FilterRegistrationBean;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.web.config.EnableSpringDataWebSupport;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 import static org.springframework.data.web.config.EnableSpringDataWebSupport.PageSerializationMode.VIA_DTO;
 
 @Configuration
 @EnableSpringDataWebSupport(pageSerializationMode = VIA_DTO)
-public class WebConfig {
+public class WebConfig implements WebMvcConfigurer {
+
+    @Bean
+    public FilterRegistrationBean loggingFilter() {
+        FilterRegistrationBean registration = new FilterRegistrationBean();
+        registration.setFilter(new LoggingFilter());
+        registration.addUrlPatterns("/*");
+        registration.setOrder(1);
+
+       return registration;
+    }
 }

src/main/java/apptive/team5/filter/LoggingFilter.java

@@ -0,0 +1,32 @@
+package apptive.team5.filter;
+
+import jakarta.servlet.*;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import lombok.extern.slf4j.Slf4j;
+
+import java.io.IOException;
+import java.util.UUID;
+
+@Slf4j
+public class LoggingFilter implements Filter {
+    @Override
+    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
+
+        HttpServletRequest request = (HttpServletRequest) servletRequest;
+        HttpServletResponse response = (HttpServletResponse) servletResponse;
+        String loggingId = UUID.randomUUID().toString();
+
+        try {
+            long startTime = System.currentTimeMillis();
+            log.trace("[REQUEST] id:{}, request URI: {}, METHOD:{}", loggingId, request.getRequestURI(), request.getMethod());
+            filterChain.doFilter(request, response);
+            long endTime = System.currentTimeMillis();
+            log.trace("[RESPONSE] id:{},  HTTP STATUS:{}, TIME:{}ms ", loggingId, response.getStatus(), endTime - startTime);
+        } catch (Exception e) {
+            log.error("[REQUEST] id:{}, request URI: {}, METHOD:{}", loggingId, request.getRequestURI(), request.getMethod());
+            log.error("[RESPONSE] id:{}, ERROR:{}", loggingId, e.getMessage(), e);
+            throw e;
+        }
+    }
+}

src/main/java/apptive/team5/user/controller/UserController.java

@@ -24,4 +24,9 @@ public ResponseEntity<UserResponse> getMyInfo(@AuthenticationPrincipal String id
 
         return ResponseEntity.status(HttpStatus.OK).body(response);
     }
+
+    @GetMapping("/throw")
+    public ResponseEntity<?> throwException() {
+        throw new RuntimeException("This is a test");
+    }
 }

src/main/resources/logback-prod.xml

@@ -0,0 +1,28 @@
+<configuration>
+    <property name="LOG_FILE" value="application.log"/>
+
+    <!-- 콘솔 출력 -->
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level [%thread] %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <!-- 파일 출력 -->
+    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <file>${LOG_FILE}</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <fileNamePattern>application.%d{yyyy-MM-dd_HH-mm}.log.gz</fileNamePattern>
+            <maxHistory>5</maxHistory>
+        </rollingPolicy>
+        <encoder>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level [%thread] %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <!-- Logger 설정 -->
+    <root level="info">
+        <appender-ref ref="CONSOLE" />
+        <appender-ref ref="FILE" />
+    </root>
+</configuration>