feat: [manager,alert,collector,common]feature:Modify monitoring and add transaction support. Monitoring compatible with Chinese and English #wqh

feat: [manager]feature:Delete notification operation compatibility query is empty #huacheng
feat: MonitorsController Chinese and English support #huacheng
2022-04-13 22:46:36 +08:00 · 2022-04-12 00:17:40 +08:00 · 2022-04-11 20:52:31 +08:00
23 changed files with 391 additions and 133 deletions
--- a/alerter/src/main/java/com/usthe/alert/dao/AlertDefineBindDao.java
+++ b/alerter/src/main/java/com/usthe/alert/dao/AlertDefineBindDao.java
@@ -7,34 +7,43 @@ import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
 import java.util.List;

 /**
- * AlertDefineBind 数据库操作
+ * AlertDefineBind database operations  数据库操作
+ *
 * @author tom
 * @date 2021/12/9 10:03
 */
 public interface AlertDefineBindDao extends JpaRepository<AlertDefineMonitorBind, Long>, JpaSpecificationExecutor<AlertDefineMonitorBind> {

    /**
+     * Delete the alarm definition and monitor association based on the alarm definition ID
     * 根据告警定义ID删除告警定义与监控关联
-     * @param alertDefineId 告警定义ID
+     *
+     * @param alertDefineId Alarm Definition ID     告警定义ID
     */
    void deleteAlertDefineBindsByAlertDefineIdEquals(Long alertDefineId);

    /**
+     * Deleting alarms based on monitoring IDs defines monitoring associations
     * 根据监控ID删除告警定义监控关联
-     * @param monitorId 监控ID
+     *
+     * @param monitorId Monitor Id   监控ID
     */
    void deleteAlertDefineMonitorBindsByMonitorIdEquals(Long monitorId);

    /**
+     * Delete alarm definition monitoring association based on monitoring ID list
     * 根据监控ID列表删除告警定义监控关联
-     * @param monitorIds 监控ID列表
+     *
+     * @param monitorIds Monitoring ID List     监控ID列表
     */
    void deleteAlertDefineMonitorBindsByMonitorIdIn(List<Long> monitorIds);

    /**
+     * Query monitoring related information based on alarm definition ID
     * 根据告警定义ID查询监控关联信息
-     * @param alertDefineId 告警定义ID
-     * @return 关联监控信息
+     *
+     * @param alertDefineId Alarm Definition ID     告警定义ID
+     * @return Associated monitoring information    关联监控信息
     */
    List<AlertDefineMonitorBind> getAlertDefineBindsByAlertDefineIdEquals(Long alertDefineId);
 }
--- a/collector/src/main/java/com/usthe/collector/dispatch/entrance/internal/CollectJobService.java
+++ b/collector/src/main/java/com/usthe/collector/dispatch/entrance/internal/CollectJobService.java
@@ -15,6 +15,7 @@ import java.util.concurrent.TimeUnit;

 /**
 * 采集job管理提供api接口
+ *
 * @author tomsun28
 * @date 2021/11/6 13:58
 */
@@ -26,9 +27,11 @@ public class CollectJobService {
    private TimerDispatch timerDispatch;

    /**
+     * Execute a one-time collection task and get the collected data response
     * 执行一次性采集任务,获取采集数据响应
-     * @param job 采集任务详情
-     * @return 采集结果
+     *
+     * @param job Collect task details  采集任务详情
+     * @return Collection results       采集结果
     */
    public List<CollectRep.MetricsData> collectSyncJobData(Job job) {
        final List<CollectRep.MetricsData> metricsData = new LinkedList<>();
@@ -52,9 +55,11 @@ public class CollectJobService {
    }

    /**
+     * Issue periodic asynchronous collection tasks
     * 下发周期性异步采集任务
-     * @param job 采集任务详情
-     * @return long 任务ID
+     *
+     * @param job Collect task details      采集任务详情
+     * @return long Job ID      任务ID
     */
    public long addAsyncCollectJob(Job job) {
        if (job.getId() == 0L) {
@@ -66,8 +71,10 @@ public class CollectJobService {
    }

    /**
+     * Update the periodic asynchronous collection tasks that have been delivered
     * 更新已经下发的周期性异步采集任务
-     * @param modifyJob 采集任务详情
+     *
+     * @param modifyJob Collect task details        采集任务详情
     */
    public void updateAsyncCollectJob(Job modifyJob) {
        timerDispatch.deleteJob(modifyJob.getId(), true);
@@ -75,8 +82,10 @@ public class CollectJobService {
    }

    /**
+     * Cancel periodic asynchronous collection tasks
     * 取消周期性异步采集任务
-     * @param jobId 任务ID
+     *
+     * @param jobId Job ID      任务ID
     */
    public void cancelAsyncCollectJob(Long jobId) {
        timerDispatch.deleteJob(jobId, true);
--- a/collector/src/main/java/com/usthe/collector/dispatch/timer/TimerDispatch.java
+++ b/collector/src/main/java/com/usthe/collector/dispatch/timer/TimerDispatch.java
@@ -10,36 +10,44 @@ import java.util.concurrent.TimeUnit;

 /**
 * 时间轮调度接口
+ *
 * @author tomsun28
 * @date 2021/10/17 22:14
 */
 public interface TimerDispatch {

    /**
+     * Add new job
     * 增加新的job
-     * @param addJob job
-     * @param eventListener 一次性同步任务监听器，异步任务不需要listener
+     *
+     * @param addJob        job
+     * @param eventListener One-time synchronous task listener, asynchronous task does not need listener一次性同步任务监听器，异步任务不需要listener
     */
    void addJob(Job addJob, CollectResponseEventListener eventListener);

    /**
     * 调度循环周期性job
+     *
     * @param timerTask timerTask
-     * @param interval 开始调度的间隔时间
-     * @param timeUnit 时间单位
+     * @param interval  开始调度的间隔时间
+     * @param timeUnit  时间单位
     */
    void cyclicJob(WheelTimerTask timerTask, long interval, TimeUnit timeUnit);

    /**
+     * Delete existing job
     * 删除存在的job
-     * @param jobId jobId
-     * @param isCyclic 是否是周期性任务,true是, false为临时性任务
+     *
+     * @param jobId    jobId
+     * @param isCyclic Whether it is a periodic task, true is, false is a temporary task
+     *                 是否是周期性任务,true是, false为临时性任务
     */
    void deleteJob(long jobId, boolean isCyclic);

    /**
     * 一次性同步采集任务采集结果通知监听器
-     * @param jobId  jobId
+     *
+     * @param jobId            jobId
     * @param metricsDataTemps 采集结果数据
     */
    void responseSyncJobData(long jobId, List<CollectRep.MetricsData> metricsDataTemps);
--- a/collector/src/main/java/com/usthe/collector/dispatch/timer/TimerDispatcher.java
+++ b/collector/src/main/java/com/usthe/collector/dispatch/timer/TimerDispatcher.java
@@ -18,18 +18,22 @@ import java.util.concurrent.TimeUnit;
 public class TimerDispatcher implements TimerDispatch {

    /**
+     * time round schedule
     * 时间轮调度
     */
    private Timer wheelTimer;
    /**
+     * Existing periodic scheduled tasks
     * 已存在的周期性调度任务
     */
    private Map<Long, Timeout> currentCyclicTaskMap;
    /**
+     * Existing temporary scheduled tasks
     * 已存在的临时性调度任务
     */
    private Map<Long, Timeout> currentTempTaskMap;
    /**
+     * One-time task response listener holds
     * 一次性任务响应监听器持有
     * jobId - listener
     */
--- a/collector/src/main/java/com/usthe/collector/dispatch/timer/WheelTimerTask.java
+++ b/collector/src/main/java/com/usthe/collector/dispatch/timer/WheelTimerTask.java
@@ -22,7 +22,9 @@ import java.util.Map;
 import java.util.stream.Collectors;

 /**
+ * Timer Task implementation
 * TimerTask实现
+ *
 * @author tomsun28
 * @date 2021/11/1 17:18
 */
@@ -36,12 +38,15 @@ public class WheelTimerTask implements TimerTask {
    public WheelTimerTask(Job job) {
        this.metricsTaskDispatch = SpringContextHolder.getBean(MetricsTaskDispatch.class);
        this.job = job;
+        // The initialization job will monitor the actual parameter value and replace the collection field
        // 初始化job 将监控实际参数值对采集字段进行替换
        initJobMetrics(job);
    }

    /**
+     * Initialize job fill information
     * 初始化job填充信息
+     *
     * @param job job
     */
    private void initJobMetrics(Job job) {
@@ -73,9 +78,10 @@ public class WheelTimerTask implements TimerTask {
    }

    /**
-     * json参数替换
+     * json parameter replacement       json参数替换
+     *
     * @param jsonElement json
-     * @param configmap 参数map
+     * @param configmap   parameter map   参数map
     * @return json
     */
    private JsonElement replaceSpecialValue(JsonElement jsonElement, Map<String, Configmap> configmap) {
@@ -86,26 +92,29 @@ public class WheelTimerTask implements TimerTask {
                Map.Entry<String, JsonElement> entry = iterator.next();
                JsonElement element = entry.getValue();
                String key = entry.getKey();
+                // Replace the attributes of the KEY-VALUE case such as http headers params
                // 替换KEY-VALUE情况的属性 比如http headers params
                if (key != null && key.startsWith("^_^") && key.endsWith("^_^")) {
                    key = key.replaceAll("\\^_\\^", "");
                    Configmap param = configmap.get(key);
                    if (param != null && param.getType() == (byte) 3) {
                        String jsonValue = (String) param.getValue();
-                         Map<String, String> map = GsonUtil.fromJson(jsonValue, Map.class);
-                         if (map != null) {
-                             map.forEach((name, value) -> {
-                                 if (name != null && !"".equals(name.trim())) {
-                                     jsonObject.addProperty(name, value);
-                                 }
-                             });
-                         }
+                        Map<String, String> map = GsonUtil.fromJson(jsonValue, Map.class);
+                        if (map != null) {
+                            map.forEach((name, value) -> {
+                                if (name != null && !"".equals(name.trim())) {
+                                    jsonObject.addProperty(name, value);
+                                }
+                            });
+                        }
                    }
                    iterator.remove();
                    continue;
                }
+                // Replace normal VALUE value
                // 替换正常的VALUE值
                if (element.isJsonPrimitive()) {
+                    // Check if there are special characters Replace
                    // 判断是否含有特殊字符 替换
                    String value = element.getAsString();
                    if (value.startsWith("^_^") && value.endsWith("^_^")) {
@@ -129,6 +138,7 @@ public class WheelTimerTask implements TimerTask {
            while (iterator.hasNext()) {
                JsonElement element = iterator.next();
                if (element.isJsonPrimitive()) {
+                    // Check if there are special characters Replace
                    // 判断是否含有特殊字符 替换
                    String value = element.getAsString();
                    if (value.startsWith("^_^") && value.endsWith("^_^")) {
--- a/common/src/main/java/com/usthe/common/entity/job/Configmap.java
+++ b/common/src/main/java/com/usthe/common/entity/job/Configmap.java
@@ -6,8 +6,12 @@ import lombok.Data;
 import lombok.NoArgsConstructor;

 /**
+ * Monitoring configuration parameter properties and values
 * 监控配置参数属性及值
+ * During the process, you need to replace the content with the identifier ^_^key^_^
+ * in the protocol configuration parameter with the real value in the configuration parameter
 * 过程中需要将协议配置参数里面的标识符为^_^key^_^的内容替换为配置参数里的真实值
+ *
 * @author tomsun28
 * @date 2021/10/29 22:04
 */
@@ -18,16 +22,20 @@ import lombok.NoArgsConstructor;
 public class Configmap {

    /**
+     * Parameter key, replace the content with the identifier ^^_key_^^ in the protocol
+     * configuration parameter with the real value in the configuration parameter
+     * <p>
     * 参数key,将协议配置参数里面的标识符为^^_key_^^的内容替换为配置参数里的真实值
     */
    private String key;

    /**
-     * 参数value
+     * parameter value  参数value
     */
    private Object value;

    /**
+     * Parameter type 0: number 1: string 2: encrypted string 3: json string mapped by map
     * 参数类型 0:数字 1:字符串 2:加密串 3:map映射的json串
     * number,string,secret
     * 数字,非加密字符串,加密字符串
--- a/common/src/main/java/com/usthe/common/entity/job/Job.java
+++ b/common/src/main/java/com/usthe/common/entity/job/Job.java
@@ -21,7 +21,9 @@ import java.util.Set;
 import java.util.stream.Collectors;

 /**
+ * Collect task details
 * 采集任务详情
+ *
 * @author tomsun28
 * @date 2021/10/17 21:19
 */
@@ -35,61 +37,72 @@ public class Job {
    private static final String AVAILABILITY = "availability";

    /**
-     * 任务ID
+     * Task id      任务ID
     */
    private long id;
    /**
+     * Monitoring ID Application ID
     * 监控ID 应用ID
     */
    private long monitorId;
    /**
-     * 监控的大类别
+     * Large categories of monitoring       监控的大类别
+     * service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
     * service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控
     */
    private String category;
    /**
+     * Type of monitoring eg: linux | mysql | jvm
     * 监控的类型 eg: linux | mysql | jvm
     */
    private String app;
    /**
-     * 监控类型的国际化名称
+     * The internationalized name of the monitoring type    监控类型的国际化名称
     * zh-CN: PING连通性
     * en-US: PING CONNECT
     */
    private Map<String, String> name;
    /**
+     * Task dispatch start timestamp
     * 任务派发开始时间戳
     */
    private long timestamp;
    /**
+     * Task collection time interval (unit: second) eg: 30,60,600
     * 任务采集时间间隔(单位秒) eg: 30,60,600
     */
    private long interval = 600L;
    /**
+     * Whether it is a recurring periodic task true is yes, false is no
     * 是否是循环周期性任务 true为是,false为否
     */
    private boolean isCyclic = false;
    /**
+     * Indicator group configuration eg: cpu memory
     * 指标组配置 eg: cpu memory
     */
    private List<Metrics> metrics;
    /**
+     * Monitoring configuration parameter properties and values eg: username password timeout host
     * 监控配置参数属性及值 eg: username password timeout host
     */
    private List<Configmap> configmap;

    /**
+     * collector use - timestamp when the task was scheduled by the time wheel
     * collector使用 - 任务被时间轮开始调度的时间戳
     */
    @JsonIgnore
    private transient long dispatchTime;

    /**
+     * collector use - task version, this field is not stored in etcd
     * collector使用 - 任务版本,此字段不存储于etcd
     */
    @JsonIgnore
    private transient long version;
    /**
+     * collector usage - metric group task execution priority view
     * collector使用 - 指标组任务执行优先级视图
     * 0 - availability
     * 1 - cpu | memory
@@ -103,27 +116,32 @@ public class Job {
    private transient List<Set<Metrics>> priorMetrics;

    /**
+     * collector use - Temporarily store one-time task indicator group response data
     * collector使用 - 临时存储一次性任务指标组响应数据
     */
    @JsonIgnore
    private transient List<CollectRep.MetricsData> responseDataTemp;

    /**
+     * collector uses - construct to initialize metrics group execution view
     * collector使用 - 构造初始化指标组执行视图
     */
    public synchronized void constructPriorMetrics() {
        Map<Byte, List<Metrics>> map = metrics.stream()
                .peek(metric -> {
+                    // Determine whether to configure aliasFields If not, configure the default
                    // 判断是否配置aliasFields 没有则配置默认
                    if (metric.getAliasFields() == null || metric.getAliasFields().isEmpty()) {
                        metric.setAliasFields(metric.getFields().stream().map(Metrics.Field::getField).collect(Collectors.toList()));
                    }
+                    // Set the default indicator group execution priority, if not filled, the default last priority
                    // 设置默认的指标组执行优先级,不填则默认最后优先级
                    if (metric.getPriority() == null) {
                        metric.setPriority(Byte.MAX_VALUE);
                    }
                })
                .collect(Collectors.groupingBy(Metrics::getPriority));
+        // Construct a linked list of task execution order of the indicator group
        // 构造指标组任务执行顺序链表
        priorMetrics = new LinkedList<>();
        map.values().forEach(metric -> {
@@ -141,12 +159,18 @@ public class Job {
    }

    /**
+     * collector use - to get the next set of priority metric group tasks
     * collector使用 - 获取下一组优先级的指标组任务
-     * @param metrics 当前指标组
-     * @param first 是否是第一次获取
-     * @return 指标组任务
+     *
+     * @param metrics Current indicator group       当前指标组
+     * @param first   Is it the first time to get     是否是第一次获取
+     * @return Metric Group Tasks       指标组任务
+     * Returning null means: the job has been completed, and the collection of all indicator groups has ended
     * 返回null表示：job已完成,所有指标组采集结束
+     * Returning the empty set indicates that there are still indicator group collection tasks at the current
+     * level that have not been completed,and the next level indicator group task collection cannot be performed.
     * 返回empty的集合表示：当前级别下还有指标组采集任务未结束,无法进行下一级别的指标组任务采集
+     * Returns a set of data representation: get the next set of priority index group tasks
     * 返回有数据集合表示：获取到下一组优先级的指标组任务
     */
    public synchronized Set<Metrics> getNextCollectMetrics(Metrics metrics, boolean first) {
@@ -189,7 +213,7 @@ public class Job {

    @Override
    public Job clone() {
-        // 深度克隆
+        // deep clone   深度克隆
        return GsonUtil.fromJson(GsonUtil.toJson(this), Job.class);
    }
 }
--- a/common/src/main/java/com/usthe/common/entity/job/Metrics.java
+++ b/common/src/main/java/com/usthe/common/entity/job/Metrics.java
@@ -15,7 +15,10 @@ import java.util.List;
 import java.util.Objects;

 /**
+ * Details of the collection of indicators collected by monitoring
+ * eg: cpu | memory | health
 * 监控采集的指标集合详情 eg: cpu | memory | health
+ *
 * @author tomsun28
 * @date 2021/10/17 21:24
 */
@@ -26,6 +29,7 @@ import java.util.Objects;
 public class Metrics {

    /**
+     * public property-name eg: cpu | memory | health
     * 公共属性-名称 eg: cpu | memory | health
     */
    private String name;
@@ -34,20 +38,27 @@ public class Metrics {
     */
    private String protocol;
    /**
+     * Range (0-127) indicator group scheduling priority, the smaller the value, the higher the priority
+     * The collection task of the next priority indicator group will be scheduled only after the scheduled collection with the higher priority is completed.
+     * The default priority of the availability indicator group is 0, and the range of other common indicator groups is 1-127, that is,
+     * the subsequent indicator group tasks will only be scheduled after the availability is collected successfully.
     * 范围(0-127)指标组调度优先级,数值越小优先级越高
     * 优先级高的调度采集完成后才会调度下一优先级的指标组采集任务
     * 可用性指标组(availability)默认优先级为0,其它普通指标组范围为1-127,即需要等availability采集成功后才会调度后面的指标组任务
     */
    private Byte priority;
    /**
+     * Public attribute - collection and monitoring final result attribute set eg: speed | times | size
     * 公共属性-采集监控的最终结果属性集合 eg: speed | times | size
     */
    private List<Field> fields;
    /**
+     * Public attribute - collection and monitoring pre-query attribute set eg: size1 | size2 | speedSize
     * 公共属性-采集监控的前置查询属性集合 eg: size1 | size2 | speedSize
     */
    private List<String> aliasFields;
    /**
+     * Public attribute - expression calculation, map the pre-query attribute (pre Fields) with the final attribute (fields), and calculate the final attribute (fields) value
     * 公共属性-表达式计算，将前置查询属性(preFields)与最终属性(fields)映射,计算出最终属性(fields)值
     * eg: size = size1 + size2, speed = speedSize
     * https://www.yuque.com/boyan-avfmj/aviatorscript/ban32m
@@ -55,26 +66,32 @@ public class Metrics {
    private List<String> calculates;

    /**
+     * Monitoring configuration information using the http protocol
     * 使用http协议的监控配置信息
     */
    private HttpProtocol http;
    /**
+     * Monitoring configuration information for ping using the icmp protocol
     * 使用icmp协议进行ping的监控配置信息
     */
    private IcmpProtocol icmp;
    /**
+     * Monitoring configuration information using the telnet protocol
     * 使用telnet协议的监控配置信息
     */
    private TelnetProtocol telnet;
    /**
+     * Use tcp or ucp implemented by socket for service port detection configuration information
     * 使用socket实现的tcp或ucp进行服务端口探测配置信息
     */
    private TcpUdpProtocol tcpUdp;
    /**
+     * Database configuration information implemented using the public jdbc specification
     * 使用公共的jdbc规范实现的数据库配置信息
     */
    private JdbcProtocol jdbc;
    /**
+     * Monitoring configuration information using the public ssh protocol
     * 使用公共的ssh协议的监控配置信息
     */
    private SshProtocol ssh;
@@ -101,18 +118,22 @@ public class Metrics {
    @NoArgsConstructor
    public static class Field {
        /**
+         * Indicator name
         * 指标名称
         */
        private String field;
        /**
+         * Indicator type 0-number: number 1-string: string
         * 指标类型 0-number:数字 1-string:字符串
         */
        private byte type = 1;
        /**
+         * Whether this field is the instance primary key
         * 此字段是否为实例主键
         */
        private boolean instance = false;
        /**
+         * Indicator unit
         * 指标单位
         */
        private String unit;
--- a/common/src/main/java/com/usthe/common/entity/manager/Monitor.java
+++ b/common/src/main/java/com/usthe/common/entity/manager/Monitor.java
@@ -22,7 +22,9 @@ import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_ONLY;
 import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_WRITE;

 /**
+ * Monitor Entity
 * 监控实体
+ *
 * @author tomsun28
 * @date 2021/11/14 9:53
 */
@@ -32,10 +34,11 @@ import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_WRITE;
@Builder
@AllArgsConstructor
@NoArgsConstructor
-@ApiModel(description = "监控实体")
+@ApiModel(description = "en: Monitor Entity,zh: 监控实体")
 public class Monitor {

    /**
+     * Monitor ID
     * 主键ID
     */
    @Id
@@ -43,12 +46,14 @@ public class Monitor {
    private Long id;

    /**
+     * Job ID
     * 监控对应下发的任务ID
     */
    @ApiModelProperty(value = "任务ID", example = "43243543543", accessMode = READ_ONLY, position = 1)
    private Long jobId;

    /**
+     * Monitor Name
     * 监控的名称
     */
    @ApiModelProperty(value = "监控名称", example = "Api-TanCloud.cn", accessMode = READ_WRITE, position = 2)
@@ -56,6 +61,7 @@ public class Monitor {
    private String name;

    /**
+     * Type of monitoring: linux, mysql, jvm...
     * 监控的类型:linux,mysql,jvm...
     */
    @ApiModelProperty(value = "监控类型", example = "TanCloud", accessMode = READ_WRITE, position = 3)
@@ -63,6 +69,7 @@ public class Monitor {
    private String app;

    /**
+     * Monitored peer host: ipv4, ipv6, domain name
     * 监控的对端host:ipv4,ipv6,域名
     */
    @ApiModelProperty(value = "监控的对端host", example = "192.167.25.11", accessMode = READ_WRITE, position = 4)
@@ -71,6 +78,7 @@ public class Monitor {
    private String host;

    /**
+     * Monitoring collection interval time, in seconds
     * 监控的采集间隔时间,单位秒
     */
    @ApiModelProperty(value = "监控的采集间隔时间,单位秒", example = "600", accessMode = READ_WRITE, position = 5)
@@ -78,6 +86,7 @@ public class Monitor {
    private Integer intervals;

    /**
+     * Monitoring status 0: Unmonitored, 1: Available, 2: Unavailable, 3: Unreachable, 4: Suspended
     * 监控状态 0:未监控,1:可用,2:不可用,3:不可达,4:挂起
     */
    @ApiModelProperty(value = "监控状态 0:未监控,1:可用,2:不可用,3:不可达,4:挂起", accessMode = READ_WRITE, position = 6)
@@ -86,6 +95,7 @@ public class Monitor {
    private byte status;

    /**
+     * Monitoring note description
     * 监控备注描述
     */
    @ApiModelProperty(value = "监控备注描述", example = "对SAAS网站TanCloud的可用性监控", accessMode = READ_WRITE, position = 7)
@@ -93,18 +103,21 @@ public class Monitor {
    private String description;

    /**
+     * The creator of this record
     * 此条记录创建者
     */
    @ApiModelProperty(value = "此条记录创建者", example = "tom", accessMode = READ_ONLY, position = 8)
    private String creator;

    /**
+     * This record was last modified by
     * 此条记录最新修改者
     */
    @ApiModelProperty(value = "此条记录最新修改者", example = "tom", accessMode = READ_ONLY, position = 9)
    private String modifier;

    /**
+     * record creation time (millisecond timestamp)
     * 记录创建时间
     */
    @ApiModelProperty(value = "记录创建时间(毫秒时间戳)", example = "1612198922000", accessMode = READ_ONLY, position = 10)
@@ -112,6 +125,7 @@ public class Monitor {
    private LocalDateTime gmtCreate;

    /**
+     * Record the latest modification time (timestamp in milliseconds)
     * 记录最新修改时间
     */
    @ApiModelProperty(value = "记录最新修改时间(毫秒时间戳)", example = "1612198444000", accessMode = READ_ONLY, position = 11)
--- a/common/src/main/java/com/usthe/common/entity/manager/Param.java
+++ b/common/src/main/java/com/usthe/common/entity/manager/Param.java
@@ -23,7 +23,9 @@ import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_ONLY;
 import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_WRITE;

 /**
+ * Monitor parameter values
 * 监控参数值
+ *
 * @author tomsun28
 * @date 2021/11/13 22:19
 */
@@ -33,21 +35,26 @@ import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_WRITE;
@Builder
@AllArgsConstructor
@NoArgsConstructor
-@ApiModel(description = "参数实体")
+@ApiModel(description = "嗯： Parameter Entity,zh: 参数实体")
 public class Param {

+    /**
+     * Parameter primary key index ID
+     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @ApiModelProperty(value = "参数主键索引ID", example = "87584674384", accessMode = READ_ONLY, position = 0)
    private Long id;

    /**
+     * Monitor ID
     * 监控ID
     */
    @ApiModelProperty(value = "监控ID", example = "875846754543", accessMode = READ_WRITE, position = 1)
    private Long monitorId;

    /**
+     * Parameter Field Identifier
     * 参数字段标识符
     */
    @ApiModelProperty(value = "参数标识符字段", example = "port", accessMode = READ_WRITE, position = 2)
@@ -56,6 +63,7 @@ public class Param {
    private String field;

    /**
+     * Param Value
     * 参数值
     */
    @ApiModelProperty(value = "参数值", example = "8080", accessMode = READ_WRITE, position = 3)
@@ -63,6 +71,7 @@ public class Param {
    private String value;

    /**
+     * Parameter type 0: number 1: string 2: encrypted string 3: json string mapped by map
     * 参数类型 0:数字 1:字符串 2:加密串 3:map映射的json串
     */
    @ApiModelProperty(value = "参数类型 0:数字 1:字符串 2:加密串 3:map映射的json串", accessMode = READ_WRITE, position = 4)
@@ -71,6 +80,7 @@ public class Param {
    private byte type;

    /**
+     * Record Creation Time
     * 记录创建时间
     */
    @ApiModelProperty(value = "记录创建时间(毫秒时间戳)", example = "1612198922000", accessMode = READ_ONLY, position = 5)
@@ -78,6 +88,7 @@ public class Param {
    private LocalDateTime gmtCreate;

    /**
+     * Record the latest modification time
     * 记录最新修改时间
     */
    @ApiModelProperty(value = "记录最新修改时间(毫秒时间戳)", example = "1612198444000", accessMode = READ_ONLY, position = 6)
--- a/common/src/main/java/com/usthe/common/util/CommonConstants.java
+++ b/common/src/main/java/com/usthe/common/util/CommonConstants.java
@@ -1,175 +1,208 @@
 package com.usthe.common.util;

 /**
+ * Public Constant
 * 公共常量
+ *
 * @author tomsun28
 * @date 2021/11/14 12:06
 */
 public interface CommonConstants {

    /**
+     * Response status code: generic success
     * 响应状态码: 通用成功
     */
    byte SUCCESS_CODE = 0x00;

    /**
+     * Response status code: generic failure
     * 响应状态码: 通用失败
     */
    byte FAIL_CODE = 0x0F;

    /**
+     * Response status code: Parameter verification failed
     * 响应状态码: 参数校验失败
     */
    byte PARAM_INVALID_CODE = 0x01;

    /**
+     * Response Status Code: Probe Failed
     * 响应状态码: 探测失败
     */
    byte DETECT_FAILED_CODE = 0x02;

    /**
+     * Response status code: monitoring does not exist
     * 响应状态码: 监控不存在
     */
    byte MONITOR_NOT_EXIST_CODE = 0x03;

    /**
+     * Response Status Code: Monitor Service Conflict
     * 响应状态码: 监控服务冲突
     */
    byte MONITOR_CONFLICT_CODE = 0x04;

    /**
+     * 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: Unmanaged
     * 监控状态码: 未管理
     */
    byte UN_MANAGE_CODE = 0x00;

    /**
+     * Monitoring Status Code: Available
     * 监控状态码: 可用
     */
    byte AVAILABLE_CODE = 0x01;

    /**
+     * Monitoring Status Code: Not Available
     * 监控状态码: 不可用
     */
    byte UN_AVAILABLE_CODE = 0x02;

    /**
+     * Monitoring Status Code: Unreachable
     * 监控状态码: 不可达
     */
    byte UN_REACHABLE_CODE = 0x03;

    /**
+     * Monitoring Status Code: Pending
     * 监控状态码: 挂起
     */
    byte SUSPENDING_CODE = 0x04;

    /**
+     * Alarm status: 0 - normal alarm (to be processed)
     * 告警状态: 0-正常告警(待处理)
     */
    byte ALERT_STATUS_CODE_PENDING = 0x00;

    /**
+     * Alarm Status: 1 - Threshold triggered but not reached the number of alarms
     * 告警状态: 1-阈值触发但未达到告警次数
     */
    byte ALERT_STATUS_CODE_NOT_REACH = 0x01;

    /**
+     * Alarm Status: 2-Restore Alarm
     * 告警状态: 2-恢复告警
     */
    byte ALERT_STATUS_CODE_RESTORED = 0x02;

    /**
+     * Alert Status: 3-Handled
     * 告警状态: 3-已处理
     */
    byte ALERT_STATUS_CODE_SOLVED = 0x03;

    /**
+     * Alarm level: 0: high-emergency-emergency-red
     * 告警级别: 0:高-emergency-紧急告警-红色
     */
    byte ALERT_PRIORITY_CODE_EMERGENCY = 0x00;

    /**
+     * Alarm severity: 1: medium-critical-critical alarm-orange
     * 告警级别: 1:中-critical-严重告警-橙色
     */
    byte ALERT_PRIORITY_CODE_CRITICAL = 0x01;

    /**
+     * Warning level: 2: low-warning-warning warning-yellow
     * 告警级别: 2:低-warning-警告告警-黄色
     */
    byte ALERT_PRIORITY_CODE_WARNING = 0x02;

    /**
+     * Field parameter type: number
     * 字段参数类型: 数字
     */
    byte TYPE_NUMBER = 0;

    /**
+     * Field parameter type: String
     * 字段参数类型: 字符串
     */
    byte TYPE_STRING = 1;

    /**
+     * Field parameter type: encrypted string
     * 字段参数类型: 加密字符串
     */
    byte TYPE_SECRET = 2;

    /**
+     * Collection indicator value: null placeholder for empty value
     * 采集指标值：null空值占位符
     */
    String NULL_VALUE = "&nbsp;";

    /**
+     * Availability Object
     * 可用性对象
     */
    String AVAILABLE = "available";

    /**
-     * 可达性对象
+     * Reachability Object可达性对象
     */
    String REACHABLE = "reachable";

    /**
+     * Parameter Type Number
     * 参数类型 数字
     */
    byte PARAM_TYPE_NUMBER = 0;

    /**
+     * Parameter Type String
     * 参数类型 字符串
     */
    byte PARAM_TYPE_STRING = 1;

    /**
+     * Parameter Type Password
     * 参数类型 密码
     */
    byte PARAM_TYPE_PASSWORD = 2;

    /**
+     * Authentication type Account password
     * 认证类型 账户密码
     */
    byte AUTH_TYPE_PASSWORD = 1;

    /**
+     * Authentication type GITHUB three-party login
     * 认证类型 GITHUB三方登录
     */
    byte AUTH_TYPE_GITHUB = 2;

    /**
+     * Authentication type WeChat three-party login
     * 认证类型 微信三方登录
     */
    byte AUTH_TYPE_WEIXIN = 3;

    /**
+     * Authentication type GITEE three-party login
     * 认证类型 GITEE三方登录
     */
    byte AUTH_TYPE_GITEE = 5;
--- a/common/src/main/java/com/usthe/common/util/SnowFlakeIdGenerator.java
+++ b/common/src/main/java/com/usthe/common/util/SnowFlakeIdGenerator.java
@@ -1,7 +1,9 @@
 package com.usthe.common.util;

 /**
+ * Snowflake Algorithm Generator Tool
 * 雪花算法生成器工具
+ *
 * @author tomsun28
 * @date 2021/11/10 11:04
 */
--- a/manager/src/main/java/com/usthe/manager/controller/MonitorController.java
+++ b/manager/src/main/java/com/usthe/manager/controller/MonitorController.java
@@ -1,6 +1,7 @@
 package com.usthe.manager.controller;

 import com.usthe.common.entity.dto.Message;
+import com.usthe.common.entity.manager.Monitor;
 import com.usthe.manager.pojo.dto.MonitorDto;
 import com.usthe.manager.service.MonitorService;
 import io.swagger.annotations.Api;
@@ -23,11 +24,13 @@ import static com.usthe.common.util.CommonConstants.MONITOR_NOT_EXIST_CODE;
 import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;

 /**
+ * Monitoring management API
 * 监控管理API
+ *
 * @author tomsun28
 * @date 2021/11/14 10:57
 */
-@Api(tags = "监控管理API")
+@Api(tags = "en: Monitoring management API,zh: 监控管理API")
@RestController
@RequestMapping(path = "/monitor", produces = {APPLICATION_JSON_VALUE})
 public class MonitorController {
@@ -36,12 +39,12 @@ public class MonitorController {
    private MonitorService monitorService;

    @PostMapping
-    @ApiOperation(value = "新增监控", notes = "新增一个监控应用")
+    @ApiOperation(value = "Add a monitoring application", notes = "新增一个监控应用")
    public ResponseEntity<Message<Void>> addNewMonitor(@Valid @RequestBody MonitorDto monitorDto) {
-        // 校验请求数据
+        // Verify request data  校验请求数据
        monitorService.validate(monitorDto, false);
        if (monitorDto.isDetected()) {
-            // 进行探测
+            // Probe    进行探测
            monitorService.detectMonitor(monitorDto.getMonitor(), monitorDto.getParams());
        }
        monitorService.addMonitor(monitorDto.getMonitor(), monitorDto.getParams());
@@ -49,12 +52,12 @@ public class MonitorController {
    }

    @PutMapping
-    @ApiOperation(value = "修改监控", notes = "修改一个已存在监控应用")
+    @ApiOperation(value = "Modify an existing monitoring application", notes = "修改一个已存在监控应用")
    public ResponseEntity<Message<Void>> modifyMonitor(@Valid @RequestBody MonitorDto monitorDto) {
-        // 校验请求数据
+        // Verify request data  校验请求数据
        monitorService.validate(monitorDto, true);
        if (monitorDto.isDetected()) {
-            // 进行探测
+            // Probe    进行探测
            monitorService.detectMonitor(monitorDto.getMonitor(), monitorDto.getParams());
        }
        monitorService.modifyMonitor(monitorDto.getMonitor(), monitorDto.getParams());
@@ -62,9 +65,10 @@ public class MonitorController {
    }

    @GetMapping(path = "/{id}")
-    @ApiOperation(value = "查询监控", notes = "根据监控ID获取监控信息")
+    @ApiOperation(value = "Obtain monitoring information based on monitoring ID", notes = "根据监控ID获取监控信息")
    public ResponseEntity<Message<MonitorDto>> getMonitor(
            @ApiParam(value = "监控ID", example = "6565463543") @PathVariable("id") final long id) {
+        // Get monitoring information
        // 获取监控信息
        MonitorDto monitorDto = monitorService.getMonitorDto(id);
        Message.MessageBuilder<MonitorDto> messageBuilder = Message.builder();
@@ -77,16 +81,20 @@ public class MonitorController {
    }

    @DeleteMapping(path = "/{id}")
-    @ApiOperation(value = "删除监控", notes = "根据监控ID删除监控应用,监控不存在也是删除成功")
+    @ApiOperation(value = "Delete monitoring application based on monitoring ID", notes = "根据监控ID删除监控应用")
    public ResponseEntity<Message<Void>> deleteMonitor(
-            @ApiParam(value = "监控ID", example = "6565463543") @PathVariable("id") final long id) {
-        // 删除监控,监控不存在或删除成功都返回成功
+            @ApiParam(value = "en: Monitor ID,zh: 监控ID", example = "6565463543") @PathVariable("id") final long id) {
+        // delete monitor 删除监控
+        Monitor monitor = monitorService.getMonitor(id);
+        if (monitor == null) {
+            return ResponseEntity.ok(new Message<>("The specified monitoring was not queried, please check whether the parameters are correct"));
+        }
        monitorService.deleteMonitor(id);
        return ResponseEntity.ok(new Message<>("Delete success"));
    }

    @PostMapping(path = "/detect")
-    @ApiOperation(value = "探测监控", notes = "根据监控信息去对此监控进行可用性探测")
+    @ApiOperation(value = "Perform availability detection on this monitoring based on monitoring information", notes = "根据监控信息去对此监控进行可用性探测")
    public ResponseEntity<Message<Void>> detectMonitor(@Valid @RequestBody MonitorDto monitorDto) {
        monitorService.validate(monitorDto, null);
        monitorService.detectMonitor(monitorDto.getMonitor(), monitorDto.getParams());
--- a/manager/src/main/java/com/usthe/manager/controller/MonitorsController.java
+++ b/manager/src/main/java/com/usthe/manager/controller/MonitorsController.java
@@ -29,11 +29,13 @@ import java.util.List;
 import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;

 /**
+ * Monitor and manage batch API
 * 监控管理批量API
+ *
 * @author tom
 * @date 2021/12/1 20:43
 */
-@Api(tags = "监控列表API")
+@Api(tags = "en: Monitor and manage batch API,zh: 监控列表API")
@RestController
@RequestMapping(path = "/monitors", produces = {APPLICATION_JSON_VALUE})
 public class MonitorsController {
@@ -44,22 +46,23 @@ public class MonitorsController {
    private MonitorService monitorService;

    @GetMapping
-    @ApiOperation(value = "查询监控列表", notes = "根据查询过滤项获取监控信息列表")
+    @ApiOperation(value = "Obtain a list of monitoring information based on query filter items",
+            notes = "根据查询过滤项获取监控信息列表")
    public ResponseEntity<Message<Page<Monitor>>> getMonitors(
-            @ApiParam(value = "监控ID", example = "6565463543") @RequestParam(required = false) final List<Long> ids,
-            @ApiParam(value = "监控类型", example = "linux") @RequestParam(required = false) final String app,
-            @ApiParam(value = "监控名称，模糊查询", example = "linux-127.0.0.1") @RequestParam(required = false) final String name,
-            @ApiParam(value = "监控Host，模糊查询", example = "127.0.0.1") @RequestParam(required = false) final String host,
-            @ApiParam(value = "监控状态 0:未监控,1:可用,2:不可用,3:不可达,4:挂起,9:全部状态", example = "1") @RequestParam(required = false) final Byte status,
-            @ApiParam(value = "排序字段，默认id", example = "name") @RequestParam(defaultValue = "id") final String sort,
-            @ApiParam(value = "排序方式，asc:升序，desc:降序", example = "desc") @RequestParam(defaultValue = "desc") final String order,
-            @ApiParam(value = "列表当前分页", example = "0") @RequestParam(defaultValue = "0") int pageIndex,
-            @ApiParam(value = "列表分页数量", example = "8") @RequestParam(defaultValue = "8") int pageSize) {
+            @ApiParam(value = "en: Monitor ID,zh: 监控ID", example = "6565463543") @RequestParam(required = false) final List<Long> ids,
+            @ApiParam(value = "en: Monitor Type,zh: 监控类型", example = "linux") @RequestParam(required = false) final String app,
+            @ApiParam(value = "en: Monitor Name,zh: 监控名称，模糊查询", example = "linux-127.0.0.1") @RequestParam(required = false) final String name,
+            @ApiParam(value = "en: Monitor Host,zh: 监控Host，模糊查询", example = "127.0.0.1") @RequestParam(required = false) final String host,
+            @ApiParam(value = "en: Monitor Status,zh: 监控状态 0:未监控,1:可用,2:不可用,3:不可达,4:挂起,9:全部状态", example = "1") @RequestParam(required = false) final Byte status,
+            @ApiParam(value = "en: Sort Field,default id,zh: 排序字段，默认id", example = "name") @RequestParam(defaultValue = "id") final String sort,
+            @ApiParam(value = "en: Sort by,zh: 排序方式，asc:升序，desc:降序", example = "desc") @RequestParam(defaultValue = "desc") final String order,
+            @ApiParam(value = "en: List current page,zh: 列表当前分页", example = "0") @RequestParam(defaultValue = "0") int pageIndex,
+            @ApiParam(value = "en: Number of list pagination,zh: 列表分页数量", example = "8") @RequestParam(defaultValue = "8") int pageSize) {

        Specification<Monitor> specification = (root, query, criteriaBuilder) -> {
            List<Predicate> andList = new ArrayList<>();
            if (ids != null && !ids.isEmpty()) {
-                CriteriaBuilder.In<Long> inPredicate= criteriaBuilder.in(root.get("id"));
+                CriteriaBuilder.In<Long> inPredicate = criteriaBuilder.in(root.get("id"));
                for (long id : ids) {
                    inPredicate.value(id);
                }
@@ -95,10 +98,10 @@ public class MonitorsController {
            } else if (orPredicate.getExpressions().isEmpty()) {
                return query.where(andPredicate).getRestriction();
            } else {
-                return query.where(andPredicate,orPredicate).getRestriction();
+                return query.where(andPredicate, orPredicate).getRestriction();
            }
        };
-        // 分页是必须的
+        // Pagination is a must         分页是必须的
        Sort sortExp = Sort.by(new Sort.Order(Sort.Direction.fromString(order), sort));
        PageRequest pageRequest = PageRequest.of(pageIndex, pageSize, sortExp);
        Page<Monitor> monitorPage = monitorService.getMonitors(specification, pageRequest);
@@ -107,18 +110,20 @@ public class MonitorsController {
    }

    @GetMapping(path = "/{app}")
-    @ApiOperation(value = "查询指定监控类型的监控列表", notes = "根据查询过滤指定监控类型的所有获取监控信息列表")
+    @ApiOperation(value = "Filter all acquired monitoring information lists of the specified monitoring type according to the query",
+            notes = "根据查询过滤指定监控类型的所有获取监控信息列表")
    public ResponseEntity<Message<List<Monitor>>> getAppMonitors(
-            @ApiParam(value = "监控类型", example = "linux") @PathVariable(required = false) final String app) {
+            @ApiParam(value = "en: Monitoring type,zh: 监控类型", example = "linux") @PathVariable(required = false) final String app) {
        List<Monitor> monitors = monitorService.getAppMonitors(app);
        Message<List<Monitor>> message = new Message<>(monitors);
        return ResponseEntity.ok(message);
    }

    @DeleteMapping
-    @ApiOperation(value = "批量删除监控", notes = "根据监控ID列表批量删除监控项")
+    @ApiOperation(value = "Delete monitoring items in batches according to the monitoring ID list",
+            notes = "根据监控ID列表批量删除监控项")
    public ResponseEntity<Message<Void>> deleteMonitors(
-            @ApiParam(value = "监控IDs", example = "6565463543") @RequestParam(required = false) List<Long> ids
+            @ApiParam(value = "en: Monitoring ID List,zh: 监控ID列表", example = "6565463543") @RequestParam(required = false) List<Long> ids
    ) {
        if (ids != null && !ids.isEmpty()) {
            monitorService.deleteMonitors(new HashSet<>(ids));
@@ -128,9 +133,10 @@ public class MonitorsController {
    }

    @DeleteMapping("manage")
-    @ApiOperation(value = "批量取消纳管监控", notes = "根据监控ID列表批量取消纳管监控项")
+    @ApiOperation(value = "Unmanaged monitoring items in batches according to the monitoring ID list",
+            notes = "根据监控ID列表批量取消纳管监控项")
    public ResponseEntity<Message<Void>> cancelManageMonitors(
-            @ApiParam(value = "监控IDs", example = "6565463543") @RequestParam(required = false) List<Long> ids
+            @ApiParam(value = "en: Monitoring ID List,zh: 监控ID列表", example = "6565463543") @RequestParam(required = false) List<Long> ids
    ) {
        if (ids != null && !ids.isEmpty()) {
            monitorService.cancelManageMonitors(new HashSet<>(ids));
@@ -140,9 +146,10 @@ public class MonitorsController {
    }

    @GetMapping("manage")
-    @ApiOperation(value = "批量启动纳管监控", notes = "根据监控ID列表批量启动纳管监控项")
+    @ApiOperation(value = "Start the managed monitoring items in batches according to the monitoring ID list",
+            notes = "根据监控ID列表批量启动纳管监控项")
    public ResponseEntity<Message<Void>> enableManageMonitors(
-            @ApiParam(value = "监控IDs", example = "6565463543") @RequestParam(required = false) List<Long> ids
+            @ApiParam(value = "en: Monitor ID List,zh: 监控ID列表", example = "6565463543") @RequestParam(required = false) List<Long> ids
    ) {
        if (ids != null && !ids.isEmpty()) {
            monitorService.enableManageMonitors(new HashSet<>(ids));
--- a/manager/src/main/java/com/usthe/manager/controller/NoticeConfigController.java
+++ b/manager/src/main/java/com/usthe/manager/controller/NoticeConfigController.java
@@ -60,8 +60,10 @@ public class NoticeConfigController {
    @ApiOperation(value = "Delete existing recipient information", notes = "删除已存在的接收人信息")
    public ResponseEntity<Message<Void>> deleteNoticeReceiver(
            @ApiParam(value = "en: Recipient ID,zh: 接收人ID", example = "6565463543") @PathVariable("id") final Long receiverId) {
-        // Returns success if it does not exist or if the deletion is successful
-        // todo 不存在或删除成功都返回成功
+        NoticeReceiver noticeReceiver = noticeConfigService.getReceiverById(receiverId);
+        if (noticeReceiver == null) {
+            return ResponseEntity.ok(new Message<>("The relevant information of the recipient could not be found, please check whether the parameters are correct"));
+        }
        noticeConfigService.deleteReceiver(receiverId);
        return ResponseEntity.ok(new Message<>("Delete success"));
    }
@@ -72,7 +74,6 @@ public class NoticeConfigController {
    public ResponseEntity<Message<List<NoticeReceiver>>> getReceivers(
            @ApiParam(value = "en: Recipient name,zh: 接收人名称，模糊查询", example = "tom") @RequestParam(required = false) final String name) {

-        //todo Writing can be optimized 写法可优化
        Specification<NoticeReceiver> specification = (root, query, criteriaBuilder) -> {
            Predicate predicate = criteriaBuilder.conjunction();
            if (name != null && !"".equals(name)) {
@@ -107,6 +108,10 @@ public class NoticeConfigController {
            @ApiParam(value = "en: Notification Policy ID,zh: 通知策略ID", example = "6565463543") @PathVariable("id") final Long ruleId) {
        // Returns success if it does not exist or if the deletion is successful
        // todo 不存在或删除成功都返回成功
+        NoticeRule noticeRule = noticeConfigService.getNoticeRulesById(ruleId);
+        if (noticeRule == null) {
+            return ResponseEntity.ok(new Message<>("The specified notification rule could not be queried, please check whether the parameters are correct"));
+        }
        noticeConfigService.deleteNoticeRule(ruleId);
        return ResponseEntity.ok(new Message<>("Delete success"));
    }
--- a/manager/src/main/java/com/usthe/manager/dao/MonitorDao.java
+++ b/manager/src/main/java/com/usthe/manager/dao/MonitorDao.java
@@ -22,33 +22,37 @@ public interface MonitorDao extends JpaRepository<Monitor, Long>, JpaSpecificati


    /**
+     * Delete monitor based on monitor ID list
     * 根据监控ID列表删除监控
     *
-     * @param monitorIds 监控ID列表
+     * @param monitorIds Monitoring ID List 监控ID列表
     */
    void deleteAllByIdIn(Set<Long> monitorIds);

    /**
+     * Query monitoring based on monitoring ID list
     * 根据监控ID列表查询监控
     *
-     * @param monitorIds 监控ID列表
-     * @return 监控列表
+     * @param monitorIds Monitoring ID List 监控ID列表
+     * @return Monitor List     监控列表
     */
    List<Monitor> findMonitorsByIdIn(Set<Long> monitorIds);

    /**
+     * Query monitoring by monitoring type
     * 根据监控类型查询监控
     *
-     * @param app 监控类型
-     * @return 监控列表
+     * @param app Monitor Type   监控类型
+     * @return Monitor List     监控列表
     */
    List<Monitor> findMonitorsByAppEquals(String app);

    /**
+     * Querying Monitoring of Sent Collection Tasks
     * 查询已下发采集任务的监控
     *
-     * @param status 监控状态
-     * @return 监控列表
+     * @param status Monitor Status     监控状态
+     * @return Monitor List     监控列表
     */
    List<Monitor> findMonitorsByStatusNotInAndAndJobIdNotNull(List<Byte> status);

--- a/manager/src/main/java/com/usthe/manager/dao/ParamDao.java
+++ b/manager/src/main/java/com/usthe/manager/dao/ParamDao.java
@@ -8,27 +8,34 @@ import java.util.Set;

 /**
 * ParamDao 数据库操作
+ *
 * @author tomsun28
 * @date 2021/11/14 11:26
 */
 public interface ParamDao extends JpaRepository<Param, Long> {

    /**
+     * Query the list of parameters associated with the monitoring ID'
     * 根据监控ID查询与之关联的参数列表
-     * @param monitorId 监控ID
-     * @return 参数值列表
+     *
+     * @param monitorId Monitor ID          监控ID
+     * @return list of parameter values     参数值列表
     */
    List<Param> findParamsByMonitorId(long monitorId);

    /**
+     * Remove the parameter list associated with the monitoring ID based on it
     * 根据监控ID删除与之关联的参数列表
-     * @param monitorId 监控ID
+     *
+     * @param monitorId Monitor Id       监控ID
     */
    void deleteParamsByMonitorId(long monitorId);

    /**
+     * Remove the parameter list associated with the monitoring ID list based on it
     * 根据监控ID列表删除与之关联的参数列表
-     * @param monitorIds 监控ID列表
+     *
+     * @param monitorIds Monitoring ID List     监控ID列表
     */
    void deleteParamsByMonitorIdIn(Set<Long> monitorIds);
 }
--- a/manager/src/main/java/com/usthe/manager/pojo/dto/MonitorDto.java
+++ b/manager/src/main/java/com/usthe/manager/pojo/dto/MonitorDto.java
@@ -14,15 +14,18 @@ import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_ONLY;
 import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_WRITE;

 /**
+ * Monitoring Information External Interaction Entities
 * 监控信息对外交互实体
+ *
 * @author tomsun28
 * @date 2021/11/14 10:13
 */
@Data
-@ApiModel(description = "监控信息实体")
+@ApiModel(description = "en: Monitoring information entities,zh: 监控信息实体")
 public class MonitorDto {

    /**
+     * Monitoring entity
     * 监控实体
     */
    @ApiModelProperty(value = "监控实体", accessMode = READ_WRITE, position = 0)
@@ -31,17 +34,22 @@ public class MonitorDto {
    private Monitor monitor;

    /**
-     * 参数
+     * Params 参数
     */
    @ApiModelProperty(value = "监控参数", accessMode = READ_WRITE, position = 1)
    @NotNull
    @Valid
    private List<Param> params;

+    /**
+     * List of indicator groups
+     * 指标组列表
+     */
    @ApiModelProperty(value = "指标组列表", accessMode = READ_ONLY, position = 2)
    private List<String> metrics;

    /**
+     * Whether to detect
     * 是否探测
     */
    @ApiModelProperty(value = "是否进行探测", accessMode = READ_WRITE, position = 3)
--- a/manager/src/main/java/com/usthe/manager/service/AppService.java
+++ b/manager/src/main/java/com/usthe/manager/service/AppService.java
@@ -9,6 +9,7 @@ import java.util.Map;

 /**
 * 监控类型管理接口
+ *
 * @author tomsun28
 * @date 2021/11/14 17:12
 */
@@ -16,21 +17,26 @@ public interface AppService {

    /**
     * 根据监控类型查询定义的参数结构
+     *
     * @param app 监控类型
     * @return 参数结构列表
     */
    List<ParamDefine> getAppParamDefines(String app);

    /**
+     * Get monitor structure definition based on monitor type name
     * 根据监控类型名称获取监控结构定义
-     * @param app 监控类型名称
-     * @return 监控结构定义
-     * @throws IllegalArgumentException 当不存在即不支持对应名称的监控类型时抛出
+     *
+     * @param app Monitoring type name  监控类型名称
+     * @return Monitoring Structure Definition  监控结构定义
+     * @throws IllegalArgumentException Thrown when there is no monitoring type with the corresponding name that is not supported
+     *                                  当不存在即不支持对应名称的监控类型时抛出
     */
    Job getAppDefine(String app) throws IllegalArgumentException;

    /**
     * 获取定义的监控I18N资源
+     *
     * @param lang 语言类型
     * @return I18N资源
     */
@@ -38,6 +44,7 @@ public interface AppService {

    /**
     * 查询所有监控的类型-指标组-指标层级
+     *
     * @param lang 语言
     * @return 层级信息
     */
--- a/manager/src/main/java/com/usthe/manager/service/MonitorService.java
+++ b/manager/src/main/java/com/usthe/manager/service/MonitorService.java
@@ -23,93 +23,103 @@ public interface MonitorService {


    /**
+     * Monitoring Availability Probes
     * 监控可用性探测
     *
-     * @param monitor 监控实体信息
-     * @param params  参数信息
-     * @throws MonitorDetectException 探测失败抛出
+     * @param monitor Monitoring entity information    监控实体信息
+     * @param params  Parameter information            参数信息
+     * @throws MonitorDetectException Probe failure throws  探测失败抛出
     */
    void detectMonitor(Monitor monitor, List<Param> params) throws MonitorDetectException;

    /**
-     * 新增监控
+     * Add monitoring       新增监控
     *
-     * @param monitor 监控实体
-     * @param params  参数信息
-     * @throws RuntimeException 新增过程异常抛出
+     * @param monitor Monitoring Entity     监控实体
+     * @param params  Parameter information 参数信息
+     * @throws RuntimeException Add process exception throw     新增过程异常抛出
     */
    void addMonitor(Monitor monitor, List<Param> params) throws RuntimeException;

    /**
+     * Verify the correctness of request data parameters
     * 校验请求数据参数正确性
     *
     * @param monitorDto monitorDto
-     * @param isModify   是否是修改监控
-     * @throws IllegalArgumentException 校验参数错误抛出
+     * @param isModify   Whether it is a modification monitoring    是否是修改监控
+     * @throws IllegalArgumentException Validation parameter error thrown   校验参数错误抛出
     */
    void validate(MonitorDto monitorDto, Boolean isModify) throws IllegalArgumentException;

    /**
+     * Modify update monitoring
     * 修改更新监控
     *
-     * @param monitor 监控实体
-     * @param params  参数信息
-     * @throws RuntimeException 修改过程中异常抛出
+     * @param monitor Monitor Entity        监控实体
+     * @param params  Parameter information 参数信息
+     * @throws RuntimeException Exception thrown during modification    修改过程中异常抛出
     */
    void modifyMonitor(Monitor monitor, List<Param> params) throws RuntimeException;

    /**
+     * Delete Monitor
     * 删除监控
     *
-     * @param id 监控ID
-     * @throws RuntimeException 删除过程中异常抛出
+     * @param id Monitor ID         监控ID
+     * @throws RuntimeException Exception thrown during deletion    删除过程中异常抛出
     */
    void deleteMonitor(long id) throws RuntimeException;

    /**
+     * Batch delete monitoring
     * 批量删除监控
     *
-     * @param ids 监控ID
-     * @throws RuntimeException 删除过程中异常抛出
+     * @param ids Monitoring ID List    监控ID列表
+     * @throws RuntimeException Exception thrown during deletion    删除过程中异常抛出
     */
    void deleteMonitors(Set<Long> ids) throws RuntimeException;

    /**
+     * Get monitoring information
     * 获取监控信息
     *
-     * @param id 监控ID
-     * @return MonitorDto
-     * @throws RuntimeException 查询过程中异常抛出
+     * @param id Monitor ID      监控ID
+     * @return MonitorDto   Monitor Entity  監控实体
+     * @throws RuntimeException Exception thrown during query   查询过程中异常抛出
     */
    MonitorDto getMonitorDto(long id) throws RuntimeException;

    /**
+     * Dynamic conditional query
     * 动态条件查询
     *
-     * @param specification 查询条件
-     * @param pageRequest   分页参数
-     * @return 查询结果
+     * @param specification Query conditions        查询条件
+     * @param pageRequest   Pagination parameters   分页参数
+     * @return Search Result          查询结果
     */
    Page<Monitor> getMonitors(Specification<Monitor> specification, PageRequest pageRequest);

    /**
+     * Unmanaged monitoring items in batches according to the monitoring ID list
     * 根据监控ID列表批量取消纳管监控项
     *
-     * @param ids 监控IDs
+     * @param ids Monitoring ID List    监控ID列表
     */
    void cancelManageMonitors(HashSet<Long> ids);

    /**
+     * Start the managed monitoring items in batches according to the monitoring ID list
     * 根据监控ID列表批量启动纳管监控项
     *
-     * @param ids 监控IDs
+     * @param ids Monitoring ID List    监控ID列表
     */
    void enableManageMonitors(HashSet<Long> ids);

    /**
+     * Query the monitoring category and its corresponding monitoring quantity
     * 查询监控类别及其对应的监控数量
     *
-     * @return 监控类别与监控数量映射
+     * @return Monitoring Category and Monitoring Quantity Mapping  监控类别与监控数量映射
     */
    List<AppCount> getAllAppMonitorsCount();

@@ -132,10 +142,11 @@ public interface MonitorService {
    void updateMonitorStatus(Long monitorId, byte status);

    /**
+     * Query the list of all monitoring information under the specified monitoring type
     * 查询指定监控类型下的所有监控信息列表
     *
-     * @param app 监控类型
-     * @return 监控列表
+     * @param app Monitor Type      监控类型
+     * @return Monitor Entity List  监控列表
     */
    List<Monitor> getAppMonitors(String app);
 }
--- a/manager/src/main/java/com/usthe/manager/service/NoticeConfigService.java
+++ b/manager/src/main/java/com/usthe/manager/service/NoticeConfigService.java
@@ -90,4 +90,22 @@ public interface NoticeConfigService {
     * @return Receiver     接收人
     */
    List<NoticeReceiver> getReceiverFilterRule(Alert alert);
+
+    /**
+     * Query recipient information based on recipient ID (primary key Id)
+     * 根据接收人ID(主键Id)查询接收人信息
+     *
+     * @param receiverId Receiver ID (primary key ID)  接收人ID(主键ID)
+     * @return Recipient Entity        接收人实体
+     */
+    NoticeReceiver getReceiverById(Long receiverId);
+
+    /**
+     * Query specific notification rules according to the rule ID (primary key ID)
+     * 根据规则ID(主键ID)查询具体通知规则
+     *
+     * @param ruleId Rule ID     规则ID(主键ID)
+     * @return Notification Rule Entity    通知规则实体
+     */
+    NoticeRule getNoticeRulesById(Long ruleId);
 }
--- a/manager/src/main/java/com/usthe/manager/service/impl/MonitorServiceImpl.java
+++ b/manager/src/main/java/com/usthe/manager/service/impl/MonitorServiceImpl.java
@@ -81,11 +81,13 @@ public class MonitorServiceImpl implements MonitorService {
        List<Configmap> configmaps = params.stream().map(param ->
                new Configmap(param.getField(), param.getValue(), param.getType())).collect(Collectors.toList());
        appDefine.setConfigmap(configmaps);
+        // To detect availability, you only need to collect the set of availability indicators with a priority of 0.
        // 探测可用性只需要采集优先级为0的可用性指标集合
        List<Metrics> availableMetrics = appDefine.getMetrics().stream()
                .filter(item -> item.getPriority() == 0).collect(Collectors.toList());
        appDefine.setMetrics(availableMetrics);
        List<CollectRep.MetricsData> collectRep = collectJobService.collectSyncJobData(appDefine);
+        // If the detection result fails, a detection exception is thrown
        // 判断探测结果 失败则抛出探测异常
        if (collectRep == null || collectRep.isEmpty()) {
            throw new MonitorDetectException("No collector response");
@@ -98,9 +100,9 @@ public class MonitorServiceImpl implements MonitorService {
    @Override
    @Transactional(rollbackFor = Exception.class)
    public void addMonitor(Monitor monitor, List<Param> params) throws RuntimeException {
-        // 申请 monitor id
+        // Apply for monitor id         申请 monitor id
        long monitorId = SnowFlakeIdGenerator.generateId();
-        // 构造采集任务Job实体
+        // Construct the collection task Job entity     构造采集任务Job实体
        Job appDefine = appService.getAppDefine(monitor.getApp());
        appDefine.setMonitorId(monitorId);
        appDefine.setInterval(monitor.getIntervals());
@@ -111,8 +113,10 @@ public class MonitorServiceImpl implements MonitorService {
            return new Configmap(param.getField(), param.getValue(), param.getType());
        }).collect(Collectors.toList());
        appDefine.setConfigmap(configmaps);
+        // Send the collection task to get the job ID
        // 下发采集任务得到jobId
        long jobId = collectJobService.addAsyncCollectJob(appDefine);
+        // Brush the library after the download is successful
        // 下发成功后刷库
        try {
            monitor.setId(monitorId);
@@ -122,6 +126,7 @@ public class MonitorServiceImpl implements MonitorService {
            paramDao.saveAll(params);
        } catch (Exception e) {
            log.error(e.getMessage(), e);
+            // Repository brushing abnormally cancels the previously delivered task
            // 刷库异常取消之前的下发任务
            collectJobService.cancelAsyncCollectJob(jobId);
            throw new MonitorDatabaseException(e.getMessage());
@@ -131,6 +136,7 @@ public class MonitorServiceImpl implements MonitorService {
    @Override
    @Transactional(readOnly = true)
    public void validate(MonitorDto monitorDto, Boolean isModify) throws IllegalArgumentException {
+        // The request monitoring parameter matches the monitoring parameter definition mapping check
        // 请求监控参数与监控参数定义映射校验匹配
        Monitor monitor = monitorDto.getMonitor();
        monitor.setHost(monitor.getHost().trim());
@@ -143,7 +149,7 @@ public class MonitorServiceImpl implements MonitorService {
                    param.setValue(value);
                })
                .collect(Collectors.toMap(Param::getField, param -> param));
-        // 校验名称唯一性
+        // Check name uniqueness    校验名称唯一性
        if (isModify != null) {
            Optional<Monitor> monitorOptional = monitorDao.findMonitorByNameEquals(monitor.getName());
            if (monitorOptional.isPresent()) {
@@ -158,7 +164,7 @@ public class MonitorServiceImpl implements MonitorService {
            }
        }

-        // 参数定义结构校验
+        // Parameter definition structure verification  参数定义结构校验
        List<ParamDefine> paramDefines = appService.getAppParamDefines(monitorDto.getMonitor().getApp());
        if (paramDefines != null) {
            for (ParamDefine paramDefine : paramDefines) {
@@ -204,6 +210,7 @@ public class MonitorServiceImpl implements MonitorService {
                            }
                            break;
                        case "password":
+                            // The plaintext password needs to be encrypted for transmission and storage
                            // 明文密码需加密传输存储
                            String passwordValue = param.getValue();
                            if (!AesUtil.isCiphertext(passwordValue)) {
@@ -213,7 +220,7 @@ public class MonitorServiceImpl implements MonitorService {
                            param.setType(CommonConstants.PARAM_TYPE_PASSWORD);
                            break;
                        case "boolean":
-                            // boolean校验
+                            // boolean check
                            String booleanValue = param.getValue();
                            try {
                                Boolean.parseBoolean(booleanValue);
@@ -223,7 +230,7 @@ public class MonitorServiceImpl implements MonitorService {
                            }
                            break;
                        case "radio":
-                            // radio单选值校验
+                            // radio single value check  radio单选值校验
                            List<ParamDefine.Option> options = paramDefine.getOptions();
                            boolean invalid = true;
                            if (options != null) {
@@ -245,7 +252,8 @@ public class MonitorServiceImpl implements MonitorService {
                        case "key-value":
                            // todo key-value校验
                            break;
-                        // todo 更多参数定义与实际值格式校验
+                        // todo More parameter definitions and actual value format verification
+                        //  更多参数定义与实际值格式校验
                        default:
                            throw new IllegalArgumentException("ParamDefine type " + paramDefine.getType() + " is invalid.");
                    }
@@ -255,8 +263,10 @@ public class MonitorServiceImpl implements MonitorService {
    }

    @Override
+    @Transactional(rollbackFor = Exception.class)
    public void modifyMonitor(Monitor monitor, List<Param> params) throws RuntimeException {
        long monitorId = monitor.getId();
+        // Check to determine whether the monitor corresponding to the monitor Id exists
        // 查判断monitorId对应的此监控是否存在
        Optional<Monitor> queryOption = monitorDao.findById(monitorId);
        if (!queryOption.isPresent()) {
@@ -264,9 +274,11 @@ public class MonitorServiceImpl implements MonitorService {
        }
        Monitor preMonitor = queryOption.get();
        if (!preMonitor.getApp().equals(monitor.getApp())) {
+            // The type of monitoring cannot be modified
            // 监控的类型不能修改
            throw new IllegalArgumentException("Can not modify monitor's app type");
        }
+        // Construct the collection task Job entity
        // 构造采集任务Job实体
        Job appDefine = appService.getAppDefine(monitor.getApp());
        appDefine.setId(preMonitor.getJobId());
@@ -277,14 +289,16 @@ public class MonitorServiceImpl implements MonitorService {
        List<Configmap> configmaps = params.stream().map(param ->
                new Configmap(param.getField(), param.getValue(), param.getType())).collect(Collectors.toList());
        appDefine.setConfigmap(configmaps);
-        // 更新采集任务
-        collectJobService.updateAsyncCollectJob(appDefine);
+        // After the update is successfully released, refresh the library
        // 下发更新成功后刷库
        try {
            monitor.setJobId(preMonitor.getJobId());
            monitor.setStatus(preMonitor.getStatus());
            monitorDao.save(monitor);
            paramDao.saveAll(params);
+            // Update the collection task after the storage is completed
+            // 入库完成后更新采集任务
+            collectJobService.updateAsyncCollectJob(appDefine);
        } catch (Exception e) {
            log.error(e.getMessage(), e);
            throw new MonitorDatabaseException(e.getMessage());
@@ -345,7 +359,9 @@ public class MonitorServiceImpl implements MonitorService {

    @Override
    public void cancelManageMonitors(HashSet<Long> ids) {
+        // Update monitoring status Delete corresponding monitoring periodic task
        // 更新监控状态  删除对应的监控周期性任务
+        // The jobId is not deleted, and the jobId is reused again after the management is started.
        // jobId不删除 待启动纳管之后再次复用jobId
        List<Monitor> managedMonitors = monitorDao.findMonitorsByIdIn(ids)
                .stream().filter(monitor ->
@@ -362,6 +378,7 @@ public class MonitorServiceImpl implements MonitorService {

    @Override
    public void enableManageMonitors(HashSet<Long> ids) {
+        // Update monitoring status Add corresponding monitoring periodic task
        // 更新监控状态 新增对应的监控周期性任务
        List<Monitor> unManagedMonitors = monitorDao.findMonitorsByIdIn(ids)
                .stream().filter(monitor ->
@@ -371,6 +388,7 @@ public class MonitorServiceImpl implements MonitorService {
        if (!unManagedMonitors.isEmpty()) {
            monitorDao.saveAll(unManagedMonitors);
            for (Monitor monitor : unManagedMonitors) {
+                // Construct the collection task Job entity
                // 构造采集任务Job实体
                Job appDefine = appService.getAppDefine(monitor.getApp());
                appDefine.setMonitorId(monitor.getId());
@@ -381,7 +399,7 @@ public class MonitorServiceImpl implements MonitorService {
                List<Configmap> configmaps = params.stream().map(param ->
                        new Configmap(param.getField(), param.getValue(), param.getType())).collect(Collectors.toList());
                appDefine.setConfigmap(configmaps);
-                // 下发采集任务
+                // Issue collection tasks       下发采集任务
                collectJobService.addAsyncCollectJob(appDefine);
            }
        }
--- a/manager/src/main/java/com/usthe/manager/service/impl/NoticeConfigServiceImpl.java
+++ b/manager/src/main/java/com/usthe/manager/service/impl/NoticeConfigServiceImpl.java
@@ -18,6 +18,7 @@ import java.util.stream.Collectors;

 /**
 * 消息通知配置实现
+ *
 * @author tom
 * @date 2021/12/16 16:16
 */
@@ -74,13 +75,24 @@ public class NoticeConfigServiceImpl implements NoticeConfigService {

    @Override
    public List<NoticeReceiver> getReceiverFilterRule(Alert alert) {
-        // todo 使用缓存
+        // todo use cache   使用缓存
        List<NoticeRule> rules = noticeRuleDao.findNoticeRulesByEnableTrue();
-        // todo 暂时规则是全部转发 后面实现更多匹配规则：告警状态选择 监控类型选择等
+        // todo The temporary rule is to forward all, and then implement more matching rules: alarm status selection, monitoring type selection, etc.
+        // 暂时规则是全部转发 后面实现更多匹配规则：告警状态选择 监控类型选择等
        Set<Long> receiverIds = rules.stream()
                .filter(NoticeRule::isFilterAll)
                .map(NoticeRule::getReceiverId)
                .collect(Collectors.toSet());
        return noticeReceiverDao.findAllById(receiverIds);
    }
+
+    @Override
+    public NoticeReceiver getReceiverById(Long receiverId) {
+        return noticeReceiverDao.getOne(receiverId);
+    }
+
+    @Override
+    public NoticeRule getNoticeRulesById(Long ruleId) {
+        return noticeRuleDao.getOne(ruleId);
+    }
 }
Author	SHA1	Message	Date
huacheng	8951454143	feat: [manager,alert,collector,common]feature:Modify monitoring and add transaction support. Monitoring compatible with Chinese and English #wqh	2022-04-13 22:46:36 +08:00
huacheng	2b82f88461	feat: [manager]feature:Delete notification operation compatibility query is empty #huacheng	2022-04-12 00:17:40 +08:00
huacheng	549362c843	feat: MonitorsController Chinese and English support #huacheng	2022-04-11 20:52:31 +08:00