Merge branch 'master' into case-insensitive-search

CONTRIBUTING.md

@@ -205,7 +205,7 @@ Add WeChat account `tan-cloud` to pull you into the WeChat group.
 
 6. 待本地后端启动后，在web-app目录下启动本地前端 `ng serve --open`
 
-7. 浏览器访问 localhost:4200 即可开始，默认账号密码 admin/hertzbeat**
+7. 浏览器访问 localhost:4200 即可开始，默认账号密码 *admin/hertzbeat*
 
 ### 寻找任务  
 

hip/README.md

@@ -90,4 +90,4 @@ It is advised to create a master GitHub issue to formulate the execution plan an
     - Merged PR means the HIP was accepted.
     - Closed PR means the HIP was rejected.
     - Open PR means the HIP was submitted and is in the process of discussion.
-2. You can also take a look at the file in the `hip` folder. Each one is an approved HIP.
+2. You can also take a look at the file in the `hip` folder. Each one is an approved HIP.

hip/TEMPLATE.md

@@ -140,4 +140,4 @@ If there are alternatives that were already considered by the authors or, after
 Updated afterwards
 -->
 * Mailing List discussion thread:
-* Mailing List voting thread:
+* Mailing List voting thread:

hip/hip-01.md

@@ -51,4 +51,4 @@ Supplement the relevant unit tests.
 Updated afterwards
 -->
 * Mailing List discussion thread: https://lists.apache.org/thread/cvvo7xg35fxq7kml5ggdrcdygrx6yvyj
-* Mailing List voting thread: https://lists.apache.org/thread/1s7dhrb27qfdx1gsh29dvmo8frjbt619
+* Mailing List voting thread: https://lists.apache.org/thread/1s7dhrb27qfdx1gsh29dvmo8frjbt619

plugin/src/main/java/org/apache/hertzbeat/plugin/Plugin.java

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 
-
 package org.apache.hertzbeat.plugin;
 
 import org.apache.hertzbeat.common.entity.alerter.Alert;
@@ -25,8 +24,8 @@
  */
 public interface Plugin {
 
-    /*
-     *  execute when alert
+    /**
+     * execute when alert
      */
     void alert(Alert alert);
 }

plugin/src/main/java/org/apache/hertzbeat/plugin/impl/DemoPluginImpl.java

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 
-
 package org.apache.hertzbeat.plugin.impl;
 
 import lombok.extern.slf4j.Slf4j;
@@ -27,11 +26,13 @@
  */
 @Slf4j
 public class DemoPluginImpl implements Plugin {
-    /*
-     *  execute when alert
+
+    /**
+     * execute when alert
      */
     @Override
     public void alert(Alert alert) {
         log.info("DemoPluginImpl alert: {}", alert);
     }
+
 }

plugin/src/main/resources/META-INF/services/org.apache.hertzbeat.plugin.Plugin

@@ -1 +1 @@
-org.apache.hertzbeat.plugin.impl.DemoPluginImpl
+org.apache.hertzbeat.plugin.impl.DemoPluginImpl

push/src/main/resources/META-INF/spring.factories

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
-org.apache.hertzbeat.push.config.PushAutoConfiguration
+org.apache.hertzbeat.push.config.PushAutoConfiguration

remoting/src/main/java/org/apache/hertzbeat/remoting/RemotingServer.java

@@ -51,5 +51,9 @@ public interface RemotingServer extends RemotingService {
      */
     ClusterMsg.Message sendMsgSync(Channel channel, ClusterMsg.Message request, int timeoutMillis);
 
+    /**
+     * register hook.
+     * @param nettyHookList hook list
+     */
     void registerHook(List<NettyHook> nettyHookList);
 }

script/docker/server/README.md

@@ -25,5 +25,4 @@ $ docker buildx build --platform linux/arm64,linux/amd64 -t quay.io/tancloud/her
 
 # Inspect the image info
 $ docker buildx imagetools inspect apache/hertzbeat:v1.0.0
-
 ```

warehouse/src/main/java/org/apache/hertzbeat/warehouse/dao/HistoryDao.java

@@ -17,7 +17,6 @@
 
 package org.apache.hertzbeat.warehouse.dao;
 
-
 import org.apache.hertzbeat.common.entity.warehouse.History;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.JpaSpecificationExecutor;

warehouse/src/main/java/org/apache/hertzbeat/warehouse/listener/WareHouseApplicationReadyListener.java

@@ -24,10 +24,8 @@
 import org.springframework.context.event.EventListener;
 import org.springframework.stereotype.Component;
 
-
-
 /**
- *
+ * WareHouseApplicationReadyListener
  */
 @Slf4j
 @Component

warehouse/src/main/java/org/apache/hertzbeat/warehouse/store/history/HistoryDataReader.java

@@ -22,7 +22,7 @@
 import org.apache.hertzbeat.common.entity.dto.Value;
 
 /**
- *
+ * history data reader
  */
 public interface HistoryDataReader {
 

warehouse/src/main/java/org/apache/hertzbeat/warehouse/store/history/HistoryDataWriter.java

@@ -20,7 +20,7 @@
 import org.apache.hertzbeat.common.entity.message.CollectRep;
 
 /**
- *
+ * history data writer
  */
 public interface HistoryDataWriter {
 

warehouse/src/main/java/org/apache/hertzbeat/warehouse/store/history/vm/VictoriaMetricsClusterDataStorage.java

@@ -17,7 +17,6 @@
 
 package org.apache.hertzbeat.warehouse.store.history.vm;
 
-
 import com.fasterxml.jackson.databind.JsonNode;
 import java.math.BigDecimal;
 import java.math.RoundingMode;
@@ -59,7 +58,6 @@
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.util.UriComponentsBuilder;
 
-
 /**
  * tdengine data storage
  */

warehouse/src/main/resources/META-INF/spring.factories

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
-org.apache.hertzbeat.warehouse.WarehouseAutoConfiguration
+org.apache.hertzbeat.warehouse.WarehouseAutoConfiguration

warehouse/src/test/java/org/apache/hertzbeat/warehouse/store/MemoryDataStorageTest.java

@@ -37,4 +37,4 @@ void getCurrentMetricsData() {
     @Test
     void destroy() {
     }
-}
+}

warehouse/src/test/java/org/apache/hertzbeat/warehouse/store/MetricsDataRedisCodecTest.java

@@ -45,4 +45,4 @@ void encodeKey() {
     @Test
     void encodeValue() {
     }
-}
+}

warehouse/src/test/java/org/apache/hertzbeat/warehouse/store/RedisDataStorageTest.java

@@ -37,4 +37,4 @@ void getCurrentMetricsData() {
     @Test
     void destroy() {
     }
-}
+}

warehouse/src/test/java/org/apache/hertzbeat/warehouse/store/TdEngineDataStorageTest.java

@@ -49,4 +49,4 @@ void getHistoryMetricData() {
     @Test
     void getHistoryIntervalMetricData() {
     }
-}
+}

web-app/.eslintrc.js

@@ -20,7 +20,13 @@ module.exports = {
       ],
       rules: {
         'prettier/prettier': ['error', prettierConfig],
-        'jsdoc/newline-after-description': 1,
+        'jsdoc/tag-lines': [
+          'error',
+          'any',
+          {
+            startLines: 1,
+          },
+        ],
         '@angular-eslint/component-class-suffix': [
           'error',
           {

web-app/package.json

@@ -92,7 +92,7 @@
     "eslint-config-prettier": "8.6.0",
     "eslint-plugin-deprecation": "1.3.3",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jsdoc": "39.7.5",
+    "eslint-plugin-jsdoc": "48.2.5",
     "eslint-plugin-prefer-arrow": "1.2.3",
     "eslint-plugin-prettier": "4.2.1",
     "husky": "7.0.4",