Skip to content

Commit

Permalink
update component tip and help tip doc (#1418)
Browse files Browse the repository at this point in the history
Signed-off-by: tomsun28 <[email protected]>
  • Loading branch information
tomsun28 authored Dec 12, 2023
1 parent 256ee4d commit 06b53b4
Show file tree
Hide file tree
Showing 93 changed files with 755 additions and 354 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@

## HertzBeat | [中文文档](README_CN.md)

> An open-source, real-time monitoring system with custom monitoring, high performance cluster and agentless capabilities. | 易用友好的开源实时监控告警系统,无需Agent,高性能集群,强大自定义监控能力.
> An open-source, real-time monitoring system with custom-monitoring, performance-cluster, prometheus-compatible and agentless. | 易用友好的开源实时监控告警系统,无需Agent,高性能集群,兼容Prometheus,强大自定义监控能力.
[![discord](https://img.shields.io/badge/Chat-On%20Discord-brightgreen)](https://discord.gg/Fb6M73htGr)
[![Twitter](https://img.shields.io/twitter/follow/hertzbeat1024?logo=twitter)](https://twitter.com/hertzbeat1024)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8139/badge)](https://www.bestpractices.dev/projects/8139)
[![Docker Pulls](https://img.shields.io/docker/pulls/tancloud/hertzbeat?style=%20for-the-badge&logo=docker&label=DockerHub%20Download)](https://hub.docker.com/repository/docker/tancloud/hertzbeat/general)
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/hertzbeat)](https://artifacthub.io/packages/search?repo=hertzbeat)
[![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr)
[![Gitter](https://badges.gitter.im/hertzbeat/community.svg)](https://gitter.im/hertzbeat/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![QQ](https://img.shields.io/badge/qq-236915833-orange)](https://jq.qq.com/?_wv=1027&k=aVIVB2K9)
[![Twitter](https://img.shields.io/twitter/follow/hertzbeat1024?logo=twitter)](https://twitter.com/hertzbeat1024)
[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCri75zfWX0GHqJFPENEbLow?logo=youtube&label=YouTube%20Channel)](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow)

**Home: [hertzbeat.dromara.org](https://hertzbeat.dromara.org) Global | [hertzbeat.com](https://hertzbeat.com) China**
Expand All @@ -25,7 +24,7 @@

## 🎡 <font color="green">Introduction</font>

[HertzBeat](https://github.com/dromara/hertzbeat) is an open source, real-time monitoring system with custom monitoring, high performance cluster and agentless capabilities.
[HertzBeat](https://github.com/dromara/hertzbeat) is an open source, real-time monitoring system with custom monitoring, high performance cluster, prometheus-compatible and agentless capabilities.

### Features

Expand All @@ -42,9 +41,9 @@
----

[![hertzbeat](home/static/img/home/1.png)](https://www.bilibili.com/video/BV1Vc411V7BJ/)
![hertzbeat](home/static/img/home/1.png)

[![hertzbeat](home/static/img/home/9.png)](https://www.bilibili.com/video/BV1Vc411V7BJ/)
![hertzbeat](home/static/img/home/9.png)

----

Expand Down Expand Up @@ -402,13 +401,11 @@ HertzBeat is a top project under the [Dromara Open Source Community](https://dro

##### Channel

WeChat Group : Add friend `tan-cloud`, and will invite you to the group.

[QQ Group](https://jq.qq.com/?_wv=1027&k=Bud9OzdI) : Add group num `236915833`
**[Chat On Discord](https://discord.gg/Fb6M73htGr)**

[Gitter Channel](https://gitter.im/hertzbeat/community)
**WeChat Group** : Add friend `tan-cloud` and will invite you to the group.

[Chat On Discord](https://discord.gg/Fb6M73htGr)
[QQ Group](https://jq.qq.com/?_wv=1027&k=Bud9OzdI) : Group num `236915833`

[Github Discussion](https://github.com/dromara/hertzbeat/discussions)

Expand Down
30 changes: 7 additions & 23 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@

## HertzBeat 赫兹跳动 | [English Documentation](README.md)

> 易用友好的开源实时监控告警系统,无需Agent,高性能集群,强大自定义监控能力。
> 易用友好的开源实时监控告警系统,无需Agent,高性能集群,兼容Prometheus,强大自定义监控能力。
[![discord](https://img.shields.io/badge/Chat-On%20Discord-brightgreen)](https://discord.gg/Fb6M73htGr)
[![Twitter](https://img.shields.io/twitter/follow/hertzbeat1024?logo=twitter)](https://twitter.com/hertzbeat1024)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8139/badge)](https://www.bestpractices.dev/projects/8139)
[![Docker Pulls](https://img.shields.io/docker/pulls/tancloud/hertzbeat?style=%20for-the-badge&logo=docker&label=DockerHub%20Download)](https://hub.docker.com/repository/docker/tancloud/hertzbeat/general)
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/hertzbeat)](https://artifacthub.io/packages/search?repo=hertzbeat)
[![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr)
[![Gitter](https://badges.gitter.im/hertzbeat/community.svg)](https://gitter.im/hertzbeat/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![QQ](https://img.shields.io/badge/qq-236915833-orange)](https://jq.qq.com/?_wv=1027&k=aVIVB2K9)
[![Twitter](https://img.shields.io/twitter/follow/hertzbeat1024?logo=twitter)](https://twitter.com/hertzbeat1024)
[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCri75zfWX0GHqJFPENEbLow?logo=youtube&label=YouTube%20Channel)](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow)


Expand All @@ -26,7 +25,7 @@

## 🎡 <font color="green">介绍</font>

[HertzBeat 赫兹跳动](https://github.com/dromara/hertzbeat) 是一个拥有强大自定义监控能力,高性能集群,无需 Agent 的开源实时监控告警系统。
[HertzBeat 赫兹跳动](https://github.com/dromara/hertzbeat) 是一个拥有强大自定义监控能力,高性能集群,兼容 Prometheus,无需 Agent 的开源实时监控告警系统。

### 特点

Expand All @@ -43,9 +42,9 @@
----

[![hertzbeat](home/static/img/home/1.png)](https://www.bilibili.com/video/BV1Vc411V7BJ/)
![hertzbeat](home/static/img/home/1.png)

[![hertzbeat](home/static/img/home/9.png)](https://www.bilibili.com/video/BV1Vc411V7BJ/)
![hertzbeat](home/static/img/home/9.png)

----

Expand Down Expand Up @@ -411,9 +410,7 @@ HertzBeat 赫兹跳动是 [Dromara开源社区](https://dromara.org/) 下顶级

##### Channel

[Gitter Channel](https://gitter.im/hertzbeat/community)

[Chat On Discord](https://discord.gg/Fb6M73htGr)
**[Chat On Discord](https://discord.gg/Fb6M73htGr)**

[Github Discussion](https://github.com/dromara/hertzbeat/discussions)

Expand Down Expand Up @@ -448,19 +445,6 @@ HertzBeat 赫兹跳动是 [Dromara开源社区](https://dromara.org/) 下顶级
- 感谢 [吉实信息(构建全新的微波+光交易网络)](https://www.flarespeed.com) 赞助服务器采集节点
- 感谢 [蓝易云(全新智慧上云)](https://www.tsyvps.com/aff/BZBEGYLX) 赞助服务器采集节点


## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=dromara/hertzbeat&type=Date)](https://star-history.com/#dromara/hertzbeat&Date)

##### Open-Source Project Build From Open-Source

> HertzBeat is built on so many great open source projects, thanks to them!

- Java Spring SpringBoot Jpa Maven Assembly Netty Lombok Sureness Aviator Protobuf HttpClient Guava SnakeYaml JsonPath ...
- TypeScript Angular NG-ZORRO NG-ALAIN NodeJs Npm Html Less Echarts Rxjs ZoneJs MonacoEditor SlickCarousel Docusaurus ...


##### Open-Source Project Build From Open-Source

HertzBeat is built on so many great open source projects, thanks to them!
Expand Down
176 changes: 176 additions & 0 deletions home/blog/2023-12-11-hertzbeat-v1.4.3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
---
title: HertzBeat v1.4.3 released, prometheus-compatible!
author: tom
author_title: tom
author_url: https://github.com/tomsun28
author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4
tags: [opensource, practice]
keywords: [open source monitoring system, alerting system]
---

### What is HertzBeat?

[HertzBeat](https://github.com/dromara/hertzbeat) is an open source, real-time monitoring system with custom monitoring, high performance cluster, prometheus-compatible and agentless capabilities.

### Features

* Combines **monitoring, alarm, and notification** features into one platform, and supports monitoring for web service, program, database, cache, os, webserver, middleware, bigdata, cloud-native, network, custom and more.
* Easy to use and agentless, offering full gui operations for monitoring and alerting with just a few clicks, all at zero learning cost.
* Makes protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, allowing you to collect any metrics by simply configuring the template `YML` file online. Imagine being able to quickly adapt to a new monitoring type like K8s or Docker simply by configuring online with HertzBeat.
* Compatible with the `Prometheus` ecosystem and more, can monitoring what `Prometheus` can monitoring with few clicks on gui.
* High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration.
* Provides flexible alarm threshold rules and timely notifications delivered via `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`.

> 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.
> We also provide **[SaaS Monitoring Cloud](https://console.tancloud.cn)**, users no longer need to deploy a cumbersome monitoring system to monitor their resources. **[Get started online for free](https://console.tancloud.cn)**.
![hertzBeat](/img/docs/hertzbeat-arch.png)

**Github: https://github.com/dromara/hertzbeat**

**Gitee: https://gitee.com/dromara/hertzbeat**

### HertzBeat's 1.4.3 Version Release!


- enhanced reporting of external general alert API
- support mysql api port website mongodb jvm redis monitoring metrics name i18n
- support auto collect metrics by prometheus task
- support victoriametrics as metrics data storage
- support monitoring spring gateway metrics
- add more windows monitoring metrics
- add e2e testing module, support by api-testing
- more feature, document and bugfix

Compatible with the Prometheus ecosystem, now we can monitor what Prometheus can monitoring with few clicks on gui.


### Install Quickly Via Docker

1. Just one command to get started:

```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat tancloud/hertzbeat```

```or use quay.io (if dockerhub network connect timeout)```

```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat```

2. Access `http://localhost:1157` to start, default account: `admin/hertzbeat`

3. Deploy collector clusters

```
docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector tancloud/hertzbeat-collector
```
- `-e IDENTITY=custom-collector-name` : set the collector unique identity name.
- `-e MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip.
- `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158.

Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy)


----

### What's Changed

> Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗!
* update package deploy doc by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1330
* bugfix duplicate collect job when update monitor templates by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1332
* bugfix number variable in freemarker template display error by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1334
* [alerter] Enhanced reporting of external general alert API by @SurryChen in https://github.com/dromara/hertzbeat/pull/1326
* [doc] update hertzbeat-mysql-tdengine readme by @jiashu1024 in https://github.com/dromara/hertzbeat/pull/1335
* add jiashu1024 as a contributor for doc by @allcontributors in https://github.com/dromara/hertzbeat/pull/1336
* app-mysql.yml: Adjust slow query translation by @1036664317 in https://github.com/dromara/hertzbeat/pull/1337
* add 1036664317 as a contributor for doc by @allcontributors in https://github.com/dromara/hertzbeat/pull/1338
* Bump com.google.guava:guava from 31.0.1-jre to 32.0.0-jre by @dependabot in https://github.com/dromara/hertzbeat/pull/1339
* [feature] support auto collect metrics by prometheus task by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1342
* [doc] add vinci as new committer by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1341
* [feature] add tag word cloud in dashboard by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1345
* support custom prometheus endpoint path by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1346
* bugfix tdengine query interval history metrics data with instance error by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1348
* unlimit Alert.java content field length by @xiaoguolong in https://github.com/dromara/hertzbeat/pull/1351
* add xiaoguolong as a contributor for code by @allcontributors in https://github.com/dromara/hertzbeat/pull/1353
* update monitor detail table ui layout by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1352
* [doc]add star history by @zqr10159 in https://github.com/dromara/hertzbeat/pull/1356
* feature: app-mongodb.yml by @a-little-fool in https://github.com/dromara/hertzbeat/pull/1359
* alarm threshold support prometheus task metrics by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1354
* support victoriametrics as metrics data storage by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1361
* Add time type to support query_time of mysql and mariadb by @Clownsw in https://github.com/dromara/hertzbeat/pull/1364
* add Clownsw as a contributor for code by @allcontributors in https://github.com/dromara/hertzbeat/pull/1365
* Error occured when I followed running steps to start Front-web by @Calvin979 in https://github.com/dromara/hertzbeat/pull/1366
* add Calvin979 as a contributor for doc by @allcontributors in https://github.com/dromara/hertzbeat/pull/1367
* enriches the cncf landscape by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1368
* Fix flaky test in CollectUtilTest by @bbelide2 in https://github.com/dromara/hertzbeat/pull/1371
* add bbelide2 as a contributor for code by @allcontributors in https://github.com/dromara/hertzbeat/pull/1372
* Fix flaky test replaceSmilingPlaceholder by @bbelide2 in https://github.com/dromara/hertzbeat/pull/1373
* add docker-compose script hertzbeat+mysql+victoria-metrics all in one by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1370
* Feature: app-jvm.yml support for international name aliases by @Calvin979 in https://github.com/dromara/hertzbeat/pull/1376
* add Calvin979 as a contributor for code by @allcontributors in https://github.com/dromara/hertzbeat/pull/1377
* feature: support monitoring spring gateway metrics by @a-little-fool in https://github.com/dromara/hertzbeat/pull/1374
* update code comment and doc, bugfix concurrent exception by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1378
* update windows define and accept snmp leaf by @jinyaoMa in https://github.com/dromara/hertzbeat/pull/1379
* add jinyaoMa as a contributor for code by @allcontributors in https://github.com/dromara/hertzbeat/pull/1380
* fix exception when sending email has special chars by @Carpe-Wang in https://github.com/dromara/hertzbeat/pull/1383
* test: add e2e testing for some basic APIs by @LinuxSuRen in https://github.com/dromara/hertzbeat/pull/1387
* add LinuxSuRen as a contributor for code, and test by @allcontributors in https://github.com/dromara/hertzbeat/pull/1389
* bugfix auto generate monitor name error when add monitor by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1384
* bugfix CalculateAlarm execAlertExpression NPE by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1388
* Feature: app-redis.yml support for international name aliases by @Calvin979 in https://github.com/dromara/hertzbeat/pull/1390
* test: add more monitor related e2e testing case by @LinuxSuRen in https://github.com/dromara/hertzbeat/pull/1391
* chore: update the pr template about the e2e testing by @LinuxSuRen in https://github.com/dromara/hertzbeat/pull/1392
* add help header ui when update or add monitors by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1399
* [hertzbeat] release hertzbeat version v1.4.3 by @tomsun28 in https://github.com/dromara/hertzbeat/pull/1400

## New Contributors

* @1036664317 made their first contribution in https://github.com/dromara/hertzbeat/pull/1337
* @dependabot made their first contribution in https://github.com/dromara/hertzbeat/pull/1339
* @xiaoguolong made their first contribution in https://github.com/dromara/hertzbeat/pull/1351
* @Clownsw made their first contribution in https://github.com/dromara/hertzbeat/pull/1364
* @Calvin979 made their first contribution in https://github.com/dromara/hertzbeat/pull/1366
* @bbelide2 made their first contribution in https://github.com/dromara/hertzbeat/pull/1371
* @jinyaoMa made their first contribution in https://github.com/dromara/hertzbeat/pull/1379
* @LinuxSuRen made their first contribution in https://github.com/dromara/hertzbeat/pull/1387

**Full Changelog**: https://github.com/dromara/hertzbeat/compare/v1.4.2...v1.4.3

----

## ⛄ Supported

- Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server
- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster
- Linux, Ubuntu, CentOS, Windows
- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ
- Kubernetes, Docker
- Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch
- and more for your custom monitoring.
- Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`.

----

**Github: https://github.com/dromara/hertzbeat**
**Gitee: https://gitee.com/dromara/hertzbeat**

### **Download Link**

**hertzbeat server**

- ⬇️ [hertzbeat-1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-1.4.3.tar.gz)
- ⬇️ [hertzbeat-1.4.3.zip](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-1.4.3.zip)
- ⬇️ [hertzbeat-linux_amd64_1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-linux_amd64_1.4.3.tar.gz)
- ⬇️ [hertzbeat-linux_arm64_1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-linux_arm64_1.4.3.tar.gz)
- ⬇️ [hertzbeat-macos_arm64_1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-macos_arm64_1.4.3.tar.gz)
- ⬇️ [hertzbeat-macos_amd64_1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-macos_amd64_1.4.3.tar.gz)
- ⬇️ [hertzbeat-windows64_1.4.3.zip](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-windows64_1.4.3.zip)

**hertzbeat collector**

- ⬇️ [hertzbeat-collector-1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-1.4.3.tar.gz)
- ⬇️ [hertzbeat-collector-1.4.3.zip](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-1.4.3.zip)
- ⬇️ [hertzbeat-collector-linux_amd64_1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-linux_amd64_1.4.3.tar.gz)
- ⬇️ [hertzbeat-collector-linux_arm64_1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-linux_arm64_1.4.3.tar.gz)
- ⬇️ [hertzbeat-collector-macos_arm64_1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_arm64_1.4.3.tar.gz)
- ⬇️ [hertzbeat-collector-macos_amd64_1.4.3.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_amd64_1.4.3.tar.gz)
- ⬇️ [hertzbeat-collector-windows64_1.4.3.zip](https://github.com/dromara/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-windows64_1.4.3.zip)
Loading

0 comments on commit 06b53b4

Please sign in to comment.