feat: kubernetes deploy and real-time status update (#68)

* dev: generic methods for calculating percentiles

* dev: javadocs style commenting

* dev: change MTTFB percentile map value with Long

* dev: stop status append

* dev: already running errorcode append

* dev: validation update

* dev: agent stop event, avg cal, preftest update

* dev: agent deploy as statefulSet

* dev: status logging

* dev: adjust test method

* dev: stomp socket handling due to k8s

* dev: remove unused ingress

* dev: setup stomp with SockJS

* dev: kubernetes profile agent loader

* dev: docker buildx multiplatform image

* dev: setup EUREKA k8s config

* dev: local image pusher script

* chore: undo issuer

* dev: agent renewal parallel execution

* chore: gradle clean and build

* dev: websocket service exporter

* dev: imagePulling always & eureka connect

* dev: SockJS script src added

* dev: ddl-auto validate to update

* dev: spring cloud kubernetes import

* dev: RBAC role & rolebinding to serviceaccount

* dev: ingress rule update

* dev: limiting resource

* dev: tls issuer and connect to ingress

Author: ghkdqhrbals

.github/workflows/gke-cd.yaml

@@ -72,7 +72,7 @@ jobs:
         run: chmod +x ./gradlew
 
       - name: Build and test project
-        run: ./gradlew build
+        run: ./gradlew clean build
 
       - name: Build docker image and push
         run: bash ./script/img_push_multi_arch.sh -u ${{ secrets.DOCKERHUB_USERNAME }} -t ${{ secrets.DOCKERHUB_TOKEN }}

bm-agent/src/main/java/org/benchmarker/bmagent/consts/PreftestConsts.java

@@ -3,7 +3,30 @@
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * Performance Test Constants
+ */
 public interface PreftestConsts {
-    List<Double> percentiles = Arrays.asList(50D, 90D, 95D,99D,99.9D);
+
+    /**
+     * Required when measuring percentile of TPS and MTTFB(Mean Time To First Byte)
+     */
+    List<Double> percentiles = Arrays.asList(50D, 90D, 95D, 99D, 99.9D);
+
+    /**
+     * If performance test has error rate exceed {@link PreftestConsts#errorLimitRate}, instantly
+     * shutdown all scheduler and emit event to bm-controller
+     */
+    Double errorLimitRate = 50D;
+
+    /**
+     * ErrorLimit Lookup process will be started after this time
+     */
+    int errorLimitCheckDelay = 10;
+
+    /**
+     * ErrorLimit Lookup process period
+     */
+    int errorLimitCheckPeriod = 5;
 
 }

bm-agent/src/main/java/org/benchmarker/bmagent/consts/SseManageConsts.java

@@ -1,5 +1,12 @@
 package org.benchmarker.bmagent.consts;
 
+/**
+ * SSE constants
+ */
 public interface SseManageConsts {
+
+    /**
+     * SSE timeout constant
+     */
     Long SSE_TIMEOUT = 600000L;
 }

bm-agent/src/main/java/org/benchmarker/bmagent/consts/SystemSchedulerConst.java

@@ -1,13 +1,28 @@
 package org.benchmarker.bmagent.consts;
 
+/**
+ * System Scheduler constants
+ */
 public interface SystemSchedulerConst {
 
     /**
      * System scheduler will run in this ID
      */
     Long systemSchedulerId = -100L;
+
+    /**
+     * System scheduler's name
+     */
     String systemUsageSchedulerName = "cpu-memory-usage-update";
+
+    /**
+     * @deprecated since 2024-03-28
+     */
     Integer connectControllerTimeout = 10; // seconds
+
+    /**
+     * @deprecated since 2024-03-28
+     */
     Integer connectionFailedLimit = 50;
 
 

bm-agent/src/main/java/org/benchmarker/bmagent/controller/AgentApiController.java

@@ -1,7 +1,9 @@
 package org.benchmarker.bmagent.controller;
 
 
-import jakarta.servlet.http.HttpServletRequest;
+import java.io.IOException;
+import java.net.InetAddress;
+import java.net.UnknownHostException;
 import java.util.Map;
 import java.util.Set;
 import lombok.RequiredArgsConstructor;
@@ -21,11 +23,15 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
-import org.springframework.web.context.request.RequestContextHolder;
-import org.springframework.web.context.request.ServletRequestAttributes;
 import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
 
-
+/**
+ * Main RESTAPI endpoint
+ *
+ * <p>
+ *     bm-controller will send request to here for performance testing
+ * </p>
+ */
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api")
@@ -46,15 +52,16 @@ public class AgentApiController {
     @PostMapping("/groups/{group_id}/templates/{template_id}")
     public SseEmitter manageSSE(@PathVariable("template_id") Long templateId,
         @PathVariable("group_id") String groupId,
-        @RequestParam("action") String action, @RequestBody TemplateInfo templateInfo) {
+        @RequestParam("action") String action, @RequestBody TemplateInfo templateInfo)
+        throws IOException {
         log.info(templateInfo.toString());
 
         if (action.equals("start")) {
             agentStatusManager.getAndUpdateStatusIfReady(
                 AgentStatus.TESTING).orElseThrow(() -> new RuntimeException("agent is not ready"));
             return sseManageService.start(templateId, groupId, templateInfo);
         } else {
-            sseManageService.stop(templateId);
+            sseManageService.stopSign(templateId);
             return null;
         }
     }
@@ -70,23 +77,26 @@ public ResponseEntity<Map<Long, SchedulerStatus>> getSchedulersStatus() {
     }
 
     @GetMapping("/status")
-    public AgentInfo getStatus() {
-        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
-        String scheme = request.getScheme(); // http or https
-        String serverName = request.getServerName();
-        int serverPort = request.getServerPort();
-        Set<Long> longs = scheduledTaskService.getStatus().keySet();
+    public AgentInfo getStatus() throws UnknownHostException {
+        log.info("Check current status");
+        InetAddress localHost = InetAddress.getLocalHost();
+        String serverAddress = localHost.getHostAddress();
+        String scheme = "http"; // Assuming it's always HTTP when accessed locally
+        int serverPort = 8081; // Assuming default port is 8080
 
-        String agentServerUrl = scheme + "://" + serverName + ":" + serverPort;
+        Set<Long> longs = scheduledTaskService.getStatus().keySet();
 
-        return AgentInfo.builder()
+        String agentServerUrl = scheme + "://" + serverAddress + ":" + serverPort;
+        AgentInfo info = AgentInfo.builder()
             .templateId(longs)
             .cpuUsage(agentStatusManager.getCpuUsage())
             .memoryUsage(agentStatusManager.getMemoryUsage())
             .startedAt(agentStatusManager.getStartedAt())
             .serverUrl(agentServerUrl)
             .status(agentStatusManager.getStatus().get())
             .build();
+        log.info(info.toString());
+        return info;
     }
 }
 

bm-agent/src/main/java/org/benchmarker/bmagent/initializer/Initializer.java

@@ -13,6 +13,13 @@
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 
+/**
+ * The Initializer class is responsible for <strong>initializing various components of the
+ * application when it starts up</strong>.
+ *
+ * <p>
+ * The Initializer will start system scheduler which recording CPU / MEMORY usage in every seconds
+ */
 @Component
 @Profile("!test")
 @Slf4j
@@ -26,7 +33,6 @@ public class Initializer implements CommandLineRunner, ApplicationContextAware {
 
     @Override
     public void run(String... args) throws Exception {
-        log.info("init");
         // cpu, memory usage checker
         scheduledTaskService.startChild(SystemSchedulerConst.systemSchedulerId,
             SystemSchedulerConst.systemUsageSchedulerName, agentStatusManager::updateStats, 0, 1,