Merge pull request #188 from DevKor-github/feat/metric

Feat: cloudwatch api별 요청 횟수 지표 추가

Author: dlwls423

build.gradle

@@ -99,8 +99,9 @@ dependencies {
     // actuator
     implementation 'org.springframework.boot:spring-boot-starter-actuator'
 
-    // prometheus
-    implementation 'io.micrometer:micrometer-registry-prometheus'
+    // cloudwatch
+    implementation 'io.micrometer:micrometer-registry-cloudwatch2'
+    implementation 'software.amazon.awssdk:cloudwatch'
 }
 dependencyManagement {
     imports {

src/main/java/devkor/com/teamcback/global/config/WebConfig.java

@@ -0,0 +1,18 @@
+package devkor.com.teamcback.global.config;
+
+import devkor.com.teamcback.infra.cloudwatch.MetricsInterceptor;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+@Configuration
+public class WebConfig implements WebMvcConfigurer {
+    @Autowired
+    private MetricsInterceptor metricsInterceptor;
+
+    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
+        registry.addInterceptor(metricsInterceptor);
+    }
+}

src/main/java/devkor/com/teamcback/infra/cloudwatch/CloudWatchConfig.java

@@ -0,0 +1,19 @@
+package devkor.com.teamcback.infra.cloudwatch;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient;
+
+@Configuration
+public class CloudWatchConfig {
+
+    @Bean
+    public CloudWatchAsyncClient cloudWatchAsyncClient() {
+        return CloudWatchAsyncClient
+                .builder()
+                .region(Region.AP_NORTHEAST_2)
+                .build();
+    }
+}
+

src/main/java/devkor/com/teamcback/infra/cloudwatch/MetricsInterceptor.java

@@ -0,0 +1,49 @@
+package devkor.com.teamcback.infra.cloudwatch;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Component;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import org.springframework.web.method.HandlerMethod;
+import org.springframework.web.servlet.HandlerInterceptor;
+import org.springframework.web.servlet.HandlerMapping;
+
+import java.util.List;
+
+@Component
+@RequiredArgsConstructor
+public class MetricsInterceptor implements HandlerInterceptor {
+
+    private final MetricsService metricsService;
+
+    @Override
+    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
+        if(handler instanceof HandlerMethod) {
+            String pattern = (String) request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE);
+            if(shouldTrack(pattern)) {
+                metricsService.recordApiRequest(pattern);
+            }
+            return true;
+        }
+        return true;
+    }
+
+    private boolean shouldTrack(String uri) {
+        return List.of(
+                "/api/bookmarks",
+                "/api/categories",
+                "/api/routes",
+                "/api/users/login",
+                "/api/users/login/release",
+                "/api/users/mypage",
+                "/api/search",
+                "/api/search/buildings",
+                "/api/search/buildings/{buildingId}",
+                "/api/search/buildings/{buildingId}/facilities",
+                "/api/search/facilities",
+                "/api/search/place/{placeId}"
+        ).contains(uri);
+    }
+}
+
+

src/main/java/devkor/com/teamcback/infra/cloudwatch/MetricsService.java

@@ -0,0 +1,73 @@
+package devkor.com.teamcback.infra.cloudwatch;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Service;
+import software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient;
+import software.amazon.awssdk.services.cloudwatch.model.*;
+import software.amazon.awssdk.services.cloudwatch.model.Dimension;
+
+import java.time.Instant;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.atomic.AtomicInteger;
+
+@Service
+@RequiredArgsConstructor
+public class MetricsService {
+    @Value("${metrics.environment}")
+    private String environment;
+
+    private final String TARGET = "dev"; // 테스트 후 prod로 변경
+
+    private final CloudWatchAsyncClient cloudWatchAsyncClient;
+    private final Map<String, AtomicInteger> uriCountMap = new ConcurrentHashMap<>();
+
+    public void recordApiRequest(String uri) {
+        if(TARGET.equalsIgnoreCase(environment)) {
+            uriCountMap.computeIfAbsent(uri, k -> new AtomicInteger(0)).incrementAndGet();
+        }
+    }
+
+    @Scheduled(fixedRate = 60_000)
+    public void sendMetricsToCloudWatch() {
+        if (TARGET.equalsIgnoreCase(environment)) {
+            List<MetricDatum> metricDataList = uriCountMap.entrySet().stream()
+                    .map(entry -> {
+                        String uri = entry.getKey();
+                        int count = entry.getValue().getAndSet(0);
+
+                        if (count > 0) {
+                            return MetricDatum.builder()
+                                    .metricName("ApiRequestCount")
+                                    .dimensions(
+                                            Dimension.builder().name("URI").value(uri).build()
+                                    )
+                                    .unit(StandardUnit.COUNT)
+                                    .value((double) count)
+                                    .timestamp(Instant.now())
+                                    .build();
+                        }
+                        return null;
+                    })
+                    .filter(Objects::nonNull)
+                    .toList();
+
+            if (!metricDataList.isEmpty()) {
+                PutMetricDataRequest request = PutMetricDataRequest.builder()
+                        .namespace("Kodaero/Metrics")
+                        .metricData(metricDataList)
+                        .build();
+
+                cloudWatchAsyncClient.putMetricData(request).whenComplete((resp, err) -> {
+                    if (err != null) {
+                        System.err.println("Failed to send metric: " + err.getMessage());
+                    }
+                });
+            }
+        }
+    }
+}

src/main/resources/application.yml

@@ -30,15 +30,6 @@ spring:
       port: 6379
       password: ${REDIS_PASSWORD}
 
-management:
-  endpoints:
-    web:
-      exposure:
-        include: prometheus, health, info, metrics
-  prometheus:
-    metrics:
-      export:
-        enabled: true
 
 logging:
   level:
@@ -111,4 +102,7 @@ date:
     holiday:
       end-point: ${HOLIDAY_API_END_POINT}
       encoded-key: ${HOLIDAY_API_ENCODED_KEY}
-      decoded-key: ${HOLIDAY_API_DECODED_KEY}
+      decoded-key: ${HOLIDAY_API_DECODED_KEY}
+
+metrics:
+  environment: dev