Merge pull request #244 from EAT-SSU/feature/#243-plg-logging-stack

feat: 로깅 기능 구현

Author: yongjun0511

.github/workflows/deploy.yml

@@ -83,6 +83,9 @@ jobs:
             sudo docker rm -f $(docker ps -qa)
             sudo docker pull ${{ secrets.DOCKER_REPO }}/eatssu-prod
             sudo docker run -d -p 9000:9000 \
+            --log-driver=json-file \
+            --log-opt max-size=20m \
+            --log-opt max-file=5 \
             -e EATSSU_DB_URL_PROD="${{ secrets.EATSSU_DB_URL_PROD }}" \
             -e EATSSU_DB_USERNAME="${{ secrets.EATSSU_DB_USERNAME }}" \
             -e EATSSU_DB_PASSWORD="${{ secrets.EATSSU_DB_PASSWORD }}" \
@@ -107,6 +110,9 @@ jobs:
             sudo docker rm -f $(docker ps -qa)
             sudo docker pull ${{ secrets.DOCKER_REPO }}/eatssu-dev
             sudo docker run -d -p 9000:9000 \
+            --log-driver=json-file \
+            --log-opt max-size=20m \
+            --log-opt max-file=5 \            
             -e EATSSU_DB_URL_DEV="${{ secrets.EATSSU_DB_URL_DEV }}" \
             -e EATSSU_DB_USERNAME="${{ secrets.EATSSU_DB_USERNAME }}" \
             -e EATSSU_DB_PASSWORD="${{ secrets.EATSSU_DB_PASSWORD }}" \

Dockerfile

@@ -22,4 +22,4 @@ COPY --from=builder /home/gradle/project/build/libs/*.jar app.jar
 EXPOSE 9000
 
 # 애플리케이션 실행
-ENTRYPOINT ["java", "-jar", "app.jar"]
+ENTRYPOINT ["java", "-jar", "app.jar"]

build.gradle

@@ -80,6 +80,7 @@ def generated = 'src/main/generated'
 
 tasks.withType(JavaCompile) {
     options.getGeneratedSourceOutputDirectory().set(file(generated))
+    options.compilerArgs += ['-parameters']
 }
 
 sourceSets {
@@ -88,4 +89,4 @@ sourceSets {
 
 clean {
     delete file('src/main/generated')
-}
+}

src/main/java/ssu/eatssu/domain/auth/dto/AppleLoginRequest.java

@@ -1,9 +1,11 @@
 package ssu.eatssu.domain.auth.dto;
 
 import io.swagger.v3.oas.annotations.media.Schema;
+import ssu.eatssu.global.log.annotation.LogMask;
 
 @Schema(title = "애플 로그인 및 회원가입")
 public record AppleLoginRequest(
+        @LogMask
         @Schema(description = "identityToken", example = "eyJraWQiOiJXNldjT0tCIiwiYWxnIjoi...")
         String identityToken
 ) {

src/main/java/ssu/eatssu/domain/auth/dto/KakaoLoginRequest.java

@@ -3,14 +3,17 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.Email;
 import jakarta.validation.constraints.NotBlank;
+import ssu.eatssu.global.log.annotation.LogMask;
 
 @Schema(title = "카카오 로그인 및 회원가입")
 public record KakaoLoginRequest(
+        @LogMask
         @NotBlank(message = "이메일을 입력해주세요.")
         @Email(message = "올바른 이메일 주소를 입력해주세요.")
         @Schema(description = "이메일", example = "test@email.com")
         String email,
 
+        @LogMask
         @Schema(description = "providerId", example = "10378247832195")
         String providerId
 ) {

src/main/java/ssu/eatssu/domain/auth/dto/ValidRequest.java

@@ -2,9 +2,11 @@
 
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
+import ssu.eatssu.global.log.annotation.LogMask;
 
 @Schema(title = "유효한 토큰 확인")
 public record ValidRequest(
+        @LogMask
         @NotBlank(message = "토큰을 입력해주세요")
         @Schema(description = "토큰", example = "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ7XCJpZFwiOjcsXCJlbWFpbFwiOlwidGVzdEBlbWFpbC5jb21cIixcInJvbGVcIjpcIlJPTEVfVVNFUlwifSIsImF1dGgiOiJST0xFX1VTRVIiLCJleHAiOjE3NDQzNzQ0MjB9.mhIWYX_Vj3xW1eXuVflbzpH6vLTcC9b1twbIcqovVjDVnS7tjegu3nQHGXUsUa_WG2DIAtJMFZT_Q1XcVq1jPw")
         String token

src/main/java/ssu/eatssu/domain/inquiry/dto/CreateInquiryRequest.java

@@ -3,15 +3,18 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
+import ssu.eatssu.global.log.annotation.LogMask;
 
 @Schema(title = "문의 남기기")
 @NoArgsConstructor
 @Getter
 public class CreateInquiryRequest {
 
     @Schema(description = "답장 받을 이메일", example = "sandy1017@gmail.com")
+    @LogMask
     private String email;
 
     @Schema(description = "문의 내용", example = "어쩌고 저쩌고 문의 남깁니다")
+    @LogMask
     private String content;
 }

src/main/java/ssu/eatssu/domain/inquiry/service/InquiryService.java

@@ -1,6 +1,7 @@
 package ssu.eatssu.domain.inquiry.service;
 
 import lombok.RequiredArgsConstructor;
+import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 import ssu.eatssu.domain.auth.security.CustomUserDetails;
@@ -10,6 +11,7 @@
 import ssu.eatssu.domain.user.entity.User;
 import ssu.eatssu.domain.user.repository.UserRepository;
 import ssu.eatssu.global.handler.response.BaseException;
+import ssu.eatssu.global.log.event.LogEvent;
 
 import static ssu.eatssu.global.handler.response.BaseResponseStatus.NOT_FOUND_USER;
 
@@ -20,14 +22,23 @@ public class InquiryService {
 
     private final UserRepository userRepository;
     private final InquiryRepository inquiryRepository;
+    private final ApplicationEventPublisher eventPublisher;
 
     public Inquiry createUserInquiry(CustomUserDetails userDetails, CreateInquiryRequest request) {
         User user = userRepository.findById(userDetails.getId())
-                                  .orElseThrow(() -> new BaseException(NOT_FOUND_USER));
+                .orElseThrow(() -> new BaseException(NOT_FOUND_USER));
 
         Inquiry inquiry = new Inquiry(request.getContent(), user, request.getEmail());
+        Inquiry saved = inquiryRepository.save(inquiry);
 
-        return inquiryRepository.save(inquiry);
+        eventPublisher.publishEvent(LogEvent.of(String.format(
+                "Inquiry created: id=%d, userId=%d, status=%s",
+                saved.getId(),
+                user.getId(),
+                saved.getStatus()
+        )));
+
+        return saved;
     }
 
 }

src/main/java/ssu/eatssu/domain/menu/presentation/dto/response/MenusInMealResponse.java

@@ -6,6 +6,7 @@
 import lombok.NoArgsConstructor;
 import ssu.eatssu.domain.menu.entity.Meal;
 import ssu.eatssu.domain.menu.entity.MealMenu;
+import ssu.eatssu.domain.menu.entity.Menu;
 
 import java.util.List;
 
@@ -18,9 +19,8 @@ public class MenusInMealResponse {
     @Schema(description = "식단 속 메뉴 목록", example = "[]")
     private List<BriefMenuResponse> briefMenus;
 
-    public static MenusInMealResponse from(Meal meal) {
-        List<BriefMenuResponse> menusInformation = meal.getMealMenus().stream()
-                                                       .map(MealMenu::getMenu)
+    public static MenusInMealResponse from(List<Menu> menus) {
+        List<BriefMenuResponse> menusInformation =  menus.stream()
                                                        .map(BriefMenuResponse::new)
                                                        .toList();
 

src/main/java/ssu/eatssu/domain/menu/service/MealService.java

@@ -39,8 +39,15 @@ public class MealService {
     public MenusInMealResponse getMenusInMealByMealId(Long mealId) {
         Meal meal = mealRepository.findById(mealId)
                                   .orElseThrow(() -> new BaseException(BaseResponseStatus.NOT_FOUND_MEAL));
+        List<Menu> menus = meal.getMealMenus().stream()
+                .map(MealMenu::getMenu)
+                .toList();
+
+        if (menus.isEmpty()) {
+            log.warn("Meal[{}] has no menus.", mealId);
+        }
 
-        return MenusInMealResponse.from(meal);
+        return MenusInMealResponse.from(menus);
     }
 
     public List<MealDetailResponse> getMealDetailsByDateAndRestaurantAndTimePart(