mirror of
https://github.com/dromara/hertzbeat.git
synced 2024-10-23 06:45:24 +08:00
[improve] improve markdown format for MD045 (#2658)
Co-authored-by: aias00 <rokkki@163.com> Co-authored-by: Jast <shenghang@apache.org> Co-authored-by: shown <yuluo08290126@gmail.com>
This commit is contained in:
Calvin
GitHub
parent
86ca715a64
commit
50a18f2813
@ -34,7 +34,7 @@
|
||||
},
|
||||
"MD036": false,
|
||||
"MD040": true,
|
||||
"MD045": false,
|
||||
"MD045": true,
|
||||
"MD046": true,
|
||||
"MD047": true,
|
||||
"MD052": true
|
||||
|
||||
@ -38,7 +38,7 @@ Online at <https://console.tancloud.cn>.
|
||||
---
|
||||
Windows Monitor coming：
|
||||
|
||||
|
||||
|
||||
|
||||
⚠️ ⚠️⚠️⚠️Please note that upgrading to v1.1.0 from other versions requires running the following SQL script. Now, our table names have a unified prefix "hzb_prefix".
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ Online at [https://console.tancloud.cn](https://console.tancloud.cn).
|
||||
---
|
||||
Windows Monitor is coming:
|
||||
|
||||
|
||||
|
||||
|
||||
⚠️ ⚠️⚠️⚠️Please note that upgrading to v1.1.0 from other versions requires running the following SQL script. Now, our table names have a unified prefix hzb_prefix.
|
||||
|
||||
|
||||
@ -38,52 +38,52 @@ gitee: <https://gitee.com/hertzbeat/hertzbeat>
|
||||
|
||||
> System Page -> Monitor Menu -> SSL Certificates -> New SSL Certificate
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure monitoring website
|
||||
|
||||
> Here is an example to monitor Baidu website, configure the host domain name, name, collection interval, etc. > Click OK.
|
||||
> Click OK. Note that ⚠️ will test the connectivity of the website before adding it by default, and it will add it only if the connection is successful, of course, you can also gray out the **Whether to test** button.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Viewing Test Indicator Data
|
||||
|
||||
> You can view the task status in the monitor list, and go into the monitor details to view the metrics data graphs etc.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set the threshold (triggered when the certificate expires)
|
||||
|
||||
> System Page -> Alarms -> Alarm Thresholds -> Add Thresholds
|
||||
|
||||
|
||||
|
||||
|
||||
> Configure thresholds, select SSL certificate indicator object, configure alert expression - triggered when indicator `expired` is `true`, i.e. `equals(expired, "true")` , set alert level notification template message etc.
|
||||
|
||||
|
||||
|
||||
|
||||
> Associate thresholds with monitors, set which monitors this threshold should be applied to in the threshold list.
|
||||
|
||||
|
||||
|
||||
|
||||
5. set the threshold (triggered one week before certificate expiration)
|
||||
|
||||
> Same as above, add a new configuration threshold, configure the alert expression - when the indicator validity timestamp `end_timestamp`, `now()` function for the current timestamp, if you configure to trigger the alert one week in advance i.e.: `end_timestamp <= (now() + 604800000)` , where `604800000` is the total time difference of 7 days. milliseconds.
|
||||
|
||||
|
||||
|
||||
|
||||
> Eventually you can see the triggered alarms in the alarm center.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Alarm notification (timely notification via NailWeChatFlysheet, etc.)
|
||||
|
||||
> Monitoring System -> Alert Notification -> Add Recipients
|
||||
|
||||
|
||||
|
||||
|
||||
You can refer to the help file for the token configuration of Nail WeChat Flying Book, etc.
|
||||
|
||||
@ -92,7 +92,7 @@ gitee: <https://gitee.com/hertzbeat/hertzbeat>
|
||||
|
||||
> Alert Notification -> Add new alert notification policy -> Enable notification for the recipients you just configured
|
||||
|
||||
|
||||
|
||||
|
||||
7. OK When the threshold is triggered, we can receive the corresponding alarm message, if there is no notification, you can also view the alarm information in the alarm center.
|
||||
|
||||
|
||||
@ -49,26 +49,26 @@ tags: [opensource, practice]
|
||||
|
||||
Path: Menu -> Database Monitoring -> IoTDB Monitoring -> Add IoTDB Monitoring
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure the parameters required for monitoring IoTDB
|
||||
|
||||
Fill in the IoTDB **service IP** and **monitoring port** (default 9091) on the monitoring page, and finally click OK to add.
|
||||
For other parameters such as **collection interval**, **timeout period**, etc., please refer to [Help Documentation](https://hertzbeat.com/docs/help/iotdb/) <https://hertzbeat.com/docs/help> /iotdb/
|
||||
|
||||
|
||||
|
||||
|
||||
3. Complete ✅, now we have added the monitoring of IoTDB, check the monitoring list to see our added items.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click **Operation**->**Monitoring Details Icon** of the monitoring list item to browse the real-time monitoring metric data of IoTDB.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click **Monitoring History Details TAB** to browse IoTDB's historical monitoring metric data chart📈.
|
||||
|
||||
|
||||
|
||||
|
||||
**Complete DONE! Through the above steps, it is actually two steps to sum up**
|
||||
|
||||
@ -88,7 +88,7 @@ tags: [opensource, practice]
|
||||
- Select the configured metric object. IotDB monitors many metrics, one of which is related to the status of the node `cluster_node_status` -> `status` (node status, 1=online 2=offline).
|
||||
- Here we configure to send an alarm when the metric `status==2`, the alarm level is **Critical Alarm**, which is triggered once, as shown in the figure below.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add message notification recipients
|
||||
|
||||
@ -101,11 +101,11 @@ tags: [opensource, practice]
|
||||
|
||||
【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure the associated alarm notification strategy ⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]
|
||||
|
||||
|
||||
|
||||
|
||||
### Finished, now wait for the warning message to come. ding ding ding ding
|
||||
|
||||
|
||||
@ -72,28 +72,28 @@ tags: [opensource, practice]
|
||||
|
||||
Path: Menu -> Middleware Monitor -> ShenYu Monitor -> Add ShenYu Monitor
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure the parameters required for monitoring ShenYu
|
||||
|
||||
On the monitor page, fill in ShenYu **service IP**, **monitor port** (default 8090), and click OK to add.
|
||||
For other parameters such as **collection interval**, **timeout**, etc., you can refer to the [help file](https://hertzbeat.com/docs/help/shenyu/) <https://hertzbeat.com/docs/help/shenyu/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. Done ✅, now we have added monitoring for ShenYu, check the monitor list to see our additions.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click **Options**->**Monitoring Details icon** in the monitor list to view ShenYu's real-time monitoring metrics.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click the **Monitor History TAB** to view ShenYu's historical monitoring metrics graphs 📈.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE! With the above steps, it's really only two steps**
|
||||
|
||||
@ -116,7 +116,7 @@ Of course, just looking at it is not perfect, monitoring is often accompanied by
|
||||
- There are a lot of metrics in ShenYu monitoring, for example, we will set the threshold for the `number of open file descriptors` `process_open_fds` -> `value` metric, which will alert you when the number of open file descriptors on the server side is greater than 3,000.
|
||||
- Here we configure an alert to be issued when the `value' of`process_open_fds` exceeds 3000, with an alert level of **Warning alert**, which is triggered three times, as shown in the following figure.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add message notification recipients
|
||||
|
||||
@ -131,13 +131,13 @@ Of course, just looking at it is not perfect, monitoring is often accompanied by
|
||||
|
||||
[Alert Notification] -> [Add Recipient] -> [Select Nailed Bot Notification Method] -> [Set Nailed Bot ACCESS_TOKEN] -> [OK]
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure the associated alert notification policy ⚠️ [Add Notification Policy] -> [Associate the recipient you just set] -> [OK] !
|
||||
|
||||
> Configure the alert notification policy to bind alert messages to recipients so that you can decide which alerts go to which person.
|
||||
|
||||
|
||||
|
||||
|
||||
### Over and out, now wait for the alert message to come through. Ding, ding, ding, ding
|
||||
|
||||
|
||||
@ -84,28 +84,28 @@ tags: [opensource, practice]
|
||||
|
||||
Path: Menu -> Middleware Monitor -> DynamicTp Monitor -> Add DynamicTp Monitor
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure the parameters required for monitoring DynamicTp.
|
||||
|
||||
On the monitor page, fill in DynamicTp **service IP**, **monitoring port** (default 8080), and finally click OK to add it.
|
||||
For other parameters such as **collection interval**, **timeout**, etc., you can refer to [help](https://hertzbeat.com/docs/help/dynamic_tp/) <https://hertzbeat.com/docs/help/dynamic_tp/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. Done ✅, now we have added monitoring for DynamicTp, check the monitor list to see our additions.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click **Options**->**Monitor Details icon** in the Monitor list to view the real-time monitoring metrics of the DynamicTp thread pool.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click the **Monitoring History TAB** to view a graphical representation of the historical monitoring metrics for the DynamicTp thread pool 📈.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE! With the above steps, it's really just two steps**
|
||||
|
||||
@ -128,7 +128,7 @@ Of course, just watching is not perfect, monitoring is often accompanied by alar
|
||||
- DynamicTp monitors some thread pool related metrics, for example, we set the threshold for the `run_timeout_count` `thread_pool_running` -> `run_timeout_count` metric, which will raise an alarm when the thread_timeout_count is greater than one.
|
||||
- Here we configure an alert to be issued when `thread_pool_running` has a `run_timeout_count>1`, with an alert level of **Serious Alert**, which is triggered three times, as shown in the following figure.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add message notification recipients
|
||||
|
||||
@ -143,13 +143,13 @@ Of course, just watching is not perfect, monitoring is often accompanied by alar
|
||||
|
||||
[Alert Notification] -> [Add Recipient] -> [Choose Dingtalk bot notification method] -> [Set Dingtalk bot ACCESS_TOKEN] -> [OK]
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure the associated alert notification policy ⚠️ [Add Notification Policy] -> [Associate the recipient you just set] -> [OK] !
|
||||
|
||||
> Configure the alert notification policy to bind alert messages to recipients so that you can decide which alerts go to which person.
|
||||
|
||||
|
||||
|
||||
|
||||
### Over and out, now wait for the alert message to come through. Ding, ding, ding, ding
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4
|
||||
tags: [opensource]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
## Welcome two new Committers from HertzBeat
|
||||
|
||||
|
||||
@ -35,26 +35,26 @@ Keywords: [Open source monitoring tool, open source database monitoring, Mysql d
|
||||
|
||||
Path: Menu -> Database Monitoring -> Mysql Database -> Add Mysql Database Monitoring
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure the parameters required for the new monitoring Mysql database
|
||||
|
||||
On the monitoring page, fill in Mysql **service IP**, **monitoring port** (default 3306), **account password, etc.**, and finally click OK to add.
|
||||
For other parameters such as **collection interval**, **timeout period**, etc., please refer to [Help Documentation](https://hertzbeat.com/docs/help/mysql/) <https://hertzbeat.com/docs/help> /mysql/
|
||||
|
||||
|
||||
|
||||
|
||||
3. Complete ✅, now we have added the monitoring of the Mysql database, check the monitoring list to see our added items.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click **Operation**->**Monitoring Details Icon** of the monitoring list item to browse the real-time monitoring metric data of the Mysql database.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click **Monitoring History Details TAB** to browse the historical monitoring metric data chart of Mysql database📈.
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE! Done! Through the above steps, in fact, it only takes one step to sum up**
|
||||
|
||||
@ -76,9 +76,9 @@ Of course, just looking at it is definitely not perfect. Monitoring is often acc
|
||||
- Select the configured metric object. Mysql database monitoring is mainly about database performance and other related metrics. For example, we set the threshold for the metric `query cache hit rate` `cache` -> `query_cache_hit_rate`. When the query cache hit rate of Mysql is very low An alarm is issued when it is less than 30%.
|
||||
- Here we configure to send an alarm when the `query_cache_hit_rate<30` of this metric `cache`, the alarm level is **serious alarm**, and it will be triggered after three times, as shown in the figure below.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add message notification recipients
|
||||
|
||||
@ -93,13 +93,13 @@ Of course, just looking at it is definitely not perfect. Monitoring is often acc
|
||||
|
||||
【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure the associated alarm notification strategy ⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]
|
||||
|
||||
> Configure the alarm notification policy to bind the alarm message with the receiver, so that you can decide which alarms to send to whom.
|
||||
|
||||
|
||||
|
||||
|
||||
### Finished, now wait for the warning message to come. ding ding ding ding
|
||||
|
||||
|
||||
@ -32,30 +32,30 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
Path: Menu -> Operating System Monitoring -> Linux Operating System -> Add Linux Operating System Monitoring
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure the parameters required for new monitoring Linux
|
||||
|
||||
Fill in the Linux **peer IP**, **SSH port** (default 22), **account password, etc.** on the monitoring page, and finally click OK to add.
|
||||
For other parameters such as **collection interval**, **timeout period**, etc., please refer to the help document <https://hertzbeat.com/docs/help/mysql/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. Complete ✅, now we have added the monitoring of Linux, check the monitoring list to see our added items.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click **Operation**->**Monitoring Details Icon** of the monitoring list item to browse the real-time monitoring metric data of Linux.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click **Monitoring History Details TAB** to browse the historical monitoring metric data chart of Linux📈.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE! Done! To sum up, it only takes one step**
|
||||
|
||||
@ -77,9 +77,9 @@ Of course, just looking at it is definitely not perfect. Monitoring is often acc
|
||||
- Select the configured metric object. Linux monitors mainly related metrics such as cpu, memory, disk, network performance, etc. For example, we set the threshold for the metric `CPU utilization` `cpu` -> `usage`. When the Linux cpu utilization is greater than 90% When a warning is issued.
|
||||
- Here we configure to send an alarm when the `usage>90` of this metric `cpu`, the alarm level is **Warning Alarm**, which will be triggered after three times, as shown in the figure below.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add message notification recipients
|
||||
|
||||
@ -94,13 +94,13 @@ Of course, just looking at it is definitely not perfect. Monitoring is often acc
|
||||
|
||||
【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure the associated alarm notification strategy ⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]
|
||||
|
||||
> Configure the alarm notification policy to bind the alarm message with the receiver, so that you can decide which alarms to send to whom.
|
||||
|
||||
|
||||
|
||||
|
||||
### Finished, now wait for the warning message to come. ding ding ding ding
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
|
||||
Website: hertzbeat.com | tancloud.cn
|
||||
|
||||
|
||||
|
||||
|
||||
### What is HertzBeat?
|
||||
|
||||
@ -22,7 +22,7 @@ Website: hertzbeat.com | tancloud.cn
|
||||
>
|
||||
> Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by defining YML?
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
@ -34,7 +34,7 @@ After a month of iterations, HertzBeat v1.3.0 was officially released last weeke
|
||||
|
||||
- Hertzbeat has powerful custom monitoring capabilities, all our supported monitoring types are mapped to a YML. This time we bring custom monitoring pagination, welcome to use and share your own monitoring type definition.
|
||||
|
||||
|
||||
|
||||
|
||||
- **support for monitoring network switches**.
|
||||
hertzbeat supported snmp protocol long time ago, windows monitoring is monitored by snmp protocol, this version we not only support more windows performance metrics, but also support snmp walk, adapt several common network switches monitoring, welcome to contribute more types and metrics to the community.
|
||||
|
||||
@ -89,26 +89,26 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
Path: Menu -> Application Service Monitoring -> SpringBoot2 -> Add SpringBoot2 Monitoring
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure the parameters required for new monitoring SpringBoot2
|
||||
|
||||
Fill in the SpringBoot2 application **peer IP**, **service port** (default 8080), **account password, etc.** on the monitoring page, and finally click OK to add.
|
||||
For other parameters such as **collection interval**, **timeout period**, etc., please refer to the help document <https://hertzbeat.com/docs/help/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. Complete ✅, now we have added the monitoring of the SpringBoot2 application, check the monitoring list to see our additions.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click **Operation**->**Monitoring Details Icon** of the monitoring list item to browse the real-time monitoring metric data of the SpringBoot2 application.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click **Monitoring History Details TAB** to browse the historical monitoring metric data chart of the SpringBoot2 application📈.
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE! Done! It doesn't require us to deploy agents or various cumbersome operations, isn't it very simple**
|
||||
|
||||
@ -130,9 +130,9 @@ Of course, it is impossible to manually check the metrics in real time. Monitori
|
||||
- Select the configured metric object. SpringBoot2 application monitoring mainly focuses on stack memory threads and other related metrics. For example, we set the threshold for the metric `threads` -> `threads`. When the number of threads in the `runnable` state is greater than At 300 an alert is issued.
|
||||
- Here we configure to send an alarm when `size`, `state` of `equals(state, "runnable"") && size>300` of this metric, the alarm level is **warning alarm**, which will be triggered three times, specifically As shown below.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add message notification recipients
|
||||
|
||||
@ -147,13 +147,13 @@ Of course, it is impossible to manually check the metrics in real time. Monitori
|
||||
|
||||
【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure the associated alarm notification strategy ⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]
|
||||
|
||||
> Configure the alarm notification policy to bind the alarm message with the receiver, so that you can decide which alarms to send to whom.
|
||||
|
||||
|
||||
|
||||
|
||||
### Finished, now wait for the warning message to come. ding ding ding ding
|
||||
|
||||
@ -181,7 +181,7 @@ This practical article took us to experience how to use the open source real-tim
|
||||
|
||||
> Through the simple steps above, we have realized the monitoring of SpringBoot2, but the built-in metrics in it do not meet the needs. Can we customize and monitor more metrics of SpringBoot2? The answer is of course yes, through **Monitoring Definition**->**SpringBoot2** on the page, you can customize and modify the performance metrics you want to monitor by editing the following YML configuration file at any time.
|
||||
|
||||
|
||||
|
||||
|
||||
## What is HertzBeat?
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
|
||||
Website: hertzbeat.com | tancloud.cn
|
||||
|
||||
|
||||
|
||||
|
||||
### What is HertzBeat?
|
||||
|
||||
@ -25,7 +25,7 @@ Website: hertzbeat.com | tancloud.cn
|
||||
> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system.
|
||||
> We also provide **[Monitoring SaaS Cloud](https://console.tancloud.cn)**, users no longer need to deploy a cumbersome monitoring system in order to monitor resources. **[Get started for free](https://console.tancloud.cn)**.
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -112,11 +112,11 @@ See the [official documentation](https://hertzbeat.com/zh-cn/docs/start/docker-d
|
||||
|
||||
Here's the picture: !
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Summary
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
|
||||
Website: hertzbeat.com | tancloud.cn
|
||||
|
||||
|
||||
|
||||
|
||||
### What is HertzBeat?
|
||||
|
||||
@ -25,7 +25,7 @@ Website: hertzbeat.com | tancloud.cn
|
||||
> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system.
|
||||
> We also provide **[Monitoring SaaS Cloud](https://console.tancloud.cn)**, users no longer need to deploy a cumbersome monitoring system in order to monitor resources. **[Get started for free](https://console.tancloud.cn)**.
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ tags: [opensource, practice]
|
||||
keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
### What is HertzBeat?
|
||||
|
||||
@ -24,7 +24,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
|
||||
> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system.
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
@ -43,7 +43,7 @@ The cluster version not only brings us more powerful monitoring performance, but
|
||||
* The monitoring task is self-scheduled in the collector cluster. A single collector hangs up and migrates the collection task without perceptual failure. Newly added collector nodes are automatically scheduled to share the collection pressure.
|
||||
* It is very convenient to switch between stand-alone mode and cluster mode and deploy without additional components.
|
||||
|
||||
|
||||
|
||||
|
||||
#### Cloud Edge Collaboration
|
||||
|
||||
@ -53,7 +53,7 @@ In the isolated network where multiple networks are not connected, in the previo
|
||||
HertzBeat provides cloud-edge collaboration capabilities. Edge collectors can be deployed on multiple isolated networks. When monitoring is added, collectors are specified. The collectors collect monitoring tasks within the isolated network, and report the collected data. The main HertzBeat service performs unified scheduling, management and display.
|
||||
This is mostly used in unified monitoring scenarios of multiple isolated data centers or cloud resources and resources under the cloud of different vendors.
|
||||
|
||||
|
||||
|
||||
|
||||
### Why open source cluster version?
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ tags: [opensource, practice]
|
||||
keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
### What is HertzBeat?
|
||||
|
||||
@ -24,7 +24,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
|
||||
> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system.
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
|
||||
> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system.
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ keywords: [open source monitoring system, alerting system]
|
||||
|
||||
> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system.
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ keywords: [open source monitoring system, alerting system]
|
||||
|
||||
> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system.
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -12,9 +12,9 @@ On April 5, 2024, the open-source real-time monitoring system HertzBeat official
|
||||
|
||||
HertzBeat was officially open-sourced in January 2022 in the Dromara open-source community. After more than two years of continuous project maintenance and iteration by community members, along with sustained community growth, HertzBeat now proudly announces its inclusion in the Apache Incubator!
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Joining the Apache Incubator is not the end, but rather a fresh start for the project. After joining the Apache Incubator, HertzBeat will actively adhere to the "openness and collaboration" philosophy of Apache at the community level, continuously building a fair, diverse, and inclusive open-source community. At the product level, we will listen to user feedback, enhance and optimize the user experience, and create connections within the open-source ecosystem.
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@ Upgrade Guide: <https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-up
|
||||
|
||||
> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system.
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ tags: [opensource, practice]
|
||||
keywords: [open source monitoring system, alerting system]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
> 🎉 I am very pleased to become a Committer for the Apache HertzBeat project, and I have been invited by the community to introduce myself 🥰.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ tags: [opensource, practice]
|
||||
keywords: [open source monitoring system, alerting system]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
### First acquaintance with Apache Hertzbeat
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ tags: [opensource, practice]
|
||||
keywords: [open source monitoring system, alerting system]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
Hello everyone, I am very honored to receive an invitation from the community to be nominated as a Committer for Apache HertzBeat. Let me introduce myself briefly. I have been working as a backend developer since 2019, mainly using Java. Currently, I am working at a network security company, focusing on the backend development of network security-related products.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ tags: [opensource, practice]
|
||||
keywords: [open source monitoring system, alerting system]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
> It's an honor for me to become a Committer of Apache Hertzbeat
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ tags: [opensource, practice]
|
||||
keywords: [open source monitoring system, alerting system]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
> It's an honor for me to become a Committer of Apache Hertzbeat
|
||||
>
|
||||
|
||||
@ -8,7 +8,7 @@ tags: [opensource, practice]
|
||||
keywords: [open source monitoring system, alerting system]
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
> It's an honor for me to become a Committer of Apache HertzBeat
|
||||
|
||||
|
||||
@ -191,19 +191,19 @@ metrics:
|
||||
|
||||
**The addition is complete, now we save and apply. We can see that the system page has added a `hertzbeat` monitoring type.**
|
||||
|
||||
|
||||
|
||||
|
||||
### The system page adds the monitoring of `hertzbeat` monitoring type
|
||||
|
||||
> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details!
|
||||
|
||||
|
||||
|
||||
|
||||
### Set threshold alarm notification
|
||||
|
||||
|
||||
@ -229,13 +229,13 @@ metrics:
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
**After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Use `token` as a variable parameter to collect and use the following metricss
|
||||
|
||||
@ -389,9 +389,9 @@ metrics:
|
||||
|
||||
**After the configuration is complete, save and apply, and check the monitoring details page**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Set threshold alarm notification
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ By configuring the monitoring template YML metrics `field`, `aliasFields`, `obje
|
||||
|
||||
**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -23,4 +23,4 @@ HertzBeat DashBoard -> Service Monitor -> Push Style Monitor -> New Push Style M
|
||||
|
||||
### Monitor Configuration Example
|
||||
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` p
|
||||
|
||||
**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ By configuring the metrics `field`, `aliasFields` the `Telnet` protocol of the m
|
||||
|
||||
**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -203,19 +203,19 @@ metrics:
|
||||
|
||||
**The addition is complete, now we restart the hertzbeat system. We can see that the system page has added a `hertzbeat` monitoring type.**
|
||||
|
||||
|
||||
|
||||
|
||||
### The system page adds the monitoring of `hertzbeat` monitoring type
|
||||
|
||||
> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details!
|
||||
|
||||
|
||||
|
||||
|
||||
### Set threshold alarm notification
|
||||
|
||||
|
||||
@ -155,11 +155,11 @@ keywords: [ open source monitoring tool, open source Redis Cluster monitoring to
|
||||
|
||||
Add a redis monitor center, fill require parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
final effect.
|
||||
|
||||
|
||||
|
||||
|
||||
### Configuration Parameters
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ The fields that need to be filled in are as follows:
|
||||
|
||||
After filling in the organization information, click `Confirm`.
|
||||
|
||||
|
||||
|
||||
|
||||
## 2. Add Component
|
||||
|
||||
@ -51,7 +51,7 @@ status:
|
||||
interval: 60
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## 3. Maintain Events
|
||||
|
||||
@ -59,7 +59,7 @@ When an event occurs, you can publish a notification on the status page.
|
||||
|
||||
Click `Publish Event`
|
||||
|
||||
|
||||
|
||||
|
||||
| Field Name | Field Description | Example |
|
||||
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
@ -70,4 +70,4 @@ Click `Publish Event`
|
||||
|
||||
> Note: You can publish messages multiple times to keep the team updated on the current status.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -42,11 +42,11 @@ slug: /
|
||||
|
||||
HertzBeat itself did not create a data collection protocol for the monitoring client to adapt to. Instead, HertzBeat makes full use of the existing ecosystem, `SNMP protocol` to collect information from network switches and routers, `JMX specification` to collect information from Java applications, `JDBC specification` to collect information from datasets, `SSH` to directly connect to scripts to get the display information, `HTTP+ (JsonPath | prometheus, etc.)` to parse the information from API interfaces, `IPMI protocol` to collect server information, and so on.
|
||||
HertzBeat uses these existing standard protocols or specifications, makes them abstractly configurable, and finally makes them all available in the form of YML format monitoring templates that can be written to create templates that use these protocols to collect any desired metrics data.
|
||||
|
||||
|
||||
|
||||
Do you believe that users can just write a monitoring template on the UI page, click save and immediately adapt a new monitoring type like `K8s` or `Docker`?
|
||||
|
||||
|
||||
|
||||
|
||||
### Built-in Monitoring Types
|
||||
|
||||
@ -97,7 +97,7 @@ Do you believe that users can just write a monitoring template on the UI page, c
|
||||
> Each monitor type is considered as a monitor template, no matter it is built-in or user-defined. You can easily add, modify and delete indicators by modifying the monitoring template.
|
||||
> The templates contain a series of functions such as protocol configuration, environment variables, metrics conversion, metrics calculation, units conversion, metrics collection, etc., which help users to collect the metrics they want.
|
||||
|
||||
|
||||
|
||||
|
||||
### No Agent Required
|
||||
|
||||
@ -120,7 +120,7 @@ The principle of `HertzBeat` is to use different protocols to connect directly t
|
||||
* Monitoring tasks are self-scheduled in the collector cluster, single collector hangs without sensing the failure to migrate the collection tasks, and the newly added collector nodes are automatically scheduled to share the collection pressure.
|
||||
* It is very easy to switch between stand-alone mode and cluster mode without additional component deployment.
|
||||
|
||||
|
||||
|
||||
|
||||
### Cloud Edge Collaboration
|
||||
|
||||
@ -129,7 +129,7 @@ The principle of `HertzBeat` is to use different protocols to connect directly t
|
||||
In an isolated network where multiple networks are not connected, we need to deploy a monitoring system in each network in the previous solution, which leads to data non-interoperability and inconvenient management, deployment and maintenance.
|
||||
`HertzBeat` provides the ability of cloud edge collaboration, can be deployed in multiple isolated networks edge collector, collector in the isolated network within the monitoring task collection, collection of data reported by the main service unified scheduling management display.
|
||||
|
||||
|
||||
|
||||
|
||||
### Easy to Use
|
||||
|
||||
@ -165,7 +165,7 @@ Browser access `http://localhost:1157` default account password `admin/hertzbeat
|
||||
|
||||
* HertzBeat's user management is unified by the configuration file `sureness.yml`, which allows users to add, delete, and modify user information, user role permissions, and so on. Default password admin/hertzbeat
|
||||
|
||||
|
||||
|
||||
|
||||
### Overview Page
|
||||
|
||||
@ -173,7 +173,7 @@ Browser access `http://localhost:1157` default account password `admin/hertzbeat
|
||||
* Show the status of currently registered collector clusters, including collector on-line status, monitoring tasks, startup time, IP address, name and so on.
|
||||
* Show the list of recent alarm messages, alarm level distribution and alarm processing rate.
|
||||
|
||||
|
||||
|
||||
|
||||
### Monitoring Center
|
||||
|
||||
@ -220,7 +220,7 @@ Built-in support for monitoring types include:
|
||||
[HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml),
|
||||
[H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
|
||||
|
||||
|
||||
|
||||
|
||||
### Add and Modify Surveillance
|
||||
|
||||
@ -228,7 +228,7 @@ Built-in support for monitoring types include:
|
||||
* The monitoring parameters configured on the page are defined by the monitoring template of the corresponding monitoring type, and users can modify the configuration parameters on the page by modifying the monitoring template.
|
||||
* Support associated tags to manage monitoring grouping, alarm matching, and so on.
|
||||
|
||||
|
||||
|
||||
|
||||
### Monitor Details
|
||||
|
||||
@ -237,16 +237,16 @@ Built-in support for monitoring types include:
|
||||
* Monitor Historical Data Report displays the historical values of the currently monitored metrics in the form of trend charts, supports querying hourly, daily and monthly historical data, and supports configuring the page refresh time.
|
||||
* ⚠️ Note that the monitoring history charts need to be configured with an external timing database in order to get the full functionality, timing database support: IOTDB, TDengine, InfluxDB, GreptimeDB
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Alarm Center
|
||||
|
||||
* The management display page of triggered alarm messages enables users to visualize the current alarm situation.
|
||||
* Support alarm processing, alarm marking unprocessed, alarm deletion, clearing and other batch operations.
|
||||
|
||||
|
||||
|
||||
|
||||
### Threshold Rules
|
||||
|
||||
@ -255,18 +255,18 @@ Built-in support for monitoring types include:
|
||||
* Threshold rules support visual page configuration or expression rule configuration for more flexibility.
|
||||
* It supports configuring the number of triggers, alarm levels, notification templates, associated with a specific monitor and so on.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Alarm Convergence
|
||||
|
||||
* When the alarm is triggered by the threshold rule, it will enter into the alarm convergence, the alarm convergence will be based on the rules of the specific time period of the duplicate alarm message de-emphasis convergence, to avoid a large number of repetitive alarms lead to the receiver alarm numbness.
|
||||
* Alarm convergence rules support duplicate alarm effective time period, label matching and alarm level matching filter.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Alarm Silence
|
||||
|
||||
@ -274,9 +274,9 @@ Built-in support for monitoring types include:
|
||||
* This application scenario, such as users in the system maintenance, do not need to send known alarms. Users will only receive alarm messages on weekdays, and users need to avoid disturbances at night.
|
||||
* Alarm silence rules support one-time time period or periodic time period, support label matching and alarm level matching.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Message Notification
|
||||
|
||||
@ -286,18 +286,18 @@ Built-in support for monitoring types include:
|
||||
* The notification policy supports tag matching and alert level matching, which makes it convenient to assign alerts with different tags and alert levels to different receivers and handlers.
|
||||
* Support notification templates, users can customize the content format of the templates to meet their own personalized notification display needs.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Monitoring Templates
|
||||
|
||||
* HertzBeat makes `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` and other protocols configurable so that you can customize the metrics you want to collect using these protocols by simply configuring the monitoring template `YML` in your browser. Would you believe that you can instantly adapt a new monitoring type such as `K8s` or `Docker` just by configuring it?
|
||||
* All our built-in monitoring types (mysql, website, jvm, k8s) are also mapped to corresponding monitoring templates, so you can add and modify monitoring templates to customize your monitoring functions.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ HertzBeat Collector is a lightweight data collector used to collect and send dat
|
||||
By deploying multiple HertzBeat Collectors, high availability, load balancing, and cloud-edge collaboration of data can be achieved.
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
1. Execute the following command
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@ HertzBeat Collector is a lightweight data collector used to collect and send dat
|
||||
Deploying multiple HertzBeat Collectors can achieve high availability, load balancing, and cloud-edge collaboration of data.
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
1. Download installation package
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ To install Rainbond, please refer to [Rainbond Quick Install](https://www.rainbo
|
||||
|
||||
After logging in Rainbond, click Market in the left menu, switch to open source app store, and search HertzBeat in the search box, and click the Install button.
|
||||
|
||||
|
||||
|
||||
|
||||
Fill in the following information, and click Confirm button to install.
|
||||
|
||||
@ -25,7 +25,7 @@ Fill in the following information, and click Confirm button to install.
|
||||
|
||||
After installation, HertzBeat can be accessed via the Access button.
|
||||
|
||||
|
||||
|
||||
|
||||
:::tip
|
||||
HertzBeat installed via Rainbond, External Mysql database and Redis and IoTDB are used by default, The HertzBeat configuration file is also mounted, which can be modified in `Components -> Environment Configuration -> Configuration File Settings`.
|
||||
|
||||
@ -28,52 +28,52 @@ github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> System Page -> Monitor Menu -> SSL Certificate -> Add SSL Certificate
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure the monitoring website
|
||||
|
||||
> Here we take the example of monitoring Baidu website, configure monitoring host domain name, name, collection interval, etc.
|
||||
> Click OK Note ⚠️Before adding, it will test the connectivity of the website by default, and the connection will be successful before adding. Of course, you can also gray out the **Test or not** button.
|
||||
|
||||
|
||||
|
||||
|
||||
3. View the detection index data
|
||||
|
||||
> In the monitoring list, you can view the monitoring status, and in the monitoring details, you can view the metric data chart, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set the threshold (triggered when the certificate expires)
|
||||
|
||||
> System Page -> Alarms -> Alarm Thresholds -> New Thresholds
|
||||
|
||||
|
||||
|
||||
|
||||
> Configure the threshold, select the SSL certificate metric object, configure the alarm expression-triggered when the metric `expired` is `true`, that is, `equals(expired,"true")`, set the alarm level notification template information, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
> Associating thresholds with monitoring, in the threshold list, set which monitoring this threshold applies to.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Set the threshold (triggered one week before the certificate expires)
|
||||
|
||||
> In the same way, add a new configuration threshold and configure an alarm expression - when the metric expires timestamp `end_timestamp`, the `now()` function is the current timestamp, if the configuration triggers an alarm one week in advance: `end_timestamp <= (now( ) + 604800000)` , where `604800000` is the 7-day total time difference in milliseconds.
|
||||
|
||||
|
||||
|
||||
|
||||
> Finally, you can see the triggered alarm in the alarm center.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Alarm notification (in time notification via Dingding WeChat Feishu, etc.)
|
||||
|
||||
> Monitoring Tool -> Alarm Notification -> New Receiver
|
||||
|
||||
|
||||
|
||||
|
||||
For token configuration such as Dingding WeChat Feishu, please refer to the help document
|
||||
|
||||
@ -81,7 +81,7 @@ github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> Alarm Notification -> New Alarm Notification Policy -> Enable Notification for the Recipient Just Configured
|
||||
|
||||
|
||||
|
||||
|
||||
7. OK When the threshold is triggered, we can receive the corresponding alarm message. If there is no notification, you can also view the alarm information in the alarm center.
|
||||
|
||||
|
||||
@ -11,11 +11,11 @@ sidebar_label: Monitoring Template
|
||||
|
||||
Here is the architecture.
|
||||
|
||||
|
||||
|
||||
|
||||
**We define all monitoring collection types (mysql, website, jvm, k8s) as yml templates, and users can import these templates into the hertzbeat system to support corresponding types of monitoring, which is very convenient!**
|
||||
|
||||
|
||||
|
||||
|
||||
**Welcome everyone to contribute your customized general monitoring type YML template during use. The available templates are as follows:**
|
||||
|
||||
|
||||
@ -38,52 +38,52 @@ gitee: <https://gitee.com/hertzbeat/hertzbeat>
|
||||
|
||||
> 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置监控网站
|
||||
|
||||
> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。
|
||||
> 点击确定 注意⚠️新增前默认会先去测试网站连接性，连接成功才会新增，当然也可以把**是否测试**按钮置灰。
|
||||
|
||||
|
||||
|
||||
|
||||
3. 查看检测指标数据
|
||||
|
||||
> 在监控列表可以查看任务状态，进监控详情可以查看指标数据图表等。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4. 设置阈值(证书过期时触发)
|
||||
|
||||
> 系统页面 -> 告警 -> 告警阈值 -> 新增阈值
|
||||
|
||||
|
||||
|
||||
|
||||
> 配置阈值，选择SSL证书指标对象，配置告警表达式-当指标`expired`为`true`触发，即`equals(expired,"true")` , 设置告警级别通知模版信息等。
|
||||
|
||||
|
||||
|
||||
|
||||
> 关联阈值与监控, 在阈值列表设置此阈值应用于哪些监控。
|
||||
|
||||
|
||||
|
||||
|
||||
5. 设置阈值(证书过期前一周触发)
|
||||
|
||||
> 同理如上，新增配置阈值，配置告警表达式-当指标有效期时间戳 `end_timestamp`，`now()`函数为当前时间戳，若配置提前一周触发告警即：`end_timestamp <= (now() + 604800000)` , 其中 `604800000` 为7天总时间差毫秒值。
|
||||
|
||||
|
||||
|
||||
|
||||
> 最终可以在告警中心看到已触发的告警。
|
||||
|
||||
|
||||
|
||||
|
||||
6. 告警通知(通过钉钉微信飞书等及时通知)
|
||||
|
||||
> 监控系统 -> 告警通知 -> 新增接收人
|
||||
|
||||
|
||||
|
||||
|
||||
钉钉微信飞书等token配置可以参考帮助文档
|
||||
|
||||
@ -92,7 +92,7 @@ gitee: <https://gitee.com/hertzbeat/hertzbeat>
|
||||
|
||||
> 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知
|
||||
|
||||
|
||||
|
||||
|
||||
7. OK 当阈值触发后我们就可以收到对应告警消息啦，如果没有配通知，也可以在告警中心查看告警信息。
|
||||
|
||||
|
||||
@ -50,26 +50,26 @@ keywords: [开源监控系统, 开源数据库监控, IotDB数据库监控]
|
||||
|
||||
路径：菜单 -> 数据库监控 -> IoTDB监控 -> 新增IoTDB监控
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置监控IoTDB所需参数
|
||||
|
||||
在监控页面填写 IoTDB **服务IP**，**监控端口**(默认9091)，最后点击确定添加即可。
|
||||
其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/iotdb/) <https://hertzbeat.com/docs/help/iotdb/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. 完成✅,现在我们已经添加好对 IoTDB 的监控了，查看监控列表即可看到我们的添加项。
|
||||
|
||||
|
||||
|
||||
|
||||
4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 IoTDB的实时监控指标数据。
|
||||
|
||||
|
||||
|
||||
|
||||
5. 点击**监控历史详情TAB** 即可浏览 IoTDB的历史监控指标数据图表📈。
|
||||
|
||||
|
||||
|
||||
|
||||
**完成DONE！通过上面几步，总结起来其实也就是两步**
|
||||
|
||||
@ -89,7 +89,7 @@ keywords: [开源监控系统, 开源数据库监控, IotDB数据库监控]
|
||||
- 选择配置的指标对象，IotDB监控有非常多的指标，其中有个指标关系到节点的状态 `cluster_node_status` -> `status` (节点状态，1=online 2=offline)。
|
||||
- 这里我们就配置当此指标 `status==2` 时发出告警，告警级别为**紧急告警**，一次即触发，具体如下图。
|
||||
|
||||
|
||||
|
||||
|
||||
2. 新增消息通知接收人
|
||||
|
||||
@ -102,11 +102,11 @@ keywords: [开源监控系统, 开源数据库监控, IotDB数据库监控]
|
||||
|
||||
【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】
|
||||
|
||||
|
||||
|
||||
|
||||
3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】
|
||||
|
||||
|
||||
|
||||
|
||||
### 完毕，现在坐等告警消息过来了。叮叮叮叮
|
||||
|
||||
|
||||
@ -72,28 +72,28 @@ tags: [opensource, practice]
|
||||
|
||||
路径：菜单 -> 中间件监控 -> ShenYu监控 -> 新增ShenYu监控
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置监控 ShenYu 所需参数
|
||||
|
||||
在监控页面填写 ShenYu **服务IP**，**监控端口**(默认8090)，最后点击确定添加即可。
|
||||
其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/shenyu/) <https://hertzbeat.com/docs/help/shenyu/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. 完成✅,现在我们已经添加好对 ShenYu 的监控了，查看监控列表即可看到我们的添加项。
|
||||
|
||||
|
||||
|
||||
|
||||
4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 ShenYu 的实时监控指标数据。
|
||||
|
||||
|
||||
|
||||
|
||||
5. 点击**监控历史详情TAB** 即可浏览 ShenYu 的历史监控指标数据图表📈。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE！完成啦！通过上面几步，总结起来其实也就只用两步**
|
||||
|
||||
@ -116,7 +116,7 @@ tags: [opensource, practice]
|
||||
- 选择配置的指标对象，ShenYu 监控有非常多的指标，我们举例对 `打开的文件描述符的数量` `process_open_fds` -> `value` 这个指标进行阈值设置， 当服务端打开文件描述符数量大于3000时发出告警。
|
||||
- 这里我们就配置当此指标`process_open_fds` 的 `value>3000` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。
|
||||
|
||||
|
||||
|
||||
|
||||
2. 新增消息通知接收人
|
||||
|
||||
@ -131,13 +131,13 @@ tags: [opensource, practice]
|
||||
|
||||
【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】
|
||||
|
||||
|
||||
|
||||
|
||||
3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】
|
||||
|
||||
> 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。
|
||||
|
||||
|
||||
|
||||
|
||||
### 完毕，现在坐等告警消息过来啦。叮叮叮叮
|
||||
|
||||
|
||||
@ -84,28 +84,28 @@ tags: [opensource, practice]
|
||||
|
||||
路径：菜单 -> 中间件监控 -> DynamicTp监控 -> 新增DynamicTp监控
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置监控 DynamicTp 所需参数
|
||||
|
||||
在监控页面填写 DynamicTp **服务IP**，**监控端口**(默认8080)，最后点击确定添加即可。
|
||||
其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/dynamic_tp/) <https://hertzbeat.com/docs/help/dynamic_tp/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. 完成✅,现在我们已经添加好对 DynamicTp 的监控了，查看监控列表即可看到我们的添加项。
|
||||
|
||||
|
||||
|
||||
|
||||
4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 DynamicTp线程池 的实时监控指标数据。
|
||||
|
||||
|
||||
|
||||
|
||||
5. 点击**监控历史详情TAB** 即可浏览 DynamicTp线程池 的历史监控指标数据图表📈。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE！完成啦！通过上面几步，总结起来其实也就只用两步**
|
||||
|
||||
@ -128,7 +128,7 @@ tags: [opensource, practice]
|
||||
- 选择配置的指标对象，DynamicTp监控主要是一些线程池相关指标，我们举例对 `运行超时线程数量` `thread_pool_running` -> `run_timeout_count` 这个指标进行阈值设置， 当线程运行超时数量大于1时发出告警。
|
||||
- 这里我们就配置当此指标`thread_pool_running` 的 `run_timeout_count>1` 时发出告警，告警级别为**严重告警**，三次即触发，具体如下图。
|
||||
|
||||
|
||||
|
||||
|
||||
2. 新增消息通知接收人
|
||||
|
||||
@ -143,13 +143,13 @@ tags: [opensource, practice]
|
||||
|
||||
【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】
|
||||
|
||||
|
||||
|
||||
|
||||
3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】
|
||||
|
||||
> 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。
|
||||
|
||||
|
||||
|
||||
|
||||
### 完毕，现在坐等告警消息过来啦。叮叮叮叮
|
||||
|
||||
|
||||
@ -35,26 +35,26 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控]
|
||||
|
||||
路径：菜单 -> 数据库监控 -> Mysql数据库 -> 新增Mysql数据库监控
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置新增监控 Mysql 数据库所需参数
|
||||
|
||||
在监控页面填写 Mysql **服务IP**，**监控端口**(默认3306)，**账户密码等**，最后点击确定添加即可。
|
||||
其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/mysql/) <https://hertzbeat.com/docs/help/mysql/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. 完成✅,现在我们已经添加好对 Mysql数据库 的监控了，查看监控列表即可看到我们的添加项。
|
||||
|
||||
|
||||
|
||||
|
||||
4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 Mysql数据库 的实时监控指标数据。
|
||||
|
||||
|
||||
|
||||
|
||||
5. 点击**监控历史详情TAB** 即可浏览 Mysql数据库 的历史监控指标数据图表📈。
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE！完成啦！通过上面几步，总结起来其实也就只用一步即可**
|
||||
|
||||
@ -76,9 +76,9 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控]
|
||||
- 选择配置的指标对象，Mysql 数据库监控主要是数据库性能等相关指标，我们举例对 `查询缓存命中率` `cache` -> `query_cache_hit_rate` 这个指标进行阈值设置， 当Mysql的查询缓存命中率很低小于30%时发出告警。
|
||||
- 这里我们就配置当此指标`cache` 的 `query_cache_hit_rate<30` 时发出告警，告警级别为**严重告警**，三次即触发，具体如下图。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. 新增消息通知接收人
|
||||
|
||||
@ -93,13 +93,13 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控]
|
||||
|
||||
【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】
|
||||
|
||||
|
||||
|
||||
|
||||
3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】
|
||||
|
||||
> 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。
|
||||
|
||||
|
||||
|
||||
|
||||
### 完毕，现在坐等告警消息过来啦。叮叮叮叮
|
||||
|
||||
|
||||
@ -32,30 +32,30 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
路径：菜单 -> 操作系统监控 -> Linux操作系统 -> 新增Linux操作系统监控
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置新增监控 Linux 所需参数
|
||||
|
||||
在监控页面填写 Linux **对端IP**，**SSH端口**(默认22)，**账户密码等**，最后点击确定添加即可。
|
||||
其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 <https://hertzbeat.com/docs/help/mysql/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. 完成✅,现在我们已经添加好对 Linux 的监控了，查看监控列表即可看到我们的添加项。
|
||||
|
||||
|
||||
|
||||
|
||||
4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 Linux 的实时监控指标数据。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
5. 点击**监控历史详情TAB** 即可浏览 Linux 的历史监控指标数据图表📈。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE！完成啦！不需要我们去部署agent或者各种繁琐操作，是不是很简单**
|
||||
|
||||
@ -137,9 +137,9 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
- 选择配置的指标对象，Linux 监控主要是cpu 内存 磁盘 网络性能等相关指标，我们举例对 `CPU利用率` `cpu` -> `usage` 这个指标进行阈值设置， 当Linux cpu利用率大于90%时发出告警。
|
||||
- 这里我们就配置当此指标`cpu` 的 `usage>90` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. 新增消息通知接收人
|
||||
|
||||
@ -154,13 +154,13 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】
|
||||
|
||||
|
||||
|
||||
|
||||
3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】
|
||||
|
||||
> 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。
|
||||
|
||||
|
||||
|
||||
|
||||
### 完毕，现在坐等告警消息过来啦。叮叮叮叮
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ keywords: [开源监控系统, 告警系统, Linux监控]
|
||||
|
||||
官网: hertzbeat.com | tancloud.cn
|
||||
|
||||
|
||||
|
||||
|
||||
### What is HertzBeat?
|
||||
|
||||
@ -22,7 +22,7 @@ keywords: [开源监控系统, 告警系统, Linux监控]
|
||||
>
|
||||
> 您相信只需定义YML就能立刻适配一款K8s或Docker等新的监控类型吗？
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
@ -34,7 +34,7 @@ keywords: [开源监控系统, 告警系统, Linux监控]
|
||||
|
||||
- **支持在浏览器页面自定义监控**。hertzbeat拥有强大自定义监控能力，我们所有的已支持监控类型都映射为一个YML，之前用户使用自定义监控功能适配指标需要在后台编写YML文件并重启，体验欠佳且没有直观的感受。这次我们带来了自定义监控页面化，欢迎大家使用和分享贡献自己的监控类型定义。
|
||||
|
||||
|
||||
|
||||
|
||||
- **支持对网络交换机的监控**。hertzbeat很早之前就支持了snmp协议，windows监控就是通过snmp协议来监控的，这个版本我们不仅支持了更多windows性能指标，还支持了snmp walk，适配了几款常见网络交换机的监控，欢迎贡献更多类型与指标给社区。
|
||||
|
||||
|
||||
@ -85,26 +85,26 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
路径：菜单 -> 应用服务监控 -> SpringBoot2 -> 新增SpringBoot2监控
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置新增监控 SpringBoot2 所需参数
|
||||
|
||||
在监控页面填写 SpringBoot2应用 **对端IP**，**服务端口**(默认8080)，**账户密码等**，最后点击确定添加即可。
|
||||
其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 <https://hertzbeat.com/docs/help/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. 完成✅,现在我们已经添加好对 SpringBoot2应用 的监控了，查看监控列表即可看到我们的添加项。
|
||||
|
||||
|
||||
|
||||
|
||||
4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 SpringBoot2应用 的实时监控指标数据。
|
||||
|
||||
|
||||
|
||||
|
||||
5. 点击**监控历史详情TAB** 即可浏览 SpringBoot2应用 的历史监控指标数据图表📈。
|
||||
|
||||
|
||||
|
||||
|
||||
**DONE！完成啦！不需要我们去部署agent或者各种繁琐操作，是不是很简单**
|
||||
|
||||
@ -126,9 +126,9 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
- 选择配置的指标对象，SpringBoot2应用 监控主要是 堆栈内存 线程等相关指标，我们举例对 `状态线程数` `threads` -> `threads` 这个指标进行阈值设置， 当`runnable`状态的线程数量大于300时发出告警。
|
||||
- 这里我们就配置当此指标`size`,`state` 的 `equals(state,"runnable"") && size>300` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. 新增消息通知接收人
|
||||
|
||||
@ -143,13 +143,13 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】
|
||||
|
||||
|
||||
|
||||
|
||||
3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】
|
||||
|
||||
> 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。
|
||||
|
||||
|
||||
|
||||
|
||||
### 完毕，现在坐等告警消息过来啦。叮叮叮叮
|
||||
|
||||
@ -177,7 +177,7 @@ Github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> 通过上面的简单步骤我们实现了对SpringBoot2的监控，但里面的内置指标固定不满足需要，是否能自定义监控更多SpringBoot2的指标呢？答案当然是可以的，通过在页面上的**监控定义**->**SpringBoot2**随时通过编辑如下的YML配置文件自定义添加修改想要监控的性能指标。
|
||||
|
||||
|
||||
|
||||
|
||||
## What is HertzBeat?
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
|
||||
官网: hertzbeat.com | tancloud.cn
|
||||
|
||||
|
||||
|
||||
|
||||
### What is HertzBeat?
|
||||
|
||||
@ -22,7 +22,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
>
|
||||
> 您相信只需定义YML就能立刻适配一款K8s或Docker等新的监控类型吗？
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
>
|
||||
> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需配置`YML`就能使用这些协议去自定义采集任何您想要的指标。
|
||||
|
||||
|
||||
|
||||
|
||||
**Github: <https://github.com/apache/hertzbeat>**
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。
|
||||
- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。
|
||||
|
||||
|
||||
|
||||
|
||||
#### 云边协同
|
||||
|
||||
@ -53,7 +53,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring]
|
||||
HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采集器，添加监控时指定采集器，采集器在隔离网络内部进行监控任务采集，采集数据上报，由主 HertzBeat 服务统一调度管理展示。
|
||||
这多用于多个隔离数据中心或不同厂商云资源和云下资源的统一监控场景。
|
||||
|
||||
|
||||
|
||||
|
||||
### 为什么要开源集群版?
|
||||
|
||||
|
||||
@ -12,9 +12,9 @@ keywords: [open source monitoring system, alerting system]
|
||||
|
||||
HertzBeat 于 2022 年 1 月在 Dromara 开源社区正式开源，经过两年多的社区小伙伴们的不间断项目维护迭代，持续的社区成长，现在，HertzBeat 正式官宣加入 Apache 孵化器！
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
加入 Apache 孵化器不是终点，这是项目的全新起点。加入 Apache 孵化器后，在社区层面，HertzBeat 将积极践行『开放、协作』 的 Apache 之道，持续构建一个公平，多元，包容的开源社区。在开源产品层面，倾听用户声音，提升优化产品使用体验，打造对接开源生态。
|
||||
|
||||
|
||||
@ -188,19 +188,19 @@ metrics:
|
||||
|
||||
**新增完毕，现在我们重启hertzbeat系统。我们可以看到系统页面已经多了一个`hertzbeat`监控类型了。**
|
||||
|
||||
|
||||
|
||||
|
||||
### 系统页面添加对`hertzbeat`监控类型的监控
|
||||
|
||||
> 我们点击新增 `HertzBeat监控系统`，配置监控IP，端口，采集周期，高级设置里的账户密码等, 点击确定添加监控。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 过一定时间(取决于采集周期)我们就可以在监控详情看到具体的指标数据和历史图表啦！
|
||||
|
||||
|
||||
|
||||
|
||||
### 设置阈值告警通知
|
||||
|
||||
|
||||
@ -221,13 +221,13 @@ metrics:
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
**新增成功后我们就可以在详情页面看到我们采集的 `token`, `refreshToken`指标数据。**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 将`token`作为变量参数给后面的监控指标采集使用
|
||||
|
||||
@ -381,9 +381,9 @@ metrics:
|
||||
|
||||
**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 设置阈值告警通知
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -57,7 +57,7 @@ SQL响应数据：
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ sidebar_label: JMX协议自定义监控
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -71,7 +71,7 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ sidebar_label: 自定义监控
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -23,4 +23,4 @@ HertzBeat页面 -> 应用服务监控 -> 推送方式监控 -> 新建推送方
|
||||
|
||||
### 监控配置示例
|
||||
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ sidebar_label: SNMP协议自定义监控
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -69,7 +69,7 @@ total used free buff_cache available
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ sidebar_label: Telnet协议自定义监控
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -227,19 +227,19 @@ metrics:
|
||||
|
||||
**点击保存并应用。我们可以看到系统页面的自定义监控菜单已经多了一个`hertzbeat`监控类型了。**
|
||||
|
||||
|
||||
|
||||
|
||||
### 页面添加对`hertzbeat`监控类型的监控
|
||||
|
||||
> 我们点击新增 `HertzBeat监控系统`，配置监控IP，端口，采集周期，高级设置里的账户密码等, 点击确定添加监控。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 过一定时间(取决于采集周期)我们就可以在监控详情看到具体的指标数据和历史图表啦！
|
||||
|
||||
|
||||
|
||||
|
||||
### 设置阈值告警通知
|
||||
|
||||
|
||||
@ -352,15 +352,15 @@ hi, i accept. Thanks for invitaion.
|
||||
|
||||
找到`CLAs`点击进入页面
|
||||
|
||||
|
||||
|
||||
|
||||
找到`ICLA(个人贡献者许可协议)`，点击[Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf)
|
||||
|
||||
|
||||
|
||||
|
||||
跳转后，会显示需要签署的协议，这里可以在网页上直接填写，也可以下载后填写。
|
||||
|
||||
|
||||
|
||||
|
||||
2. 填写iCLA
|
||||
|
||||
@ -368,8 +368,8 @@ hi, i accept. Thanks for invitaion.
|
||||
|
||||
需要填写的内容：
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
在PDF中需要填写的字段：
|
||||
|
||||
@ -383,12 +383,12 @@ hi, i accept. Thanks for invitaion.
|
||||
- `Date`
|
||||
|
||||
> 填写样例
|
||||
> 
|
||||
> 
|
||||
> 
|
||||
> 
|
||||
|
||||
3. 打印并签署
|
||||
|
||||
|
||||
|
||||
|
||||
`Please sign`字段需要将文件打印出来然后手写签名，内容为自己姓名的全拼。
|
||||
|
||||
@ -420,7 +420,7 @@ hi, i accept. Thanks for invitaion.
|
||||
|
||||
在网站 [https://id.apache.org/reset/enter](https://id.apache.org/reset/enter) 输入您的Apache ID
|
||||
|
||||
|
||||
|
||||
|
||||
点击`Send Email`后会提示发送成功。
|
||||
|
||||
@ -434,44 +434,44 @@ hi, i accept. Thanks for invitaion.
|
||||
|
||||
登录后可以看到这个内容`Link GitHub username to ASF id`，点击跳转
|
||||
|
||||
|
||||
|
||||
|
||||
输入您的Apache的账号和密码并登录
|
||||
|
||||
|
||||
|
||||
|
||||
点击 `Authenticate with GitHub`
|
||||
|
||||
|
||||
|
||||
|
||||
点击`Authorize apache`授权给Apache
|
||||
|
||||
|
||||
|
||||
|
||||
点击`Send GitHub Invitation!` 发送GitHub邀请邮件
|
||||
|
||||
|
||||
|
||||
|
||||
邮箱中会收到一封邮件，点击`Join @apache`
|
||||
|
||||
> 这里邮箱指的是您提供给PMC的那个邮箱地址
|
||||
|
||||
|
||||
|
||||
|
||||
点击`Join The Apache Software Foundation`，加入GitHub加入Apache组织，会自动跳转到GitHub页面
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
回到Apache页面，提示GitHub启用多重身份认证，在GitHub页面启用双重身份认证
|
||||
|
||||
> GitHub双重身份认证介绍，[点击跳转官方文档](https://docs.github.com/zh/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)
|
||||
|
||||
|
||||
|
||||
|
||||
启动完成之后等几分钟，提示已经绑定完成
|
||||
|
||||
|
||||
|
||||
|
||||
至此您的GitHub账号与Apache账号就绑定完成了。
|
||||
|
||||
@ -485,17 +485,17 @@ hi, i accept. Thanks for invitaion.
|
||||
|
||||
进入设置页面，并点击`添加其他电子邮件地址``
|
||||
|
||||
|
||||
|
||||
|
||||
填写您的apache邮箱，按照指引点击下一步
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
设置为默认发送邮箱(可选)
|
||||
|
||||
|
||||
|
||||
|
||||
配置完成。
|
||||
|
||||
|
||||
@ -155,11 +155,11 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监
|
||||
|
||||
添加监控节点时填入所需要的参数.
|
||||
|
||||
|
||||
|
||||
|
||||
最终的效果.
|
||||
|
||||
|
||||
|
||||
|
||||
### Configuration Parameters
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ keywords: [开源监控系统, 开源网站监控, 状态页面]
|
||||
|
||||
填写完组织信息后，点击 `确定`。
|
||||
|
||||
|
||||
|
||||
|
||||
## 2. 新增组件
|
||||
|
||||
@ -51,7 +51,7 @@ status:
|
||||
interval: 60
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## 3. 维护事件
|
||||
|
||||
@ -59,7 +59,7 @@ status:
|
||||
|
||||
点击 `发布事件`
|
||||
|
||||
|
||||
|
||||
|
||||
| 字段名称 | 字段说明 | 举例 |
|
||||
|------|---------------------------------------------|----------------------------------------------------------------------|
|
||||
@ -70,4 +70,4 @@ status:
|
||||
|
||||
> 提示：可以多次发布消息，及时向团队汇报当前状态。
|
||||
|
||||
|
||||
|
||||
|
||||
@ -41,11 +41,11 @@ slug: /
|
||||
HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。
|
||||
HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标数据。
|
||||
|
||||
|
||||
|
||||
|
||||
你相信用户只需在UI页面编写一个监控模版，点击保存后，就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？
|
||||
|
||||
|
||||
|
||||
|
||||
### 内置监控类型
|
||||
|
||||
@ -96,7 +96,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可
|
||||
> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。
|
||||
> 模版里面包含各个协议的使用配置，环境变量，指标转换，指标计算，单位转换，指标采集等一系列功能，帮助用户能采集到自己想要的监控指标。
|
||||
|
||||
|
||||
|
||||
|
||||
### 无需 Agent
|
||||
|
||||
@ -118,7 +118,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可
|
||||
- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。
|
||||
- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。
|
||||
|
||||
|
||||
|
||||
|
||||
### 云边协同
|
||||
|
||||
@ -129,7 +129,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可
|
||||
在多个网络不相通的隔离网络中，在以往方案中我们需要在每个网络都部署一套监控系统，这导致数据不互通，管理部署维护都不方便。
|
||||
`HertzBeat` 提供的云边协同能力，可以在多个隔离网络部署边缘采集器，采集器在隔离网络内部进行监控任务采集，采集数据上报，由主服务统一调度管理展示。
|
||||
|
||||
|
||||
|
||||
|
||||
### 易用友好
|
||||
|
||||
@ -164,7 +164,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
|
||||
- HertzBeat 的用户管理统一由配置文件 `sureness.yml` 维护，用户可以通过修改此文件来新增删除修改用户信息，用户角色权限等。默认账户密码 admin/hertzbeat
|
||||
|
||||
|
||||
|
||||
|
||||
### 概览页面
|
||||
|
||||
@ -172,7 +172,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 展示当前注册的采集器集群状态，包括采集器的上线状态，监控任务，启动时间，IP地址，名称等。
|
||||
- 下发展示了最近告警信息列表，告警级别分布情况，告警处理率情况。
|
||||
|
||||
|
||||
|
||||
|
||||
### 监控中心
|
||||
|
||||
@ -219,7 +219,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
[HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml),
|
||||
[H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
|
||||
|
||||
|
||||
|
||||
|
||||
### 新增修改监控
|
||||
|
||||
@ -227,7 +227,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 页面上配置的监控参数由对应监控类型的监控模版所定义，用户可以通过修改监控模版来修改页面配置参数。
|
||||
- 支持关联标签，用标签来管理监控分组，告警匹配等。
|
||||
|
||||
|
||||
|
||||
|
||||
### 监控详情
|
||||
|
||||
@ -236,16 +236,16 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 监控历史数据报告，以趋势图表的形式展示了当前监控数值类型的指标的历史值，支持查询小时，天，月的历史数据，支持配置页面刷新时间。
|
||||
- ⚠️注意监控历史图表需配置外置时序数据库才能获取完整功能，时序数据库支持: IOTDB, TDengine, InfluxDB, GreptimeDB
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 告警中心
|
||||
|
||||
- 已触发告警消息的管理展示页面，使用户有直观的展示当前告警情况。
|
||||
- 支持告警处理，告警标记未处理，告警删除清空等批量操作。
|
||||
|
||||
|
||||
|
||||
|
||||
### 阈值规则
|
||||
|
||||
@ -254,18 +254,18 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 阈值规则支持可视化页面配置或表达式规则配置，灵活性更高。
|
||||
- 支持配置触发次数，告警级别，通知模版，关联指定监控等。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 告警收敛
|
||||
|
||||
- 当通过阈值规则判断触发告警后，会进入到告警收敛，告警收敛会根据规则对特定时间段的重复告警消息去重收敛，已避免大量重复性告警导致接收人告警麻木。
|
||||
- 告警收敛规则支持重复告警生效时间段，标签匹配和告警级别匹配过滤。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 告警静默
|
||||
|
||||
@ -273,9 +273,9 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 此应用场景如用户在系统维护中，无需发已知告警。用户在工作日时间才会接收告警消息，用户在晚上需避免打扰等。
|
||||
- 告警静默规则支持一次性时间段或周期性时间段，支持标签匹配和告警级别匹配。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 消息通知
|
||||
|
||||
@ -285,18 +285,18 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 通知策略支持标签匹配和告警级别匹配，方便的使不同标签的告警和告警级别分派给不同的接收处理人。
|
||||
- 支持通知模版，用户可以自定义通过模版内容格式来满足自己的个性化通知展示需求。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 监控模版
|
||||
|
||||
- HertzBeat 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？
|
||||
- 同理我们内置的所有监控类型(mysql,website,jvm,k8s)也一一映射为对应的监控模版，用户可以新增修改监控模版来自定义监控功能。
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@ HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数
|
||||
通过部署多个 HertzBeat Collector 可以实现数据的高可用，负载均衡和云边协同。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
1. 执行以下命令
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数
|
||||
通过部署多个 HertzBeat Collector 可以实现数据的高可用，负载均衡和云边协同。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
1. 下载安装包
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ sidebar_label: Rainbond方式部署
|
||||
|
||||
登录 Rainbond 后，点击左侧菜单中的 `应用市场`，切换到开源应用商店，在搜索框中搜索 `HertzBeat`，点击安装按钮。
|
||||
|
||||
|
||||
|
||||
|
||||
填写以下信息，然后点击确认按钮进行安装。
|
||||
|
||||
@ -25,7 +25,7 @@ sidebar_label: Rainbond方式部署
|
||||
|
||||
等待安装完成，即可访问 HertzBeat 应用。
|
||||
|
||||
|
||||
|
||||
|
||||
:::tip
|
||||
通过 Rainbond 安装的 HertzBeat，默认使用了外部的 Mysql 数据库 和 Redis 以及 IoTDB。同时也挂载了 HertzBeat 的配置文件，可以在 `组件 -> 环境配置 -> 配置文件设置` 中修改配置文件。
|
||||
|
||||
@ -28,7 +28,7 @@ github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置监控网站
|
||||
|
||||
@ -36,45 +36,45 @@ github: <https://github.com/apache/hertzbeat>
|
||||
>
|
||||
> 点击确定 注意⚠️新增前默认会先去测试网站连接性，连接成功才会新增，当然也可以把**是否测试**按钮置灰。
|
||||
|
||||
|
||||
|
||||
|
||||
3. 查看检测指标数据
|
||||
|
||||
> 在监控列表可以查看任务状态，进监控详情可以查看指标数据图表等。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4. 设置阈值(证书过期时触发)
|
||||
|
||||
> 系统页面 -> 告警 -> 告警阈值 -> 新增阈值
|
||||
|
||||
|
||||
|
||||
|
||||
> 配置阈值，选择SSL证书指标对象，配置告警表达式-当指标`expired`为`true`触发，即`equals(expired,"true")` , 设置告警级别通知模版信息等。
|
||||
|
||||
|
||||
|
||||
|
||||
> 关联阈值与监控, 在阈值列表设置此阈值应用于哪些监控。
|
||||
|
||||
|
||||
|
||||
|
||||
5. 设置阈值(证书过期前一周触发)
|
||||
|
||||
> 同理如上，新增配置阈值，配置告警表达式-当指标有效期时间戳 `end_timestamp`，`now()`函数为当前时间戳，若配置提前一周触发告警即：`end_timestamp <= (now() + 604800000)` , 其中 `604800000` 为7天总时间差毫秒值。
|
||||
|
||||
|
||||
|
||||
|
||||
> 最终可以在告警中心看到已触发的告警。
|
||||
|
||||
|
||||
|
||||
|
||||
6. 告警通知(通过钉钉微信飞书等及时通知)
|
||||
|
||||
> 监控系统 -> 告警通知 -> 新增接收人
|
||||
|
||||
|
||||
|
||||
|
||||
钉钉微信飞书等token配置可以参考帮助文档
|
||||
|
||||
@ -83,7 +83,7 @@ github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知
|
||||
|
||||
|
||||
|
||||
|
||||
7. OK 当阈值触发后我们就可以收到对应告警消息啦，如果没有配通知，也可以在告警中心查看告警信息。
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ sidebar_label: 监控模版
|
||||
|
||||
**我们将所有监控采集类型(mysql,website,jvm,k8s)都定义为yml模版，用户可以导入这些模版到hertzbeat系统中，使其支持对应类型的监控，非常方便！**
|
||||
|
||||
|
||||
|
||||
|
||||
**欢迎大家一起贡献你使用过程中自定义的通用监控类型YML模版，可用的模板如下:**
|
||||
|
||||
|
||||
@ -186,19 +186,19 @@ metrics:
|
||||
|
||||
**新增完毕，现在我们重启hertzbeat系统。我们可以看到系统页面已经多了一个`hertzbeat`监控类型了。**
|
||||
|
||||
|
||||
|
||||
|
||||
### 系统页面添加对`hertzbeat`监控类型的监控
|
||||
|
||||
> 我们点击新增 `HertzBeat监控系统`，配置监控IP，端口，采集周期，高级设置里的账户密码等, 点击确定添加监控。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 过一定时间(取决于采集周期)我们就可以在监控详情看到具体的指标数据和历史图表啦！
|
||||
|
||||
|
||||
|
||||
|
||||
### 设置阈值告警通知
|
||||
|
||||
|
||||
@ -205,13 +205,13 @@ metrics:
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
**新增成功后我们就可以在详情页面看到我们采集的 `token`, `refreshToken`指标数据。**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 将`token`作为变量参数给后面的监控指标采集使用
|
||||
|
||||
@ -368,9 +368,9 @@ metrics:
|
||||
|
||||
**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 设置阈值告警通知
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -57,7 +57,7 @@ SQL响应数据：
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ sidebar_label: JMX协议自定义监控
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -71,7 +71,7 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ sidebar_label: 自定义监控
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -23,4 +23,4 @@ HertzBeat页面 -> 应用服务监控 -> 推送方式监控 -> 新建推送方
|
||||
|
||||
### 监控配置示例
|
||||
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ sidebar_label: SNMP协议自定义监控
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -69,7 +69,7 @@ total used free buff_cache available
|
||||
|
||||
**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -219,19 +219,19 @@ metrics:
|
||||
|
||||
**点击保存并应用。我们可以看到系统页面的自定义监控菜单已经多了一个`hertzbeat`监控类型了。**
|
||||
|
||||
|
||||
|
||||
|
||||
### 页面添加对`hertzbeat`监控类型的监控
|
||||
|
||||
> 我们点击新增 `HertzBeat监控系统`，配置监控IP，端口，采集周期，高级设置里的账户密码等, 点击确定添加监控。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 过一定时间(取决于采集周期)我们就可以在监控详情看到具体的指标数据和历史图表啦！
|
||||
|
||||
|
||||
|
||||
|
||||
### 设置阈值告警通知
|
||||
|
||||
|
||||
@ -41,11 +41,11 @@ slug: /
|
||||
HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。
|
||||
HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标数据。
|
||||
|
||||
|
||||
|
||||
|
||||
你相信用户只需在UI页面编写一个监控模版，点击保存后，就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？
|
||||
|
||||
|
||||
|
||||
|
||||
### 内置监控类型
|
||||
|
||||
@ -96,7 +96,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可
|
||||
> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。
|
||||
> 模版里面包含各个协议的使用配置，环境变量，指标转换，指标计算，单位转换，指标采集等一系列功能，帮助用户能采集到自己想要的监控指标。
|
||||
|
||||
|
||||
|
||||
|
||||
### 无需 Agent
|
||||
|
||||
@ -118,7 +118,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可
|
||||
- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。
|
||||
- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。
|
||||
|
||||
|
||||
|
||||
|
||||
### 云边协同
|
||||
|
||||
@ -129,7 +129,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可
|
||||
在多个网络不相通的隔离网络中，在以往方案中我们需要在每个网络都部署一套监控系统，这导致数据不互通，管理部署维护都不方便。
|
||||
`HertzBeat` 提供的云边协同能力，可以在多个隔离网络部署边缘采集器，采集器在隔离网络内部进行监控任务采集，采集数据上报，由主服务统一调度管理展示。
|
||||
|
||||
|
||||
|
||||
|
||||
### 易用友好
|
||||
|
||||
@ -164,7 +164,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
|
||||
- HertzBeat 的用户管理统一由配置文件 `sureness.yml` 维护，用户可以通过修改此文件来新增删除修改用户信息，用户角色权限等。默认账户密码 admin/hertzbeat
|
||||
|
||||
|
||||
|
||||
|
||||
### 概览页面
|
||||
|
||||
@ -172,7 +172,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 展示当前注册的采集器集群状态，包括采集器的上线状态，监控任务，启动时间，IP地址，名称等。
|
||||
- 下发展示了最近告警信息列表，告警级别分布情况，告警处理率情况。
|
||||
|
||||
|
||||
|
||||
|
||||
### 监控中心
|
||||
|
||||
@ -219,7 +219,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
[HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml),
|
||||
[H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
|
||||
|
||||
|
||||
|
||||
|
||||
### 新增修改监控
|
||||
|
||||
@ -227,7 +227,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 页面上配置的监控参数由对应监控类型的监控模版所定义，用户可以通过修改监控模版来修改页面配置参数。
|
||||
- 支持关联标签，用标签来管理监控分组，告警匹配等。
|
||||
|
||||
|
||||
|
||||
|
||||
### 监控详情
|
||||
|
||||
@ -236,16 +236,16 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 监控历史数据报告，以趋势图表的形式展示了当前监控数值类型的指标的历史值，支持查询小时，天，月的历史数据，支持配置页面刷新时间。
|
||||
- ⚠️注意监控历史图表需配置外置时序数据库才能获取完整功能，时序数据库支持: IOTDB, TDengine, InfluxDB, GreptimeDB
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 告警中心
|
||||
|
||||
- 已触发告警消息的管理展示页面，使用户有直观的展示当前告警情况。
|
||||
- 支持告警处理，告警标记未处理，告警删除清空等批量操作。
|
||||
|
||||
|
||||
|
||||
|
||||
### 阈值规则
|
||||
|
||||
@ -254,18 +254,18 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 阈值规则支持可视化页面配置或表达式规则配置，灵活性更高。
|
||||
- 支持配置触发次数，告警级别，通知模版，关联指定监控等。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 告警收敛
|
||||
|
||||
- 当通过阈值规则判断触发告警后，会进入到告警收敛，告警收敛会根据规则对特定时间段的重复告警消息去重收敛，已避免大量重复性告警导致接收人告警麻木。
|
||||
- 告警收敛规则支持重复告警生效时间段，标签匹配和告警级别匹配过滤。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 告警静默
|
||||
|
||||
@ -273,9 +273,9 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 此应用场景如用户在系统维护中，无需发已知告警。用户在工作日时间才会接收告警消息，用户在晚上需避免打扰等。
|
||||
- 告警静默规则支持一次性时间段或周期性时间段，支持标签匹配和告警级别匹配。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 消息通知
|
||||
|
||||
@ -285,18 +285,18 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1
|
||||
- 通知策略支持标签匹配和告警级别匹配，方便的使不同标签的告警和告警级别分派给不同的接收处理人。
|
||||
- 支持通知模版，用户可以自定义通过模版内容格式来满足自己的个性化通知展示需求。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 监控模版
|
||||
|
||||
- HertzBeat 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？
|
||||
- 同理我们内置的所有监控类型(mysql,website,jvm,k8s)也一一映射为对应的监控模版，用户可以新增修改监控模版来自定义监控功能。
|
||||
|
||||
|
||||
|
||||
|
||||
----
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ sidebar_label: Rainbond方式部署
|
||||
|
||||
登录 Rainbond 后，点击左侧菜单中的 `应用市场`，切换到开源应用商店，在搜索框中搜索 `HertzBeat`，点击安装按钮。
|
||||
|
||||
|
||||
|
||||
|
||||
填写以下信息，然后点击确认按钮进行安装。
|
||||
|
||||
@ -25,7 +25,7 @@ sidebar_label: Rainbond方式部署
|
||||
|
||||
等待安装完成，即可访问 HertzBeat 应用。
|
||||
|
||||
|
||||
|
||||
|
||||
:::tip
|
||||
通过 Rainbond 安装的 HertzBeat，默认使用了外部的 Mysql 数据库 和 Redis 以及 IoTDB。同时也挂载了 HertzBeat 的配置文件，可以在 `组件 -> 环境配置 -> 配置文件设置` 中修改配置文件。
|
||||
|
||||
@ -28,52 +28,52 @@ github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书
|
||||
|
||||
|
||||
|
||||
|
||||
2. 配置监控网站
|
||||
|
||||
> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。
|
||||
> 点击确定 注意⚠️新增前默认会先去测试网站连接性，连接成功才会新增，当然也可以把**是否测试**按钮置灰。
|
||||
|
||||
|
||||
|
||||
|
||||
3. 查看检测指标数据
|
||||
|
||||
> 在监控列表可以查看任务状态，进监控详情可以查看指标数据图表等。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4. 设置阈值(证书过期时触发)
|
||||
|
||||
> 系统页面 -> 告警 -> 告警阈值 -> 新增阈值
|
||||
|
||||
|
||||
|
||||
|
||||
> 配置阈值，选择SSL证书指标对象，配置告警表达式-当指标`expired`为`true`触发，即`equals(expired,"true")` , 设置告警级别通知模版信息等。
|
||||
|
||||
|
||||
|
||||
|
||||
> 关联阈值与监控, 在阈值列表设置此阈值应用于哪些监控。
|
||||
|
||||
|
||||
|
||||
|
||||
5. 设置阈值(证书过期前一周触发)
|
||||
|
||||
> 同理如上，新增配置阈值，配置告警表达式-当指标有效期时间戳 `end_timestamp`，`now()`函数为当前时间戳，若配置提前一周触发告警即：`end_timestamp <= (now() + 604800000)` , 其中 `604800000` 为7天总时间差毫秒值。
|
||||
|
||||
|
||||
|
||||
|
||||
> 最终可以在告警中心看到已触发的告警。
|
||||
|
||||
|
||||
|
||||
|
||||
6. 告警通知(通过钉钉微信飞书等及时通知)
|
||||
|
||||
> 监控系统 -> 告警通知 -> 新增接收人
|
||||
|
||||
|
||||
|
||||
|
||||
钉钉微信飞书等token配置可以参考帮助文档
|
||||
|
||||
@ -82,7 +82,7 @@ github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知
|
||||
|
||||
|
||||
|
||||
|
||||
7. OK 当阈值触发后我们就可以收到对应告警消息啦，如果没有配通知，也可以在告警中心查看告警信息。
|
||||
|
||||
|
||||
@ -11,11 +11,11 @@ sidebar_label: 监控模版
|
||||
|
||||
这是它的架构原理:
|
||||
|
||||
|
||||
|
||||
|
||||
**我们将所有监控采集类型(mysql,website,jvm,k8s)都定义为yml模版，用户可以导入这些模版到hertzbeat系统中，使其支持对应类型的监控，非常方便！**
|
||||
|
||||
|
||||
|
||||
|
||||
**欢迎大家一起贡献你使用过程中自定义的通用监控类型YML模版，可用的模板如下:**
|
||||
|
||||
|
||||
@ -196,19 +196,19 @@ metrics:
|
||||
|
||||
**The addition is complete, now we save and apply. We can see that the system page has added a `hertzbeat` monitoring type.**
|
||||
|
||||
|
||||
|
||||
|
||||
### The system page adds the monitoring of `hertzbeat` monitoring type
|
||||
|
||||
> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details!
|
||||
|
||||
|
||||
|
||||
|
||||
### Set threshold alarm notification
|
||||
|
||||
|
||||
@ -211,13 +211,13 @@ metrics:
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
**After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Use `token` as a variable parameter to collect and use the following metricss
|
||||
|
||||
@ -372,9 +372,9 @@ metrics:
|
||||
|
||||
**After the configuration is complete, save and apply, and check the monitoring details page**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Set threshold alarm notification
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ By configuring the monitoring template YML metrics `field`, `aliasFields`, `obje
|
||||
|
||||
**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -23,4 +23,4 @@ HertzBeat DashBoard -> Service Monitor -> Push Style Monitor -> New Push Style M
|
||||
|
||||
### Monitor Configuration Example
|
||||
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` p
|
||||
|
||||
**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
|
||||
|
||||
|
||||
|
||||
|
||||
-------
|
||||
|
||||
|
||||
@ -195,19 +195,19 @@ metrics:
|
||||
|
||||
**The addition is complete, now we restart the hertzbeat system. We can see that the system page has added a `hertzbeat` monitoring type.**
|
||||
|
||||
|
||||
|
||||
|
||||
### The system page adds the monitoring of `hertzbeat` monitoring type
|
||||
|
||||
> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details!
|
||||
|
||||
|
||||
|
||||
|
||||
### Set threshold alarm notification
|
||||
|
||||
|
||||
@ -42,11 +42,11 @@ slug: /
|
||||
|
||||
HertzBeat itself did not create a data collection protocol for the monitoring client to adapt to. Instead, HertzBeat makes full use of the existing ecosystem, `SNMP protocol` to collect information from network switches and routers, `JMX specification` to collect information from Java applications, `JDBC specification` to collect information from datasets, `SSH` to directly connect to scripts to get the display information, `HTTP+ (JsonPath | prometheus, etc.)` to parse the information from API interfaces, `IPMI protocol` to collect server information, and so on.
|
||||
HertzBeat uses these existing standard protocols or specifications, makes them abstractly configurable, and finally makes them all available in the form of YML format monitoring templates that can be written to create templates that use these protocols to collect any desired metrics data.
|
||||
|
||||
|
||||
|
||||
Do you believe that users can just write a monitoring template on the UI page, click save and immediately adapt a new monitoring type like `K8s` or `Docker`?
|
||||
|
||||
|
||||
|
||||
|
||||
### Built-in Monitoring Types
|
||||
|
||||
@ -97,7 +97,7 @@ Do you believe that users can just write a monitoring template on the UI page, c
|
||||
> Each monitor type is considered as a monitor template, no matter it is built-in or user-defined. You can easily add, modify and delete indicators by modifying the monitoring template.
|
||||
> The templates contain a series of functions such as protocol configuration, environment variables, metrics conversion, metrics calculation, units conversion, metrics collection, etc., which help users to collect the metrics they want.
|
||||
|
||||
|
||||
|
||||
|
||||
### No Agent Required
|
||||
|
||||
@ -120,7 +120,7 @@ The principle of `HertzBeat` is to use different protocols to connect directly t
|
||||
* Monitoring tasks are self-scheduled in the collector cluster, single collector hangs without sensing the failure to migrate the collection tasks, and the newly added collector nodes are automatically scheduled to share the collection pressure.
|
||||
* It is very easy to switch between stand-alone mode and cluster mode without additional component deployment.
|
||||
|
||||
|
||||
|
||||
|
||||
### Cloud Edge Collaboration
|
||||
|
||||
@ -129,7 +129,7 @@ The principle of `HertzBeat` is to use different protocols to connect directly t
|
||||
In an isolated network where multiple networks are not connected, we need to deploy a monitoring system in each network in the previous solution, which leads to data non-interoperability and inconvenient management, deployment and maintenance.
|
||||
`HertzBeat` provides the ability of cloud edge collaboration, can be deployed in multiple isolated networks edge collector, collector in the isolated network within the monitoring task collection, collection of data reported by the main service unified scheduling management display.
|
||||
|
||||
|
||||
|
||||
|
||||
### Easy to Use
|
||||
|
||||
@ -165,7 +165,7 @@ Browser access `http://localhost:1157` default account password `admin/hertzbeat
|
||||
|
||||
* HertzBeat's user management is unified by the configuration file `sureness.yml`, which allows users to add, delete, and modify user information, user role permissions, and so on. Default password admin/hertzbeat
|
||||
|
||||
|
||||
|
||||
|
||||
### Overview Page
|
||||
|
||||
@ -173,7 +173,7 @@ Browser access `http://localhost:1157` default account password `admin/hertzbeat
|
||||
* Show the status of currently registered collector clusters, including collector on-line status, monitoring tasks, startup time, IP address, name and so on.
|
||||
* Show the list of recent alarm messages, alarm level distribution and alarm processing rate.
|
||||
|
||||
|
||||
|
||||
|
||||
### Monitoring Center
|
||||
|
||||
@ -220,7 +220,7 @@ Built-in support for monitoring types include:
|
||||
[HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml),
|
||||
[H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
|
||||
|
||||
|
||||
|
||||
|
||||
### Add and Modify Surveillance
|
||||
|
||||
@ -228,7 +228,7 @@ Built-in support for monitoring types include:
|
||||
* The monitoring parameters configured on the page are defined by the monitoring template of the corresponding monitoring type, and users can modify the configuration parameters on the page by modifying the monitoring template.
|
||||
* Support associated tags to manage monitoring grouping, alarm matching, and so on.
|
||||
|
||||
|
||||
|
||||
|
||||
### Monitor Details
|
||||
|
||||
@ -237,16 +237,16 @@ Built-in support for monitoring types include:
|
||||
* Monitor Historical Data Report displays the historical values of the currently monitored metrics in the form of trend charts, supports querying hourly, daily and monthly historical data, and supports configuring the page refresh time.
|
||||
* ⚠️ Note that the monitoring history charts need to be configured with an external timing database in order to get the full functionality, timing database support: IOTDB, TDengine, InfluxDB, GreptimeDB
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Alarm Center
|
||||
|
||||
* The management display page of triggered alarm messages enables users to visualize the current alarm situation.
|
||||
* Support alarm processing, alarm marking unprocessed, alarm deletion, clearing and other batch operations.
|
||||
|
||||
|
||||
|
||||
|
||||
### Threshold Rules
|
||||
|
||||
@ -255,18 +255,18 @@ Built-in support for monitoring types include:
|
||||
* Threshold rules support visual page configuration or expression rule configuration for more flexibility.
|
||||
* It supports configuring the number of triggers, alarm levels, notification templates, associated with a specific monitor and so on.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Alarm Convergence
|
||||
|
||||
* When the alarm is triggered by the threshold rule, it will enter into the alarm convergence, the alarm convergence will be based on the rules of the specific time period of the duplicate alarm message de-emphasis convergence, to avoid a large number of repetitive alarms lead to the receiver alarm numbness.
|
||||
* Alarm convergence rules support duplicate alarm effective time period, label matching and alarm level matching filter.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Alarm Silence
|
||||
|
||||
@ -274,9 +274,9 @@ Built-in support for monitoring types include:
|
||||
* This application scenario, such as users in the system maintenance, do not need to send known alarms. Users will only receive alarm messages on weekdays, and users need to avoid disturbances at night.
|
||||
* Alarm silence rules support one-time time period or periodic time period, support label matching and alarm level matching.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Message Notification
|
||||
|
||||
@ -286,18 +286,18 @@ Built-in support for monitoring types include:
|
||||
* The notification policy supports tag matching and alert level matching, which makes it convenient to assign alerts with different tags and alert levels to different receivers and handlers.
|
||||
* Support notification templates, users can customize the content format of the templates to meet their own personalized notification display needs.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Monitoring Templates
|
||||
|
||||
* HertzBeat makes `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` and other protocols configurable so that you can customize the metrics you want to collect using these protocols by simply configuring the monitoring template `YML` in your browser. Would you believe that you can instantly adapt a new monitoring type such as `K8s` or `Docker` just by configuring it?
|
||||
* All our built-in monitoring types (mysql, website, jvm, k8s) are also mapped to corresponding monitoring templates, so you can add and modify monitoring templates to customize your monitoring functions.
|
||||
|
||||
|
||||
|
||||
|
||||
----
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ To install Rainbond, please refer to [Rainbond Quick Install](https://www.rainbo
|
||||
|
||||
After logging in Rainbond, click Market in the left menu, switch to open source app store, and search HertzBeat in the search box, and click the Install button.
|
||||
|
||||
|
||||
|
||||
|
||||
Fill in the following information, and click Confirm button to install.
|
||||
|
||||
@ -25,7 +25,7 @@ Fill in the following information, and click Confirm button to install.
|
||||
|
||||
After installation, HertzBeat can be accessed via the Access button.
|
||||
|
||||
|
||||
|
||||
|
||||
:::tip
|
||||
HertzBeat installed via Rainbond, External Mysql database and Redis and IoTDB are used by default, The HertzBeat configuration file is also mounted, which can be modified in `Components -> Environment Configuration -> Configuration File Settings`.
|
||||
|
||||
@ -28,52 +28,52 @@ github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> System Page -> Monitor Menu -> SSL Certificate -> Add SSL Certificate
|
||||
|
||||
|
||||
|
||||
|
||||
2. Configure the monitoring website
|
||||
|
||||
> Here we take the example of monitoring Baidu website, configure monitoring host domain name, name, collection interval, etc.
|
||||
> Click OK Note ⚠️Before adding, it will test the connectivity of the website by default, and the connection will be successful before adding. Of course, you can also gray out the **Test or not** button.
|
||||
|
||||
|
||||
|
||||
|
||||
3. View the detection index data
|
||||
|
||||
> In the monitoring list, you can view the monitoring status, and in the monitoring details, you can view the metric data chart, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set the threshold (triggered when the certificate expires)
|
||||
|
||||
> System Page -> Alarms -> Alarm Thresholds -> New Thresholds
|
||||
|
||||
|
||||
|
||||
|
||||
> Configure the threshold, select the SSL certificate metric object, configure the alarm expression-triggered when the metric `expired` is `true`, that is, `equals(expired,"true")`, set the alarm level notification template information, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
> Associating thresholds with monitoring, in the threshold list, set which monitoring this threshold applies to.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Set the threshold (triggered one week before the certificate expires)
|
||||
|
||||
> In the same way, add a new configuration threshold and configure an alarm expression - when the metric expires timestamp `end_timestamp`, the `now()` function is the current timestamp, if the configuration triggers an alarm one week in advance: `end_timestamp <= (now( ) + 604800000)` , where `604800000` is the 7-day total time difference in milliseconds.
|
||||
|
||||
|
||||
|
||||
|
||||
> Finally, you can see the triggered alarm in the alarm center.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Alarm notification (in time notification via Dingding WeChat Feishu, etc.)
|
||||
|
||||
> Monitoring Tool -> Alarm Notification -> New Receiver
|
||||
|
||||
|
||||
|
||||
|
||||
For token configuration such as Dingding WeChat Feishu, please refer to the help document
|
||||
|
||||
@ -81,7 +81,7 @@ github: <https://github.com/apache/hertzbeat>
|
||||
|
||||
> Alarm Notification -> New Alarm Notification Policy -> Enable Notification for the Recipient Just Configured
|
||||
|
||||
|
||||
|
||||
|
||||
7. OK When the threshold is triggered, we can receive the corresponding alarm message. If there is no notification, you can also view the alarm information in the alarm center.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user