This is an automated email from the ASF dual-hosted git repository.
zhaoqingran pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 63562421a [docs] Optimize: add help docs for UDP port & Springboot3
help doc (#1832)
63562421a is described below
commit 63562421a5c8c62dd4f6e6af29a87c8b8f9b9286
Author: Zhang Yuxuan <[email protected]>
AuthorDate: Wed Apr 24 21:08:33 2024 +0800
[docs] Optimize: add help docs for UDP port & Springboot3 help doc (#1832)
---
home/docs/help/port.md | 6 +-
home/docs/help/springboot3.md | 87 ++++++++++++++++++++++
home/docs/help/udp_port.md | 33 ++++++++
.../current/help/port.md | 4 +-
.../current/help/springboot3.md | 87 ++++++++++++++++++++++
.../current/help/udp_port.md | 30 ++++++++
home/sidebars.json | 2 +
.../src/main/resources/define/app-springboot3.yml | 6 +-
manager/src/main/resources/define/app-udp_port.yml | 4 +-
9 files changed, 249 insertions(+), 10 deletions(-)
diff --git a/home/docs/help/port.md b/home/docs/help/port.md
index ef5f659ad..e3350a877 100644
--- a/home/docs/help/port.md
+++ b/home/docs/help/port.md
@@ -1,8 +1,8 @@
---
id: port
-title: Monitoring：port availability
-sidebar_label: Port availability
-keywords: [open source monitoring tool, open source port monitoring tool,
monitoring port metrics]
+title: Monitoring：TCP port availability
+sidebar_label: TCP Port availability
+keywords: [open source monitoring tool, open source port monitoring tool,
monitoring TCP port metrics]
---
> Judge whether the exposed port of the opposite end service is available,
> then judge whether the opposite end service is available, and collect
> Metrics such as response time for monitoring.
diff --git a/home/docs/help/springboot3.md b/home/docs/help/springboot3.md
new file mode 100644
index 000000000..0dbc32fc8
--- /dev/null
+++ b/home/docs/help/springboot3.md
@@ -0,0 +1,87 @@
+---
+id: springboot3
+Title: Monitoring SpringBoot 3.0
+sidebar_label: SpringBoot 3.0
+keywords: [open source monitoring tool, open source monitoring tool,
monitoring springboot3 metrics]
+---
+
+> Collect and monitor the general performance metrics exposed by the
SpringBoot 3.0 actuator.
+
+## Pre-monitoring operations
+
+If you want to monitor information in 'SpringBoot' with this monitoring type,
you need to integrate your SpringBoot application and enable the SpringBoot
Actuator.
+
+**1、Add POM .XML dependencies:**
+
+```xml
+<dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter-actuator</artifactId>
+</dependency>
+```
+
+**2. Modify the YML configuration exposure metric interface:**
+
+```yaml
+management:
+ endpoints:
+ web:
+ exposure:
+ include: '*'
+ enabled-by-default: on
+```
+
+*Note: If your project also introduces authentication related dependencies,
such as springboot security, the interfaces exposed by SpringBoot Actor may be
intercepted. In this case, you need to manually release these interfaces.
Taking springboot security as an example, you should add the following code to
the Security Configuration class:*
+
+```java
+public class SecurityConfig extends WebSecurityConfigurerAdapter{
+ @Override
+ protected void configure(HttpSecurity httpSecurity) throws Exception{
+ httpSecurity
+ // Configure the interfaces to be released
-----------------------------------
+ .antMatchers("/actuator/**").permitAll()
+ .antMatchers("/metrics/**").permitAll()
+ .antMatchers("/trace").permitAll()
+ .antMatchers("/heapdump").permitAll()
+ // ...
+ // For other interfaces, please refer to:
https://blog.csdn.net/JHIII/article/details/126601858
-----------------------------------
+ }
+}
+```
+
+### Configuration Parameters
+
+| Parameter Name | Parameter Description
|
+|-------------------|----------------------------------------------------------------------------------------------------------------------|
+| Monitor Host | The monitored peer's IPV4, IPV6, or domain name. Note⚠️:
Do not include protocol headers (eg: https://, http://). |
+| Task Name | Identifies the name of this monitor, ensuring uniqueness
is necessary. |
+| Port | The port provided by the application service, default is
8080. |
+| Enable SSL | Whether to access the website via HTTPS. Note⚠️:
Enabling HTTPS generally requires changing the default port to 443. |
+| Collector | Specifies which collector to use for scheduling data
collection for this monitor. |
+| Monitoring Period | Interval for periodically collecting data, in seconds,
with a minimum interval of 30 seconds. |
+| Bind Tags | Tags for categorizing and managing monitored resources.
|
+| Description | Additional identification and description for this
monitor, where users can add remarks. |
+
+### Collection Metrics
+
+#### Metric Set: Availability
+| Metric Name | Unit | Metric Description |
+|--------------|------|--------------------|
+| responseTime | ms | Response time |
+
+#### Metric Set: Threads
+| Metric Name | Unit | Metric Description |
+|-------------|------|----------------------------------|
+| state | None | Thread state |
+| size | None | Number of threads for this state |
+
+#### Metric Set: Memory Usage
+| Metric Name | Unit | Metric Description |
+|-------------|------|-----------------------------|
+| space | None | Memory space name |
+| mem_used | MB | Memory usage for this space |
+
+#### Metric Set: Health Status
+| Metric Name | Unit | Metric Description |
+|-------------|------|---------------------------------|
+| status | None | Service health status: UP, Down |
diff --git a/home/docs/help/udp_port.md b/home/docs/help/udp_port.md
new file mode 100644
index 000000000..c3e4e0963
--- /dev/null
+++ b/home/docs/help/udp_port.md
@@ -0,0 +1,33 @@
+---
+id: port
+title: Monitoring：UDP port availability
+sidebar_label: UDP Port availability
+keywords: [open source monitoring tool, open source port monitoring tool,
monitoring UDP port metrics]
+---
+
+> UDP is a connectionless transport layer protocol. We determine the
availability status of its ports by sending request packets at the application
layer and receiving responses. The configuration information requires filling
in the hexadecimal content of the application layer packets that prompt
responses from the peer. We recommend using Wireshark for packet capture to
obtain the transmitted packet content.<br>You can click on `Create UDP Port
Availability` to configure or select `More [...]
+
+### Configuration parameter
+
+| Parameter name | Parameter help description
|
+|---------------------|--------------------------------------------------------------------------------------------------------------------------|
+| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️ Without
protocol header (eg: https://, http://). |
+| Monitoring name | Identify the name of this monitoring. The name needs
to be unique. |
+| Port | Ports provided by website.
|
+| Connection timeout | The waiting timeout for port connections, in
milliseconds. Default is 6000 milliseconds. |
+| Sent Packet Content | The hexadecimal content of the application layer
packet that prompts a response from the peer. |
+| Collector | Specifies which collector to use for scheduling
collection for this monitoring. |
+| Collection interval | Interval time of monitor periodic data collection,
unit: second, and the minimum interval that can be set is 30 seconds. |
+| Bind Tags | Classification management tags for monitoring
resources. |
+| Description | For more information about identifying and describing
this monitoring, users can note information here. |
+
+### Collection Metric
+
+#### Metric set：summary
+
+| Metric name | Metric unit | Metric help description |
+|---------------|-------------------|-------------------------|
+| Response Time | Milliseconds (ms) | Website response time |
+
+
+
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md
index b89fde24a..f27314e8e 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md
@@ -1,8 +1,8 @@
---
id: port
title: 监控：端口可用性
-sidebar_label: 端口可用性
-keywords: [开源监控系统, 开源网络监控, 端口可用性监控]
+sidebar_label: TCP 端口可用性
+keywords: [开源监控系统, 开源网络监控, TCP 端口可用性监控]
---
> 判断对端服务暴露端口是否可用，进而判断对端服务是否可用，采集响应时间等指标进行监测
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md
new file mode 100644
index 000000000..384f9249d
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md
@@ -0,0 +1,87 @@
+---
+id: springboot3
+title: 监控：SpringBoot3.0 监控
+sidebar_label: SpringBoot3.0 监控
+keywords: [开源监控系统, 开源消息中间件监控, SpringBoot3.0 监控]
+---
+
+> 对SpringBoot3.0 actuator 暴露的通用性能指标进行采集监控。
+
+## 监控前操作
+
+如果想要通过此监控类型监控 `SpringBoot` 中的信息，则需要您的SpringBoot应用集成并开启SpringBoot Actuator。
+
+**1、添加POM.XML依赖：**
+
+```xml
+<dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter-actuator</artifactId>
+</dependency>
+```
+
+**2、修改YML配置暴露指标接口：**
+
+```yaml
+management:
+ endpoints:
+ web:
+ exposure:
+ include: '*'
+ enabled-by-default: on
+```
+
+*注意：如果你的项目里还引入了认证相关的依赖，比如springboot-security,那么SpringBoot
Actuator暴露出的接口可能会被拦截，此时需要你手动放开这些接口，以springboot-security为例，需要在SecurityConfig配置类中加入以下代码：*
+
+```java
+public class SecurityConfig extends WebSecurityConfigurerAdapter{
+ @Override
+ protected void configure(HttpSecurity httpSecurity) throws Exception{
+ httpSecurity
+ // 配置要放开的接口 -----------------------------------
+ .antMatchers("/actuator/**").permitAll()
+ .antMatchers("/metrics/**").permitAll()
+ .antMatchers("/trace").permitAll()
+ .antMatchers("/heapdump").permitAll()
+ // ...
+ //
其他接口请参考：https://blog.csdn.net/JHIII/article/details/126601858
-----------------------------------
+ }
+}
+```
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|--------|------------------------------------------------------|
+| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | 应用服务对外提供的端口，默认为8080。 |
+| 启动SSL | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443。 |
+| 采集器 | 配置此监控使用哪台采集器调度采集。 |
+| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 |
+| 绑定标签 | 对监控资源的分类管理标签。 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 |
+
+### 采集指标
+
+#### 指标集合：可用性
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|--------------|------|--------|
+| responseTime | ms | 响应时间 |
+
+#### 指标集合：线程
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-------|------|--------------------|
+| state | 无 | 线程状态 |
+| size | 无 | 此线程状态对应的线程数量 |
+
+#### 指标集合：内存使用
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------|------|-----------|
+| space | 无 | 内存空间名称 |
+| mem_used | MB | 此空间占用内存大小 |
+
+#### 指标集合：健康状态
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|--------|------|-----------------|
+| status | 无 | 服务健康状态: UP,Down |
\ No newline at end of file
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md
new file mode 100644
index 000000000..1098a04cd
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md
@@ -0,0 +1,30 @@
+---
+id: udp
+title: 监控：UDP 端口可用性监控
+sidebar_label: UDP 端口可用性监控
+keywords: [开源监控系统, 开源网络监控, UDP 端口可用性监控]
+---
+
+> UDP
是面向无连接的传输层协议，其端口可用性状态我们通过在应用层发送请求报文获得响应来判断，配置信息我们需要填充能使对端响应的应用层16进制报文内容。建议使用wireshark抓包来获取发送报文内容。<br>您可以点击`新建
UDP端口可用性`并进行配置，或者选择`更多操作`</i>”`，导入已有配置。
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|:-------|--------------------------------------------------------|
+| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头 (例如: https://, http://) 。 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | 网站对外提供的端口。 |
+| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认6000毫秒。 |
+| 发送报文内容 | 能使对端响应的应用层16进制报文内容。 |
+| 采集器 | 配置此监控使用哪台采集器调度采集。 |
+| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 |
+| 绑定标签 | 对监控资源的分类管理标签。 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 |
+
+### 采集指标
+
+#### 指标集合：概要
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------|---------|--------|
+| 响应时间 | 毫秒 (ms) | 网站响应时间 |
diff --git a/home/sidebars.json b/home/sidebars.json
index 194b16fd6..8372a4fb2 100644
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -133,6 +133,7 @@
"help/api",
"help/ping",
"help/port",
+ "help/udp_port",
"help/fullsite",
"help/ssl_cert",
"help/nginx",
@@ -149,6 +150,7 @@
"items": [
"help/jvm",
"help/springboot2",
+ "help/springboot3",
"help/dynamic_tp"
]
},
diff --git a/manager/src/main/resources/define/app-springboot3.yml
b/manager/src/main/resources/define/app-springboot3.yml
index b6048d1d0..1186afabe 100644
--- a/manager/src/main/resources/define/app-springboot3.yml
+++ b/manager/src/main/resources/define/app-springboot3.yml
@@ -28,9 +28,9 @@ name:
# The description and help of this monitoring type
# 监控类型的帮助描述信息
help:
- zh-CN: HertzBeat 对 <a class='help_module_content'
href='http://www.tutorialspoint.com/spring_boot/spring_boot_actuator.htm'>
SpringBoot3.0 Actuator </a>
暴露的通用性能指标(health、environment、threads、memory_used)进行采集监控。<span
class='help_module_span'>注意⚠️：如果要监控 SpringBoot 中的信息，需要您的 SpringBoot 应用集成并开启
SpringBoot Actuator, <a class='help_module_content'
href='https://hertzbeat.apache.org/zh-cn/docs/help/springboot2'>点击查看具体步骤</a>。</span>
- en-US: HertzBeat collect and monitors SpringBoot through general performance
metric that exposed by the SpringBoot3.0 Actuator. <br><span
class='help_module_span'><br>Note⚠️:You should make sure that your SpringBoot
application have already integrated and enabled the SpringBoot Actuator, <a
class='help_module_content'
href='https://hertzbeat.apache.org/docs/help/springboot2'>click here to see the
specific steps.</a></span>
- zh-TW: HertzBeat 對<a class='help_module_content'
href='http://www.tutorialspoint.com/spring_boot/spring_boot_actuator.htm'>
SpringBoot3.0 Actuator
</a>暴露的通用性能指標（health、environment、threads、memory_used）進行採集監控。< span
class='help_module_span'>注意⚠️：如果要監控SpringBoot中的指標，需要您的SpringBoot應用集成並開啟SpringBoot
Actuator，<a class='help_module_content'
href='https://hertzbeat.apache.org/zh-cn/docs/help/springboot2'>點擊查看具體步驟</a>。</span>
+ zh-CN: HertzBeat 对 <a class='help_module_content'
href='http://www.tutorialspoint.com/spring_boot/spring_boot_actuator.htm'>
SpringBoot3.0 Actuator </a>
暴露的通用性能指标(health、environment、threads、memory_used)进行采集监控。<span
class='help_module_span'>注意⚠️：如果要监控 SpringBoot 中的信息，需要您的 SpringBoot 应用集成并开启
SpringBoot Actuator, <a class='help_module_content'
href='https://hertzbeat.apache.org/zh-cn/docs/help/springboot3'>点击查看具体步骤</a>。</span>
+ en-US: HertzBeat collect and monitors SpringBoot through general performance
metric that exposed by the SpringBoot3.0 Actuator. <br><span
class='help_module_span'><br>Note⚠️:You should make sure that your SpringBoot
application have already integrated and enabled the SpringBoot Actuator, <a
class='help_module_content'
href='https://hertzbeat.apache.org/docs/help/springboot3'>click here to see the
specific steps.</a></span>
+ zh-TW: HertzBeat 對<a class='help_module_content'
href='http://www.tutorialspoint.com/spring_boot/spring_boot_actuator.htm'>
SpringBoot3.0 Actuator
</a>暴露的通用性能指標（health、environment、threads、memory_used）進行採集監控。< span
class='help_module_span'>注意⚠️：如果要監控SpringBoot中的指標，需要您的SpringBoot應用集成並開啟SpringBoot
Actuator，<a class='help_module_content'
href='https://hertzbeat.apache.org/zh-cn/docs/help/springboot3'>點擊查看具體步驟</a>。</span>
helpLink:
zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/springboot3
en-US: https://hertzbeat.apache.org/docs/help/springboot3
diff --git a/manager/src/main/resources/define/app-udp_port.yml
b/manager/src/main/resources/define/app-udp_port.yml
index c5ec0a526..b603267c5 100644
--- a/manager/src/main/resources/define/app-udp_port.yml
+++ b/manager/src/main/resources/define/app-udp_port.yml
@@ -30,8 +30,8 @@ help:
en-US: UDP is a connectionless transport layer protocol. We can judge its
port availability status by sending a request message at the application layer
and getting a response. We need to input the application layer hexadecimal
message content that enables the peer to respond. Suggest using wireshark to
capture packets to obtain the send package content. <br>You could click the
"<i>New UDP Port</i>" button and proceed with the configuration or import an
existing setup through the "<i>M [...]
zh-TW: UDP
是面向無連接的傳輸層協議，其連接埠可用性狀態我們透過在應用層發送請求封包獲得回應來判斷，設定指標我們需要填充能使對端回應的應用層16進位封包
內容。建議使用wireshark抓包來取得報文內容。<br>您可以點選“<i>新
UDP連接埠可用性</i>”並進行配置，或選擇“<i>更多操作</i>”，匯入已有配置。
helpLink:
- zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/port
- en-US: https://hertzbeat.apache.org/docs/help/port
+ zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/udp_port
+ en-US: https://hertzbeat.apache.org/docs/help/udp_port
# 监控所需输入参数定义(根据定义渲染页面UI)
# Input params define for monitoring(render web ui by the definition)
params:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
