[improve] update monitor state desc (apache#2028)

Signed-off-by: tomsun28 <[email protected]>
kerwin612 · May 23, 2024 · a78f71d · a78f71d
1 parent 8115e39
commit a78f71d
Show file tree

Hide file tree

Showing 16 changed files with 172 additions and 188 deletions.
diff --git a/alerter/src/main/java/org/apache/hertzbeat/alert/calculate/CalculateAlarm.java b/alerter/src/main/java/org/apache/hertzbeat/alert/calculate/CalculateAlarm.java
@@ -101,7 +101,7 @@ public CalculateAlarm(AlerterWorkerPool workerPool, CommonDataQueue dataQueue,
         this.triggeredAlertMap = new ConcurrentHashMap<>(16);
         this.notRecoveredAlertMap = new ConcurrentHashMap<>(16);
         // Initialize stateAlertMap
-        List<Monitor> monitors = monitorDao.findMonitorsByStatus(CommonConstants.UN_AVAILABLE_CODE);
+        List<Monitor> monitors = monitorDao.findMonitorsByStatus(CommonConstants.MONITOR_DOWN_CODE);
         if (monitors != null) {
             for (Monitor monitor : monitors) {
                 HashMap<String, String> tags = new HashMap<>(8);

diff --git a/common/src/main/java/org/apache/hertzbeat/common/constants/CommonConstants.java b/common/src/main/java/org/apache/hertzbeat/common/constants/CommonConstants.java
@@ -56,27 +56,21 @@ public interface CommonConstants {
      * Response status code: Incorrect login account password
      */
     byte MONITOR_LOGIN_FAILED_CODE = 0x05;
-
-    /**
-     * Response status code: Registration failed exception
-     */
-    byte MONITOR_REGISTER_FAILED_CODE = 0x06;
-
-
+
     /**
-     * Monitoring Status Code: Unmonitored
+     * Monitoring status 0: Paused, 1: Up, 2: Down
      */
-    byte UN_MANAGE_CODE = 0x00;
+    byte MONITOR_PAUSED_CODE = 0x00;
 
     /**
-     * Monitoring Status Code: Available
+     * Monitoring status 0: Paused, 1: Up, 2: Down
      */
-    byte AVAILABLE_CODE = 0x01;
+    byte MONITOR_UP_CODE = 0x01;
 
     /**
-     * Monitoring Status Code: Not Available
+     * Monitoring status 0: Paused, 1: Up, 2: Down
      */
-    byte UN_AVAILABLE_CODE = 0x02;
+    byte MONITOR_DOWN_CODE = 0x02;
 
     /**
      * Alarm status: 0 - normal alarm (to be processed)

diff --git a/common/src/main/java/org/apache/hertzbeat/common/entity/manager/Monitor.java b/common/src/main/java/org/apache/hertzbeat/common/entity/manager/Monitor.java
@@ -87,15 +87,13 @@ public class Monitor {
 
     /**
      * Type of monitoring: linux, mysql, jvm...
-     * 监控的类型:linux,mysql,jvm...
      */
     @Schema(title = "Type of monitoring", example = "TanCloud", accessMode = READ_WRITE)
     @Size(max = 100)
     private String app;
 
     /**
      * Monitored peer host: ipv4, ipv6, domain name
-     * 监控的对端host:ipv4,ipv6,域名
      */
     @Schema(title = "The host to monitor", example = "192.167.25.11", accessMode = READ_WRITE)
     @Size(max = 100)
@@ -104,24 +102,21 @@ public class Monitor {
 
     /**
      * Monitoring collection interval time, in seconds
-     * 监控的采集间隔时间,单位秒
      */
     @Schema(title = "Monitoring of the acquisition interval time in seconds", example = "600", accessMode = READ_WRITE)
     @Min(10)
     private Integer intervals;
 
     /**
-     * Monitoring status 0: Unmonitored, 1: Available, 2: Unavailable
-     * 任务状态 0:未监控,1:可用,2:不可用
+     * Monitoring status 0: Paused, 1: Up, 2: Down
      */
-    @Schema(title = "Task status 0: not monitored,1: available,2: unavailable", accessMode = READ_WRITE)
+    @Schema(title = "Task status 0: Paused, 1: Up, 2: Down", accessMode = READ_WRITE)
     @Min(0)
     @Max(4)
     private byte status;
 
     /**
      * Monitoring note description
-     * 监控备注描述
      */
     @Schema(title = "Monitor note description", example = "Availability monitoring of the SAAS website TanCloud", accessMode = READ_WRITE)
     @Size(max = 255)

diff --git a/...ain/java/org/apache/hertzbeat/manager/component/alerter/impl/DbAlertStoreHandlerImpl.java b/...ain/java/org/apache/hertzbeat/manager/component/alerter/impl/DbAlertStoreHandlerImpl.java
@@ -58,17 +58,17 @@ public void store(Alert alert) {
             if (!tags.containsKey(CommonConstants.TAG_MONITOR_HOST)) {
                 tags.put(CommonConstants.TAG_MONITOR_HOST, monitor.getHost());
             }
-            if (monitor.getStatus() == CommonConstants.UN_MANAGE_CODE) {
+            if (monitor.getStatus() == CommonConstants.MONITOR_PAUSED_CODE) {
                 // When monitoring is not monitored, ignore and silence its alarm messages
                 return;
             }
             if (CommonConstants.AVAILABILITY.equals(alert.getTarget())) {
-                if (alert.getStatus() == CommonConstants.ALERT_STATUS_CODE_PENDING && monitor.getStatus() == CommonConstants.AVAILABLE_CODE) {
+                if (alert.getStatus() == CommonConstants.ALERT_STATUS_CODE_PENDING && monitor.getStatus() == CommonConstants.MONITOR_UP_CODE) {
                     // Availability Alarm Need to change the monitoring status to unavailable
-                    monitorService.updateMonitorStatus(monitor.getId(), CommonConstants.UN_AVAILABLE_CODE);
-                } else if (alert.getStatus() == CommonConstants.ALERT_STATUS_CODE_RESTORED && monitor.getStatus() == CommonConstants.UN_AVAILABLE_CODE) {
+                    monitorService.updateMonitorStatus(monitor.getId(), CommonConstants.MONITOR_DOWN_CODE);
+                } else if (alert.getStatus() == CommonConstants.ALERT_STATUS_CODE_RESTORED && monitor.getStatus() == CommonConstants.MONITOR_DOWN_CODE) {
                     // If the alarm is restored, the monitoring state needs to be restored
-                    monitorService.updateMonitorStatus(monitorId, CommonConstants.AVAILABLE_CODE);
+                    monitorService.updateMonitorStatus(monitorId, CommonConstants.MONITOR_UP_CODE);
                 }
             }
         } else {

diff --git a/manager/src/main/java/org/apache/hertzbeat/manager/component/status/CalculateStatus.java b/manager/src/main/java/org/apache/hertzbeat/manager/component/status/CalculateStatus.java
@@ -128,10 +128,10 @@ private void startCalculate() {
                                 List<Monitor> monitorList = monitorDao.findAll(specification);
                                 state = CommonConstants.STATUS_PAGE_COMPONENT_STATE_UNKNOWN;
                                 for (Monitor monitor : monitorList) {
-                                    if (monitor.getStatus() == CommonConstants.UN_AVAILABLE_CODE) {
+                                    if (monitor.getStatus() == CommonConstants.MONITOR_DOWN_CODE) {
                                         state = CommonConstants.STATUS_PAGE_COMPONENT_STATE_ABNORMAL;
                                         break;
-                                    } else if (monitor.getStatus() == CommonConstants.AVAILABLE_CODE) {
+                                    } else if (monitor.getStatus() == CommonConstants.MONITOR_UP_CODE) {
                                         state = CommonConstants.STATUS_PAGE_COMPONENT_STATE_NORMAL;
                                     }
                                 }   

diff --git a/manager/src/main/java/org/apache/hertzbeat/manager/scheduler/CollectorJobScheduler.java b/manager/src/main/java/org/apache/hertzbeat/manager/scheduler/CollectorJobScheduler.java
@@ -133,7 +133,7 @@ public void collectorGoOnline(String identity, CollectorInfo collectorInfo) {
                 continue;
             }
             Monitor monitor = monitorOptional.get();
-            if (monitor.getStatus() == CommonConstants.UN_MANAGE_CODE) {
+            if (monitor.getStatus() == CommonConstants.MONITOR_PAUSED_CODE) {
                 continue;
             }
             try {

diff --git a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/MonitorServiceImpl.java b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/MonitorServiceImpl.java
@@ -211,7 +211,7 @@ public void addMonitor(Monitor monitor, List<Param> params, String collector) th
             }
             monitor.setId(monitorId);
             monitor.setJobId(jobId);
-            monitor.setStatus(CommonConstants.AVAILABLE_CODE);
+            monitor.setStatus(CommonConstants.MONITOR_UP_CODE);
             monitorDao.save(monitor);
             paramDao.saveAll(params);
         } catch (Exception e) {
@@ -258,7 +258,7 @@ public void addNewMonitorOptionalMetrics(List<String> metrics, Monitor monitor,
         try {
             monitor.setId(monitorId);
             monitor.setJobId(jobId);
-            monitor.setStatus(CommonConstants.AVAILABLE_CODE);
+            monitor.setStatus(CommonConstants.MONITOR_UP_CODE);
             monitorDao.save(monitor);
             paramDao.saveAll(params);
         } catch (Exception e) {
@@ -514,7 +514,7 @@ public void modifyMonitor(Monitor monitor, List<Param> params, String collector)
                 tag.setTagValue(monitor.getName());
             }
         }
-        if (preMonitor.getStatus() != CommonConstants.UN_MANAGE_CODE) {
+        if (preMonitor.getStatus() != CommonConstants.MONITOR_PAUSED_CODE) {
             // Construct the collection task Job entity
             Job appDefine = appService.getAppDefine(monitor.getApp());
             if (CommonConstants.PROMETHEUS.equals(monitor.getApp())) {
@@ -640,8 +640,8 @@ public void cancelManageMonitors(HashSet<Long> ids) {
         // The jobId is not deleted, and the jobId is reused again after the management is started.
         List<Monitor> managedMonitors = monitorDao.findMonitorsByIdIn(ids)
                 .stream().filter(monitor ->
-                        monitor.getStatus() != CommonConstants.UN_MANAGE_CODE)
-                .peek(monitor -> monitor.setStatus(CommonConstants.UN_MANAGE_CODE))
+                        monitor.getStatus() != CommonConstants.MONITOR_PAUSED_CODE)
+                .peek(monitor -> monitor.setStatus(CommonConstants.MONITOR_PAUSED_CODE))
                 .collect(Collectors.toList());
         if (!managedMonitors.isEmpty()) {
             for (Monitor monitor : managedMonitors) {
@@ -656,8 +656,8 @@ public void enableManageMonitors(HashSet<Long> ids) {
         // Update monitoring status Add corresponding monitoring periodic task
         List<Monitor> unManagedMonitors = monitorDao.findMonitorsByIdIn(ids)
                 .stream().filter(monitor ->
-                        monitor.getStatus() == CommonConstants.UN_MANAGE_CODE)
-                .peek(monitor -> monitor.setStatus(CommonConstants.AVAILABLE_CODE))
+                        monitor.getStatus() == CommonConstants.MONITOR_PAUSED_CODE)
+                .peek(monitor -> monitor.setStatus(CommonConstants.MONITOR_UP_CODE))
                 .collect(Collectors.toList());
         if (!unManagedMonitors.isEmpty()) {
             for (Monitor monitor : unManagedMonitors) {
@@ -708,9 +708,9 @@ public List<AppCount> getAllAppMonitorsCount() {
             AppCount appCount = appCountMap.getOrDefault(item.getApp(), new AppCount());
             appCount.setApp(item.getApp());
             switch (item.getStatus()) {
-                case CommonConstants.AVAILABLE_CODE -> appCount.setAvailableSize(appCount.getAvailableSize() + item.getSize());
-                case CommonConstants.UN_AVAILABLE_CODE -> appCount.setUnAvailableSize(appCount.getUnAvailableSize() + item.getSize());
-                case CommonConstants.UN_MANAGE_CODE -> appCount.setUnManageSize(appCount.getUnManageSize() + item.getSize());
+                case CommonConstants.MONITOR_UP_CODE -> appCount.setAvailableSize(appCount.getAvailableSize() + item.getSize());
+                case CommonConstants.MONITOR_DOWN_CODE -> appCount.setUnAvailableSize(appCount.getUnAvailableSize() + item.getSize());
+                case CommonConstants.MONITOR_PAUSED_CODE -> appCount.setUnManageSize(appCount.getUnManageSize() + item.getSize());
                 default -> {}
             }
             appCountMap.put(item.getApp(), appCount);
@@ -750,7 +750,7 @@ public void copyMonitors(List<Long> ids) {
     @Override
     public void updateAppCollectJob(Job job) {
         List<Monitor> monitors = monitorDao.findMonitorsByAppEquals(job.getApp())
-                .stream().filter(monitor -> monitor.getStatus() != CommonConstants.UN_MANAGE_CODE)
+                .stream().filter(monitor -> monitor.getStatus() != CommonConstants.MONITOR_PAUSED_CODE)
                 .toList();
         if (monitors.isEmpty()) {
             return;

diff --git a/manager/src/test/java/org/apache/hertzbeat/manager/service/MonitorServiceTest.java b/manager/src/test/java/org/apache/hertzbeat/manager/service/MonitorServiceTest.java
@@ -681,7 +681,7 @@ void enableManageMonitors() {
         List<Monitor> monitors = new ArrayList<>();
         for (Long id : ids) {
             Monitor monitor = Monitor.builder().jobId(id).intervals(1).app("app").name("memory").host("host").id(id).build();
-            monitor.setStatus(CommonConstants.UN_MANAGE_CODE);
+            monitor.setStatus(CommonConstants.MONITOR_PAUSED_CODE);
             monitors.add(monitor);
         }
         when(monitorDao.findMonitorsByIdIn(ids)).thenReturn(monitors);
@@ -700,7 +700,7 @@ void getAllAppMonitorsCount() {
         List<AppCount> appCounts = new ArrayList<>();
         AppCount appCount = new AppCount();
         appCount.setApp("test");
-        appCount.setStatus(CommonConstants.AVAILABLE_CODE);
+        appCount.setStatus(CommonConstants.MONITOR_UP_CODE);
         appCounts.add(appCount);
         when(monitorDao.findAppsStatusCount()).thenReturn(appCounts);
 
@@ -721,7 +721,7 @@ void getMonitor() {
 
     @Test
     void updateMonitorStatus() {
-        assertDoesNotThrow(() -> monitorService.updateMonitorStatus(1L, CommonConstants.AVAILABLE_CODE));
+        assertDoesNotThrow(() -> monitorService.updateMonitorStatus(1L, CommonConstants.MONITOR_UP_CODE));
     }
 
     @Test

diff --git a/web-app/src/app/pojo/Monitor.ts b/web-app/src/app/pojo/Monitor.ts
@@ -25,7 +25,7 @@ export class Monitor {
   app!: string;
   host!: string;
   intervals: number = 60;
-  // 任务状态 0:未监控,1:可用,2:不可用
+  // Monitoring status 0: Paused, 1: Up, 2: Down
   status!: number;
   description!: string;
   creator!: string;

diff --git a/web-app/src/app/routes/alert/alert-setting/alert-setting.component.html b/web-app/src/app/routes/alert/alert-setting/alert-setting.component.html
@@ -418,7 +418,7 @@
         </nz-form-label>
         <nz-form-control [nzSpan]="10">
           <span style="color: red">
-            <nz-tag nzColor="error">{{ 'monitor.status.unavailable' | i18n }}</nz-tag>
+            <nz-tag nzColor="error">{{ 'monitor.status.down' | i18n }}</nz-tag>
             <nz-tag nzColor="error">{{ 'monitor.status.unreachable' | i18n }}</nz-tag>
             {{ 'alert.setting.trigger' | i18n }}
           </span>