FEAT: 로그 ELK LOGSTASH 출력

jhkim31 · jhkim31 · commit 4371272aa2bf · 2024-08-12T16:28:00.000+09:00
* LogstashEncoder json 출력
diff --git a/Dockerfile b/Dockerfile
@@ -12,6 +12,10 @@ ARG JWT_SECRET_KEY
 ARG REDIS_HOST
 ARG REDIS_PORT
 ARG REDIS_PASSWORD
+ARG LOGSTASH_HOST
+ARG LOGSTASH_PORT
+
+ENV VERSION=${VERSION}
 
 ENV MYSQL_HOST=${MYSQL_HOST}
 ENV MYSQL_PORT=${MYSQL_PORT}
@@ -23,7 +27,9 @@ ENV JWT_SECRET_KEY=${JWT_SECRET_KEY}
 ENV REDIS_HOST=${REDIS_HOST}
 ENV REDIS_PORT=${REDIS_PORT}
 ENV REDIS_PASSWORD=${REDIS_PASSWORD}
-ENV VERSION=${VERSION}
+
+ENV LOGSTASH_HOST=${LOGSTASH_HOST}
+ENV LOGSTASH_PORT=${LOGSTASH_PORT}
 
 RUN microdnf install findutils
 
diff --git a/build.gradle b/build.gradle
@@ -41,6 +41,7 @@ subprojects {
         // spring
 
         // utils
+        implementation 'net.logstash.logback:logstash-logback-encoder:8.0'
         compileOnly 'org.projectlombok:lombok'
         annotationProcessor 'org.projectlombok:lombok'
         implementation 'com.fasterxml.jackson.core:jackson-databind'
diff --git a/core/src/main/java/jshop/core/config/P6SpyConfig.java b/core/src/main/java/jshop/core/config/P6SpyConfig.java
@@ -9,6 +9,7 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Profile;
 
+@Profile("dev")
 @Configuration
 public class P6SpyConfig implements MessageFormattingStrategy {
 
diff --git a/core/src/main/java/jshop/core/domain/address/service/AddressService.java b/core/src/main/java/jshop/core/domain/address/service/AddressService.java
@@ -11,6 +11,7 @@
 import jshop.core.domain.user.repository.UserRepository;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
@@ -46,7 +47,9 @@ public void updateAddress(UpdateAddressRequest updateAddressRequest, Long addres
     public Address getAddress(Long addressId) {
         Optional<Address> optionalAddress = addressRepository.findById(addressId);
         return optionalAddress.orElseThrow(() -> {
+            MDC.put("error_code", String.valueOf(ErrorCode.ADDRESSID_NOT_FOUND.getCode()));
             log.error(ErrorCode.ADDRESSID_NOT_FOUND.getLogMessage(), addressId);
+            MDC.clear();
             throw JshopException.of(ErrorCode.ADDRESSID_NOT_FOUND);
         });
     }
diff --git a/core/src/main/java/jshop/core/domain/cart/entity/Cart.java b/core/src/main/java/jshop/core/domain/cart/entity/Cart.java
@@ -18,6 +18,7 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 
 @Slf4j
 @Entity
@@ -47,7 +48,9 @@ public static Cart create() {
 
     public void addCart(ProductDetail productDetail, int quantity) {
         if (quantity <= 0) {
+            MDC.put("error_code", String.valueOf(ErrorCode.ILLEGAL_CART_QUANTITY_REQUEST_EXCEPTION.getCode()));
             log.error(ErrorCode.ILLEGAL_CART_QUANTITY_REQUEST_EXCEPTION.getLogMessage(), quantity);
+            MDC.clear();
             throw JshopException.of(ErrorCode.ILLEGAL_CART_QUANTITY_REQUEST_EXCEPTION);
         }
 
diff --git a/core/src/main/java/jshop/core/domain/cart/entity/CartProductDetail.java b/core/src/main/java/jshop/core/domain/cart/entity/CartProductDetail.java
@@ -18,6 +18,7 @@
 import lombok.NoArgsConstructor;
 import lombok.ToString;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 
 @Slf4j
 @Entity
@@ -46,7 +47,9 @@ public class CartProductDetail extends BaseEntity {
 
     public void changeQuantity(int quantity) {
         if (this.quantity + quantity <= 0) {
+            MDC.put("error_code", String.valueOf(ErrorCode.ILLEGAL_CART_QUANTITY_REQUEST_EXCEPTION.getCode()));
             log.error(ErrorCode.ILLEGAL_CART_QUANTITY_REQUEST_EXCEPTION.getLogMessage(), this.quantity + quantity);
+            MDC.clear();
             throw JshopException.of(ErrorCode.ILLEGAL_CART_QUANTITY_REQUEST_EXCEPTION);
         }
         this.quantity += quantity;
diff --git a/core/src/main/java/jshop/core/domain/cart/repository/TestRepository.java b/core/src/main/java/jshop/core/domain/cart/repository/TestRepository.java
diff --git a/core/src/main/java/jshop/core/domain/cart/service/CartService.java b/core/src/main/java/jshop/core/domain/cart/service/CartService.java
@@ -15,6 +15,7 @@
 import jshop.common.exception.JshopException;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Sort;
@@ -48,7 +49,9 @@ public void addCart(AddCartRequest addCartRequest, Long userId) {
         Cart cart = getCart(userId);
 
         if (!productDetailRepository.existsByIdAndIsDeletedFalse(detailId)) {
+            MDC.put("error_code", String.valueOf(ErrorCode.PRODUCTDETAIL_ID_NOT_FOUND.getCode()));
             log.error(ErrorCode.PRODUCTDETAIL_ID_NOT_FOUND.getLogMessage(), detailId);
+            MDC.clear();
             throw JshopException.of(ErrorCode.PRODUCTDETAIL_ID_NOT_FOUND);
         }
 
@@ -72,15 +75,19 @@ public void updateCart(Long cartProductDetailId, UpdateCartRequest updateCartReq
     public CartProductDetail getCartProductDetail(Long id) {
         Optional<CartProductDetail> optionalCartProductDetail = cartProductDetailRepository.findById(id);
         return optionalCartProductDetail.orElseThrow(() -> {
+            MDC.put("error_code", String.valueOf(ErrorCode.CART_PRODUCTDETAIL_ID_NOT_FOUND.getCode()));
             log.error(ErrorCode.CART_PRODUCTDETAIL_ID_NOT_FOUND.getLogMessage(), id);
+            MDC.clear();
             throw JshopException.of(ErrorCode.CART_PRODUCTDETAIL_ID_NOT_FOUND);
         });
     }
 
     public Cart getCart(Long userId) {
         Optional<Cart> optionalCart = cartRepository.findCartByUserId(userId);
         return optionalCart.orElseThrow(() -> {
+            MDC.put("error_code", String.valueOf(ErrorCode.CART_NOT_FOUND.getCode()));
             log.error(ErrorCode.CART_NOT_FOUND.getLogMessage(), userId);
+            MDC.clear();
             throw JshopException.of(ErrorCode.CART_NOT_FOUND);
         });
     }
diff --git a/core/src/main/java/jshop/core/domain/coupon/entity/Coupon.java b/core/src/main/java/jshop/core/domain/coupon/entity/Coupon.java
@@ -17,6 +17,7 @@
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 import org.springframework.data.annotation.CreatedDate;
 import org.springframework.data.annotation.LastModifiedDate;
 
@@ -72,7 +73,9 @@ public abstract class Coupon {
     protected boolean checkCouponUsagePeriod() {
         LocalDateTime now = LocalDateTime.now();
         if (now.isBefore(useStartDate) || now.isAfter(useEndDate)) {
+            MDC.put("error_code", String.valueOf(ErrorCode.COUPON_USAGE_PERIOD_EXCEPTION.getCode()));
             log.error(ErrorCode.COUPON_USAGE_PERIOD_EXCEPTION.getLogMessage(), useStartDate, useEndDate);
+            MDC.clear();
             throw JshopException.of(ErrorCode.COUPON_USAGE_PERIOD_EXCEPTION);
         }
 
@@ -82,7 +85,9 @@ protected boolean checkCouponUsagePeriod() {
     protected boolean checkCouponIssuePeriod() {
         LocalDateTime now = LocalDateTime.now();
         if (now.isBefore(issueStartDate) || now.isAfter(issueEndDate)) {
+            MDC.put("error_code", String.valueOf(ErrorCode.COUPON_ISSUE_PERIOD_EXCEPTION.getCode()));
             log.error(ErrorCode.COUPON_ISSUE_PERIOD_EXCEPTION.getLogMessage(), issueStartDate, issueEndDate);
+            MDC.clear();
             throw JshopException.of(ErrorCode.COUPON_ISSUE_PERIOD_EXCEPTION);
         }
 
@@ -93,7 +98,9 @@ public UserCoupon issueCoupon(User user) {
         checkCouponIssuePeriod();
 
         if (remainingQuantity <= 0) {
+            MDC.put("error_code", String.valueOf(ErrorCode.COUPON_OUT_OF_STOCK_EXCEPTION.getCode()));
             log.error(ErrorCode.COUPON_OUT_OF_STOCK_EXCEPTION.getLogMessage(), id, remainingQuantity);
+            MDC.clear();
             throw JshopException.of(ErrorCode.COUPON_OUT_OF_STOCK_EXCEPTION);
         }
 
diff --git a/core/src/main/java/jshop/core/domain/coupon/entity/FixedPriceCoupon.java b/core/src/main/java/jshop/core/domain/coupon/entity/FixedPriceCoupon.java
@@ -12,6 +12,7 @@
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 
 @Slf4j
 @Getter
@@ -32,7 +33,9 @@ public long discount(long originPrice) {
         checkCouponUsagePeriod();
 
         if (originPrice < minOriginPrice) {
+            MDC.put("error_code", String.valueOf(ErrorCode.COUPON_MIN_PRICE_EXCEPTION.getCode()));
             log.error(ErrorCode.COUPON_MIN_PRICE_EXCEPTION.getLogMessage(), minOriginPrice, originPrice);
+            MDC.clear();
             JshopException.of(ErrorCode.COUPON_MIN_PRICE_EXCEPTION);
         }
 
diff --git a/core/src/main/java/jshop/core/domain/coupon/entity/FixedRateCoupon.java b/core/src/main/java/jshop/core/domain/coupon/entity/FixedRateCoupon.java
@@ -12,6 +12,7 @@
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 
 @Slf4j
 @Getter
@@ -55,7 +56,9 @@ public long discount(long originPrice) {
         checkCouponUsagePeriod();
 
         if (originPrice < minOriginPrice) {
+            MDC.put("error_code", String.valueOf(ErrorCode.COUPON_MIN_PRICE_EXCEPTION.getCode()));
             log.error(ErrorCode.COUPON_MIN_PRICE_EXCEPTION.getLogMessage(), minOriginPrice, originPrice);
+            MDC.clear();
             throw JshopException.of(ErrorCode.COUPON_MIN_PRICE_EXCEPTION);
         }
 
diff --git a/core/src/main/java/jshop/core/domain/coupon/entity/UserCoupon.java b/core/src/main/java/jshop/core/domain/coupon/entity/UserCoupon.java
@@ -14,9 +14,7 @@
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
 
-@Slf4j
 @Entity
 @Getter
 @Builder
diff --git a/core/src/main/java/jshop/core/domain/coupon/service/CouponService.java b/core/src/main/java/jshop/core/domain/coupon/service/CouponService.java
@@ -15,6 +15,7 @@
 import jshop.common.exception.JshopException;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
@@ -32,8 +33,10 @@ public class CouponService {
     public String createCoupon(CreateCouponRequest createCouponRequest) {
         Coupon coupon = null;
         if (createCouponRequest.getCouponType() == null) {
+            MDC.put("error_code", String.valueOf(ErrorCode.COUPON_TYPE_NOT_DEFINED.getCode()));
             log.error(ErrorCode.COUPON_TYPE_NOT_DEFINED.getLogMessage(), createCouponRequest.getId(),
                 createCouponRequest.getCouponType());
+            MDC.clear();
             throw JshopException.of(ErrorCode.COUPON_TYPE_NOT_DEFINED);
         }
 
@@ -45,13 +48,17 @@ public String createCoupon(CreateCouponRequest createCouponRequest) {
                 coupon = FixedRateCoupon.of(createCouponRequest);
                 break;
             default:
+                MDC.put("error_code", String.valueOf(ErrorCode.COUPON_TYPE_NOT_DEFINED.getCode()));
                 log.error(ErrorCode.COUPON_TYPE_NOT_DEFINED.getLogMessage(), createCouponRequest.getId(),
                     createCouponRequest.getCouponType());
+                MDC.clear();
                 throw JshopException.of(ErrorCode.COUPON_TYPE_NOT_DEFINED);
         }
 
         if (coupon == null) {
+            MDC.put("error_code", String.valueOf(ErrorCode.COUPON_CREATE_EXCEPTION.getCode()));
             log.error(ErrorCode.COUPON_CREATE_EXCEPTION.getLogMessage(), createCouponRequest.getId());
+            MDC.clear();
             throw JshopException.of(ErrorCode.COUPON_CREATE_EXCEPTION);
         }
 
@@ -73,15 +80,19 @@ public Long issueCoupon(String couponId, Long userId) {
     public Coupon getCoupon(String couponId) {
         Optional<Coupon> optionalCoupon = couponRepository.findById(couponId);
         return optionalCoupon.orElseThrow(() -> {
+            MDC.put("error_code", String.valueOf(ErrorCode.COUPON_ID_NOT_FOUND.getCode()));
             log.error(ErrorCode.COUPON_ID_NOT_FOUND.getLogMessage(), couponId);
+            MDC.clear();
             throw JshopException.of(ErrorCode.COUPON_ID_NOT_FOUND);
         });
     }
 
     public UserCoupon getUserCoupon(Long userCouponId) {
         Optional<UserCoupon> optionalUserCoupon = userCouponRepository.findById(userCouponId);
         return optionalUserCoupon.orElseThrow(() -> {
+            MDC.put("error_code", String.valueOf(ErrorCode.USER_COUPON_ID_NOT_FOUND.getCode()));
             log.error(ErrorCode.USER_COUPON_ID_NOT_FOUND.getLogMessage(), userCouponId);
+            MDC.clear();
             throw JshopException.of(ErrorCode.USER_COUPON_ID_NOT_FOUND);
         });
     }
diff --git a/core/src/main/java/jshop/core/domain/delivery/entity/Delivery.java b/core/src/main/java/jshop/core/domain/delivery/entity/Delivery.java
@@ -18,6 +18,7 @@
 import lombok.NoArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.hibernate.envers.Audited;
+import org.slf4j.MDC;
 
 @Slf4j
 @Entity
@@ -59,15 +60,19 @@ public class Delivery extends BaseEntity {
 
     public void startTransit() {
         if (!deliveryState.equals(DeliveryState.PREPARING)) {
+            MDC.put("error_code", String.valueOf(ErrorCode.ILLEGAL_DELIVERY_STATE.getCode()));
             log.error(ErrorCode.ILLEGAL_DELIVERY_STATE.getLogMessage(), DeliveryState.PREPARING, deliveryState);
+            MDC.clear();
             throw JshopException.of(ErrorCode.ILLEGAL_DELIVERY_STATE);
         }
         deliveryState = DeliveryState.IN_TRANSIT;
     }
 
     public void endDelivered() {
         if (!deliveryState.equals(DeliveryState.IN_TRANSIT)) {
+            MDC.put("error_code", String.valueOf(ErrorCode.ILLEGAL_DELIVERY_STATE.getCode()));
             log.error(ErrorCode.ILLEGAL_DELIVERY_STATE.getLogMessage(), DeliveryState.IN_TRANSIT, deliveryState);
+            MDC.clear();
             throw JshopException.of(ErrorCode.ILLEGAL_DELIVERY_STATE);
         }
         deliveryState = DeliveryState.DELIVERED;
diff --git a/core/src/main/java/jshop/core/domain/order/entity/OrderProductDetail.java b/core/src/main/java/jshop/core/domain/order/entity/OrderProductDetail.java
@@ -14,9 +14,7 @@
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
 
-@Slf4j
 @Entity
 @Getter
 @Builder
diff --git a/jenkins/deploy.jenkins b/jenkins/deploy.jenkins
@@ -35,7 +35,7 @@ pipeline {
             steps {
                 script {
                     echo 'build'
-                    sh "docker build -t ${IMAGE}:${VERSION} --build-arg VERSION=${VERSION} --build-arg MYSQL_HOST=${MYSQL_HOST} --build-arg MYSQL_PORT=${MYSQL_PORT} --build-arg MYSQL_USERNAME=${MYSQL_USERNAME} --build-arg MYSQL_PASSWORD=${MYSQL_PASSWORD} --build-arg JWT_SECRET_KEY=${JWT_SECRET_KEY} --build-arg REDIS_HOST=${REDIS_HOST} --build-arg REDIS_PORT=${REDIS_PORT} --build-arg REDIS_PASSWORD=${REDIS_PASSWORD} ."
+                    sh "docker build -t ${IMAGE}:${VERSION} --build-arg LOGSTASH_HOST='elk_logstash' --build-arg LOGSTASH_PORT='5010' --build-arg VERSION=${VERSION} --build-arg MYSQL_HOST=${MYSQL_HOST} --build-arg MYSQL_PORT=${MYSQL_PORT} --build-arg MYSQL_USERNAME=${MYSQL_USERNAME} --build-arg MYSQL_PASSWORD=${MYSQL_PASSWORD} --build-arg JWT_SECRET_KEY=${JWT_SECRET_KEY} --build-arg REDIS_HOST=${REDIS_HOST} --build-arg REDIS_PORT=${REDIS_PORT} --build-arg REDIS_PASSWORD=${REDIS_PASSWORD} ."
                 }
             }
         }
diff --git a/web/src/main/java/jshop/web/logging/LoggingFilter.java b/web/src/main/java/jshop/web/logging/LoggingFilter.java
diff --git a/web/src/main/resources/application.yml b/web/src/main/resources/application.yml
diff --git a/web/src/main/resources/logback-spring-dev.xml b/web/src/main/resources/logback-spring-dev.xml
diff --git a/web/src/main/resources/logback-spring-prod.xml b/web/src/main/resources/logback-spring-prod.xml
diff --git a/web/src/test/java/jshop/web/controller/AccountControllerTest.java b/web/src/test/java/jshop/web/controller/AccountControllerTest.java
