[ospp] support ui help massage component (#1199)

Signed-off-by: Yuting Nie <[email protected]>

common/src/main/java/org/dromara/hertzbeat/common/entity/job/Job.java

@@ -84,6 +84,9 @@ public class Job {
      * en-US: PING CONNECT - You can use the IP address or domain address of the peer service to monitor the PING connectivity between the local network and the peer network.
      */
     private Map<String, String> help;
+
+    private Map<String, String> helpLink;
+
     /**
      * Task dispatch start timestamp
      * 任务派发开始时间戳

manager/src/main/java/org/dromara/hertzbeat/manager/service/impl/AppServiceImpl.java

@@ -134,6 +134,15 @@ public Map<String, String> getI18nResources(String lang) {
                     i18nMap.put("monitor.app." + job.getApp() + ".help", i18nHelp);
                 }
             }
+
+            Map<String, String> helpLink = job.getHelpLink();
+            if (helpLink != null && !helpLink.isEmpty()) {
+                String i18nHelp = Optional.ofNullable(helpLink.get(lang)).orElse(helpLink.values().stream().findFirst().orElse(null));
+                if (i18nHelp != null) {
+                    i18nMap.put("monitor.app." + job.getApp() + ".helpLink", i18nHelp);
+                }
+            }
+
             for (ParamDefine paramDefine : job.getParams()) {
                 Map<String, String> paramDefineName = paramDefine.getName();
                 if (paramDefineName != null && !paramDefineName.isEmpty()) {

manager/src/main/resources/define/app-a_example.yml

@@ -27,9 +27,12 @@ name:
 # The description and help of this monitoring type
 # 监控类型的帮助描述信息
 help:
-  zh-CN: PING连通性 - Hertzbeat 支持您使用在线配置对端服务的IP或域名地址，监控本机网络与对端网络的PING可连通性。
-  en-US: PING CONNECT - You can use the IP address or domain address of the peer service to monitor the PING connectivity between the local network and the peer network.
-# 监控所需输入参数定义(根据定义渲染页面UI)
+  zh-CN: HertzBeat 支持自定义监控，您只需配置监控模版 YML 就能适配一款自定义的监控类型。<br>定义流程如下：HertzBeat 页面 -> 监控模版菜单 -> 新增监控类型 -> 配置自定义监控模版YML -> 点击保存应用 -> 使用新监控类型添加监控。
+  en-US: "HertzBeat supports c  ustom monitoring, and you only need to configure the monitoring template YML to adapt to a custom monitoring type. <br>Definition process as follow: HertzBeat Pages -> Main Menu -> Monitor Template -> edit and save -> apply this template."
+  zh-TW: HertzBeat支持自定義監控，您只需配寘監控模版YML就能適配一款自定義的監控類型。<br>定義流程如下：HertzBeat頁面->監控模版選單->新增監控類型->配寘自定義監控模版YML ->點擊保存應用->使用新監控類型添加監控。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/advanced/extend-point/
+  en-US: https://hertzbeat.com/docs/advanced/extend-point/
 # Input params define for monitoring(render web ui by the definition)
 params:
   # field-param field key

manager/src/main/resources/define/app-activemq.yml

@@ -24,6 +24,15 @@ app: activemq
 name:
   zh-CN: ActiveMQ消息系统
   en-US: ActiveMQ Message
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: HertzBeat 使用<a class='help_module_content' href='https://baijiahao.baidu.com/s?id=1605937053950156833&wfr=spider&for=pc'> JMX 协议</a>对 Apache ActiveMQ 消息中间件的运行状态，节点，Topic等相关指标（broker、topic、memory pool、class loading、thread）进行监测。<br><span class='help_module_span'>⚠️注意：您需要在 ActiveMQ 开启 JMX 服务。<a class='help_module_content' href='https://hertzbeat.com/zh-cn/docs/help/activemq#%E7%9B%91%E6%8E%A7%E5%89%8D%E6%93%8D%E4%BD%9C'>点击查看开启步骤</a>。</span>
+  en-US: "HertzBeat uses <a class='help_module_content' href='https://netbeans.apache.org/kb/docs/java/jmx-manager-tutorial.html'> JMX protocol</a> to monitor the running status, nodes, topics, and other indicators of Apache ActiveMQ message-oriented middleware. <br><span class='help_module_span'>⚠️Note: You should enable the JMX service in ActiveMQ. <a class='help_module_content' href='https://hertzbeat.com/docs/help/activemq#%E7%9B%91%E6%8E%A7%E5%89%8D%E6%93%8D%E4%BD%9C'>Click here to view the specific steps.</a></span>"
+  zh-TW: HertzBeat使用<a class='help_module_content' href='https://baijiahao.baidu.com/s?id=1605937053950156833&wfr=spider&for=pc'> JMX 協定</a>對 Apache ActiveMQ 消息中介軟體的運行狀態，節點，Topic 等相關名額（broker、topic、memory pool、class loading、thread）進行監測。<br><span class='help_module_span'> ⚠️注意：您需要在 ActiveMQ 開啟 JMX 服務。<a class='help_module_content' href=' https://hertzbeat.com/zh-cn/docs/help/activemq#%E7%9B%91%E6%8E%A7%E5%89%8D%E6%93%8D%E4%BD%9C'>點擊查看開啟步驟</a>。</span>
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/activemq
+  en-US: https://hertzbeat.com/docs/help/activemq
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-airflow.yml

@@ -24,6 +24,15 @@ app: airflow
 name:
   zh-CN: Apache Airflow
   en-US: Apache Airflow
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 对 Apache Airflow 通用性能指标（airflow health、airflow version）进行采集监控。<br>您可以点击“<i>新建 Apache Airflow </i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: HertzBeat monitors Apache Airflow through general performance indicators such as airflow health and airflow version. You could click the "<i>New Apache Airflow</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: Hertzbeat對Apache Airflow通用性能指標（airflow health、airflow version）進行採集監控。<br>您可以點擊“<i>新建 Apache Airflow</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/airflow/
+  en-US: https://hertzbeat.com/docs/help/airflow/
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-almalinux.yml

@@ -24,6 +24,15 @@ app: almalinux
 name:
   zh-CN: AlmaLinux
   en-US: AlmaLinux
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 对 AlmaLinux 通用性能指标进行采集监控。<br>您可以点击“<i>新建 AlmaLinux </i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: HertzBeat monitors AlmaLinux through general performance indicators such as airflow health and airflow version. You could click the "<i>New AlmaLinux</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: Hertzbeat對AlmaLinux通用性能指標進行採集監控。<br>您可以點擊“<i>新建AlmaLinux</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/almalinux
+  en-US: https://hertzbeat.com/docs/help/almalinux
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-api.yml

@@ -22,6 +22,15 @@ app: api
 name:
   zh-CN: HTTP API
   en-US: HTTP API
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 将调用 HTTP API 接口，查看接口是否可用，并以 ms 为指标单位对其响应时间等指标进行监测。您可以先点击“新增 HTTP API”按钮并进行配置，或在“更多操作”中导入已有配置。
+  en-US: The platform will invoke an HTTP API endpoint to verify its accessibility and monitor various metrics, including response time, measured in milliseconds (ms). <br>To set up this functionality, you could click the "Add HTTP API" button and proceed with the configuration or import an existing setup through the "More Actions" menu.
+  zh-TW: Hertzbeat將調用HTTP API介面，查看介面是否可用，並以ms為名額組織對其回應時間等名額進行監測。 您可以先點擊“新增HTTP API”按鈕並進行配寘，或在“更多操作”中導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/api
+  en-US: https://hertzbeat.com/docs/help/api
 # app api所需输入参数定义(根据定义渲染页面UI)
 # Input params define for app api(render web ui by the definition)
 params:

manager/src/main/resources/define/app-api_code.yml

@@ -23,6 +23,15 @@ app: api_code
 name:
   zh-CN: API Code
   en-US: API Code
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 对 api 返回的状态码进行监控。<br>您可以点击 “<i>新建 API Code</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: Hertzbeat monitors the status codes which returned by the API. You could click the "<i>New API Codes</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: Hertzbeat對api返回的狀態碼進行監控。<br>您可以點擊“<i>新建API Code</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/api_code
+  en-US: https://hertzbeat.com/docs/help/api_code
 # app api所需输入参数定义(根据定义渲染页面UI)
 # Input params define for app api(render web ui by the definition)
 params:

manager/src/main/resources/define/app-centos.yml

@@ -24,6 +24,15 @@ app: centos
 name:
   zh-CN: Centos Linux
   en-US: Centos Linux
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: HertzBeat 对 CentOS 操作系统的通用性能指标(basic、cpu、memory、disk、interface、disk_free)进行采集监控。<br>您可以点击“<i>新建 CentOS 操作系统</i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: HertzBeat monitors CentOS operating system through general performance indicators such as cpu and memory. You could click the "<i>New CentOS</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: HertzBeat對CentOS作業系統的通用性能指標（basic、cpu、memory、disk、interface、disk_free）進行採集監控。<br>您可以點擊“<i>新建CentOS作業系統</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/centos/
+  en-US: https://hertzbeat.com/docs/help/centos/
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-cisco_switch.yml

@@ -24,6 +24,15 @@ app: cisco_switch
 name:
   zh-CN: Cisco通用交换机
   en-US: Cisco Switch
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 对 cisco switch 的通用指标进行测量监控。<br>您可以点击 “<i>新建 Cisco Switch</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: Hertzbeat monitors the status codes which returned by the API. You could click the "<i>New Cisco Switch</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: Hertzbeat對cisco switch的通用名額進行量測監控。<br>您可以點擊“<i>新建Cisco Switch</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/cisco_switch
+  en-US: https://hertzbeat.com/docs/help/cisco_switch
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-clickhouse.yml

@@ -24,6 +24,15 @@ app: clickhouse
 name:
   zh-CN: ClickHouse数据库
   en-US: ClickHouse DB
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 对 ClickHouse 数据库监控通用指标进行测量监控。<br>您可以点击 “<i>新建 ClickHouse 数据库</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: Hertzbeat monitors the status codes which returned by the API. You could click the "<i>New ClickHouse Database</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: Hertzbeat對ClickHouse資料庫監控通用名額進行量測監控。<br>您可以點擊“<i>新建ClickHouse資料庫</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/clickhouse
+  en-US: https://hertzbeat.com/docs/help/clickhouse
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-coreos.yml

@@ -24,6 +24,15 @@ app: coreos
 name:
   zh-CN: Fedora CoreOS
   en-US: Fedora CoreOS
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 对 Fedora CoreOS 数据库通用指标进行测量监控。<br>您可以点击 “<i>新建 Fedora CoreOS</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: Hertzbeat monitors Fedora CoreOS through general performance indicator. You could click the "<i>New Fedora CoreOS</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: Hertzbeat對Fedora CoreOS資料庫通用名額進行量測監控。<br>您可以點擊“<i>新建Fedora CoreOS</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/coreos
+  en-US: https://hertzbeat.com/docs/help/coreos
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-debian.yml

@@ -24,6 +24,15 @@ app: debian
 name:
   zh-CN: Debian操作系统
   en-US: Debian Linux
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 对 Debian 操作系统的通用指标进行测量监控。<br>您可以点击 “<i>新建 Debian 操作系统监控</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: Hertzbeat monitors Debian operating system through general performance indicator. You could click the "<i>New Debian Linux Monitor</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: Hertzbeat對Debian作業系統的通用名額進行量測監控。<br>您可以點擊“<i>新建Debian作業系統監控</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/debian
+  en-US: https://hertzbeat.com/docs/help/debian
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-dm.yml

@@ -24,6 +24,15 @@ app: dm
 name:
   zh-CN: 达梦数据库
   en-US: DM DB
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: HertzBeat 对 DM 达梦数据库的通用性能指标(basic、status、thread)进行采集监控，支持版本为 DM8+。<br>您可以点击“<i>新建 达梦数据库</i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: HertzBeat monitors DM database through basic performance indicators such as status and thread, the version we support is DM8+. You could click the "<i>New DM</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: HertzBeat對DM達夢資料庫的通用性能指標（basic、status、thread）進行採集監控，支持版本為DM8+。<br>您可以點擊“<i>新建達夢資料庫</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/dm
+  en-US: https://hertzbeat.com/docs/help/dm
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-docker.yml

@@ -24,6 +24,15 @@ app: docker
 name:
   zh-CN: Docker
   en-US: Docker
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: HertzBeat 对 Docker 容器的通用性能指标（system、containers、stats）进行采集监控 <br><span class='help_module_span'>⚠️注意：为了监控 Docker 中的容器信息，您需要打开端口，让采集请求获取到对应的信息, <a class='help_module_content' href='https://hertzbeat.com/zh-cn/docs/help/docker#%E7%9B%91%E6%8E%A7%E5%89%8D%E6%93%8D%E4%BD%9C'>点击查看开启步骤</a>。</span>
+  en-US: "HertzBeat monitors Docker through general performance indicators such as containers, status, <br><span class='help_module_span'>⚠️Note: In order to monitor container information of Docker, you need to enable the port so that the collection request can obtain the corresponding information.<a class='help_module_content' href='https://hertzbeat.com/docs/help/docker#%E7%9B%91%E6%8E%A7%E5%89%8D%E6%93%8D%E4%BD%9C'>Click here to view the specific steps.</a></span>"
+  zh-TW: HertzBeat對Docker容器的通用性能指標（system、containers、stats）進行採集監控<br><span class='help_ module_ span'> ⚠️ 注意：為了監控Docker中的容器資訊，您需要打開埠，讓採集請求獲取到對應的資訊，<a class='help_ module_ content' href='https://hertzbeat.com/zh-cn/docs/help/docker#%E7%9B%91%E6%8E%A7%E5%89%8D%E6%93%8D%E4%BD%9C '>點擊查看開啟步驟</a>。</span>
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/docker/
+  en-US: https://hertzbeat.com/docs/help/docker/
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params:

manager/src/main/resources/define/app-doris_be.yml

@@ -22,6 +22,15 @@ app: doris_be
 name:
   zh-CN: Doris 数据库BE
   en-US: Doris DatabaseBE
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+  zh-CN: Hertzbeat 对 DORIS 数据库FE的通用性能指标（load channel count、memtable flush total、process thread num、light work max threads等）进行采集监控，支持版本为DORIS2.0.0。<br>您可以点击 “<i>新建 Doris DatabaseBE</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+  en-US: Hertzbeat monitors Doris DatabaseBE through general performance indicator such as load channel count, memtable flush total, process thread num and light work max threads. The version we support is DORIS2.0.0. You could click the "<i>New Doris DatabaseBE Monitor</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
+  zh-TW: Hertzbeat對DORIS資料庫FE的通用性能指標（load channel count、memtable flush total、process thread num、light work max threads等）進行採集監控，支持版本為DORIS2.0.0。<br>您可以點擊“<i>新建Doris DatabaseBE</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
+helpLink:
+  zh-CN: https://hertzbeat.com/zh-cn/docs/help/doris_be/
+  en-US: https://hertzbeat.com/docs/help/doris_be/
 # 监控所需输入参数定义(根据定义渲染页面UI)
 # Input params define for monitoring(render web ui by the definition)
 params: