Merge pull request #216 from DevKor-github/feat/logging

Feat: 사용자 행동 로깅 추가

Author: Yyang-YE

build.gradle

@@ -120,6 +120,9 @@ dependencies {
 
     // thumbnail
     implementation 'net.coobird:thumbnailator:0.4.19'
+
+    // elasticsearch
+//    implementation 'org.springframework.boot:spring-boot-starter-data-elasticsearch'
 }
 
 dependencyManagement {

src/main/java/devkor/com/teamcback/domain/routes/service/RouteService.java

@@ -14,6 +14,7 @@
 import devkor.com.teamcback.domain.routes.repository.NodeRepository;
 import devkor.com.teamcback.global.exception.exception.AdminException;
 import devkor.com.teamcback.global.exception.exception.GlobalException;
+import devkor.com.teamcback.global.logging.service.LogUtil;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
@@ -33,6 +34,8 @@ public class RouteService {
     private final PlaceRepository placeRepository;
     private final CheckpointRepository checkpointRepository;
     private final ConnectedBuildingRepository connectedBuildingRepository;
+    private final LogUtil logUtil;
+
     private static final long OUTDOOR_ID = 0L;
     private static final String SEPARATOR = ",";
     private static final Long INF = Long.MAX_VALUE;
@@ -76,9 +79,26 @@ public List<GetRouteRes> findRoute(LocationType startType, Long startId, Double
 //        if(route.getPath().isEmpty() && route2.getPath.isEmpty()) throw new GlobalException(NOT_FOUND_ROUTE);
 //        routeRes.add(buildRouteResponse(route2, isStartBuilding, isEndBuilding));
 
+        // 로그 저장
+        Building startBuilding = null, endBuilding = null;
+        Place startPlace= null, endPlace = null;
+
+        if(checkType(startType, endType)) {
+            if (startType == LocationType.BUILDING) startBuilding = findBuilding(startId);
+            else if (startType == LocationType.PLACE) startPlace = findPlace(startId);
+
+            if (endType == LocationType.BUILDING) endBuilding = findBuilding(endId);
+            else if (endType == LocationType.PLACE) endPlace = findPlace(endId);
+
+            logUtil.logRoute(startBuilding, startPlace, endBuilding, endPlace, conditions);
+        }
         return routeRes;
     }
 
+    private boolean checkType(LocationType startType, LocationType endType) {
+        return (startType == LocationType.BUILDING || startType == LocationType.PLACE) && (endType == LocationType.BUILDING || endType == LocationType.PLACE);
+    }
+
     /**
      * 에러 조건 확인
      */
@@ -570,4 +590,4 @@ public int compareTo(NodeDistancePair other) {
         }
     }
 
-}
+}

src/main/java/devkor/com/teamcback/domain/search/service/SearchService.java

@@ -23,6 +23,7 @@
 import devkor.com.teamcback.domain.user.entity.User;
 import devkor.com.teamcback.domain.user.repository.UserRepository;
 import devkor.com.teamcback.global.exception.exception.GlobalException;
+import devkor.com.teamcback.global.logging.service.LogUtil;
 import devkor.com.teamcback.global.response.CursorPageRes;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -55,6 +56,7 @@ public class SearchService {
     private final BookmarkRepository bookmarkRepository;
     private final PlaceImageRepository placeImageRepository;
     private final NodeRepository nodeRepository;
+    private final LogUtil logUtil;
     private final FileUtil fileUtil;
 
     // 점수 계산을 위한 상수
@@ -73,10 +75,11 @@ public class SearchService {
 
     // 통합 검색 결과에 표시하지 않을 편의시설 종류
     //TODO: 자전거보관소, 벤치 디자인 요청 후 List에서 제거
+    // TODO: 리필로드 구현 완료되면 REUSABLE_CUP_RETURN 제거하기
     private static final List<String> excludedTypes = Arrays.asList(PlaceType.CLASSROOM.getName(), PlaceType.TOILET.getName(),
         PlaceType.MEN_TOILET.getName(), PlaceType.WOMEN_TOILET.getName(), PlaceType.MEN_HANDICAPPED_TOILET.getName(),
         PlaceType.WOMEN_HANDICAPPED_TOILET.getName(), PlaceType.LOCKER.getName(), PlaceType.TRASH_CAN.getName(),
-        PlaceType.BICYCLE_RACK.getName(), PlaceType.BENCH.getName());
+        PlaceType.BICYCLE_RACK.getName(), PlaceType.BENCH.getName(), PlaceType.REUSABLE_CUP_RETURN.getName());
 
     // 통합 검색 결과에서 "건물명 + 기본편의시설명"의 형태로 제공되어야 하는 편의시설 종류
     private static final List<PlaceType> outerTagTypes = Arrays.asList(PlaceType.CAFE, PlaceType.CAFETERIA, PlaceType.CONVENIENCE_STORE,
@@ -134,6 +137,8 @@ public GlobalSearchListRes globalSearch(String word, Long userId) {
                 scores.putAll(getScores(word, buildings, lastPlaceWord, lastBuildingWord, user));
             }
         }
+
+        logUtil.logSearch(word);
         return new GlobalSearchListRes(orderSequence(scores));
     }
 
@@ -155,6 +160,7 @@ public SearchBuildingListRes searchBuildings(PlaceType type) {
                 .map(Place::getBuilding)
                 .distinct()
                 .toList();
+            logUtil.logClick(null, null, null, type.toString());
         }
 
         List<SearchBuildingRes> resList = new ArrayList<>();
@@ -197,6 +203,7 @@ public SearchBuildingFacilityListRes searchBuildingFacilityByType(Long buildingI
 
         res.setFacilities(map);
 
+        logUtil.logClick(building.getName(), null, null, placeType.toString());
         return res;
     }
 
@@ -266,7 +273,7 @@ public SearchFacilityListRes searchFacilitiesWithType(PlaceType placeType) {
 
             placeResList.add(new SearchPlaceRes(place, imageUrl));
         }
-
+        logUtil.logClick(null, null, null, placeType.toString());
         return new SearchFacilityListRes(placeResList);
     }
 
@@ -280,6 +287,7 @@ public SearchPlaceByMaskIndexRes searchPlaceByMaskIndex(Long buildingId, int flo
         if(place == null) {
             throw new GlobalException(NOT_FOUND_PLACE);
         }
+        logUtil.logClick(building.getName(), place.getName(), place.getFloor(), place.getType().toString());
         return new SearchPlaceByMaskIndexRes(place);
     }
 
@@ -334,9 +342,13 @@ public SearchBuildingDetailRes searchBuildingDetail(Long userId, Long buildingId
         if(building.getFileUuid() != null) {
             imageUrl = fileUtil.getThumbnail(building.getFileUuid());
         }
+        logUtil.logClick(building.getName(), null, null, null);
         return new SearchBuildingDetailRes(res, containPlaceTypes, building, imageUrl, bookmarked);
     }
 
+    /**
+     * 건물 대표 편의시설 목록 조회
+     */
     @Transactional(readOnly = true)
     public CursorPageRes<SearchMainFacilityRes> searchBuildingMainFacilityList(Long buildingId, Long lastPlaceId, int size) {
         Place lastPlace = (lastPlaceId == null) ? null : findPlace(lastPlaceId);
@@ -393,7 +405,7 @@ public SearchPlaceDetailRes searchPlaceDetail(Long userId, Long placeId) {
         if(bookmarkRepository.existsByLocationIdAndLocationTypeAndCategoryBookmarkList_CategoryIn(place.getId(), LocationType.PLACE, categories)) {
             bookmarked = true;
         }
-
+        logUtil.logClick(place.getBuilding().getName(), place.getName(), place.getFloor(), place.getType().toString());
         return new SearchPlaceDetailRes(place, imageUrl, bookmarked, placeImageList);
     }
 

src/main/java/devkor/com/teamcback/global/logging/service/LogUtil.java

@@ -0,0 +1,59 @@
+package devkor.com.teamcback.global.logging.service;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import devkor.com.teamcback.domain.building.entity.Building;
+import devkor.com.teamcback.domain.place.entity.Place;
+import devkor.com.teamcback.domain.routes.entity.Conditions;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Component;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+@Component
+public class LogUtil {
+
+    private static final Logger routeLog  = LoggerFactory.getLogger("ROUTE_LOG");
+    private static final Logger searchLog = LoggerFactory.getLogger("SEARCH_LOG");
+    private static final Logger clickLog  = LoggerFactory.getLogger("CLICK_LOG");
+
+    private final ObjectMapper objectMapper = new ObjectMapper();
+
+    public void logClick(String buildingName, String placeName, Double floor, String categoryName) {
+        Map<String, Object> logMap = new HashMap<>();
+        if(buildingName != null) logMap.put("buildingName", buildingName);
+        if(placeName != null) logMap.put("placeName", placeName);
+        if(floor != null) logMap.put("floor", floor);
+        if(categoryName != null) logMap.put("categoryName", categoryName);
+
+        try {
+            clickLog.info(objectMapper.writeValueAsString(logMap));
+        } catch (Exception ignored) { }
+    }
+
+    public void logSearch(String keyword) {
+        Map<String, Object> logMap = new HashMap<>();
+        logMap.put("keyword", keyword);
+
+        try {
+            searchLog.info(objectMapper.writeValueAsString(logMap));
+        } catch (Exception ignored) { }
+    }
+
+    public void logRoute(Building startBuilding, Place startPlace, Building endBuilding, Place endPlace, List<Conditions> conditions) {
+        Map<String, Object> logMap = new HashMap<>();
+
+        logMap.put("startBuildingName", (startBuilding != null) ? startBuilding.getName() : startPlace.getBuilding().getName());
+        logMap.put("endBuildingName", (endBuilding != null) ? endBuilding.getName() : endPlace.getBuilding().getName());
+
+        if (startPlace != null) logMap.put("startPlaceName", startPlace.getName());
+        if (endPlace != null) logMap.put("endPlaceName", endPlace.getName());
+        if (conditions != null) logMap.put("conditions", conditions.stream().map(Enum::name).toList());
+
+        try {
+            routeLog.info(objectMapper.writeValueAsString(logMap));
+        } catch (Exception ignored) { }
+    }
+}

src/main/resources/application.yml

@@ -46,10 +46,15 @@ spring:
       mail.smtp.auth: true
       mail.smtp.starttls.enable: true
 
+#  elasticsearch:
+#    uris: ${ELASTIC_URIS}
+#    username: ${ELASTIC_USERNAME}
+#    password: ${ELASTIC_PASSWORD}
 
 logging:
   level:
     org.hibernate.SQL: debug
+#    org.elasticsearch.client: TRACE
 
 jwt:
   secret:
@@ -90,6 +95,7 @@ springdoc:
     path: /swagger-ui.html
     doc-expansion: none
     enabled: true
+    display-request-duration: true
   paths-to-match:
     - /api/**