# hertzbeat
**Repository Path**: gitxuchang/hertzbeat
## Basic Information
- **Project Name**: hertzbeat
- **Description**: ๐ฅ ไธไธชๆฅๆๅผบๅคง่ชๅฎไน็ๆง่ฝๅ๏ผๆ ้Agent็ๅฎๆถ็ๆงๅ่ญฆๅทฅๅ
ทใๆไปฌ่ดๅไบ็ๆงไธๅ๏ผ ็ฝ็ซ๏ผๆฐๆฎๅบ๏ผๆไฝ็ณป็ป๏ผไธญ้ดไปถ๏ผไบๅ็๏ผ็ฝ็ปใ้ๅผๅ่ญฆ้็ฅ(้ฎไปถๅพฎไฟก้้้ฃไนฆ็ญไฟก Discord Telegarm Slack Webhook)
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://hertzbeat.dromara.org/
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 969
- **Created**: 2023-05-08
- **Last Updated**: 2023-05-08
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[comment]: <> (
)
## HertzBeat | [ไธญๆๆๆกฃ](README_CN.md)
> An open source, real-time monitoring tool with custom-monitor and agentLess. | ๆ็จๅๅฅฝ็ๅผๆบๅฎๆถ็ๆงๅ่ญฆๅทฅๅ
ท๏ผๆ ้Agent๏ผๅผบๅคง่ชๅฎไน็ๆง่ฝๅ.
[](https://discord.gg/Fb6M73htGr)
[](https://gitter.im/hertzbeat/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://jq.qq.com/?_wv=1027&k=aVIVB2K9)










**Home: [hertzbeat.dromara.org](https://hertzbeat.dromara.org) | [hertzbeat.com](https://hertzbeat.com)**
**Cloud: [tancloud.cn](https://tancloud.cn)**
## ๐ก Introduction
> [HertzBeat](https://github.com/dromara/hertzbeat) is an open source, real-time monitoring tool with custom-monitor and agentless.
> **Monitor+Alerter+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more.
> More flexible threshold rule(calculation expression), timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`.
> We make protocols such as `Http, Jmx, Ssh, Snmp, Jdbc` configurable, and you only need to configure `YML` online to collect any metrics you want.
> Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online?
> `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)**.
----
[](https://www.bilibili.com/video/BV1LY4y1m7rH/)
[](https://www.bilibili.com/video/BV1LY4y1m7rH/)
----
## ๐ฅ Architecture

## โ Supported
> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
> Welcome everyone to contribute your customized general monitoring type YML template during use.
- [Website](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-website.yml), [Port Telnet](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-port.yml),
[Http Api](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-ping.yml),
[Jvm](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml),
[Ssl Certificate](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml),
[FTP Server](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml)
- [Mysql](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml),
[MariaDB](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-redis.yml),
[ElasticSearch](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml),
[Oracle](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml),
[DM](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml),
[ClickHouse](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml),
[Redis Cluster](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml)
- [Linux](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml),
[CentOS](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-windows.yml),
[EulerOS](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml)
- [Tomcat](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml),
[Zookeeper](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml),
[Flink](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml),
[ShenYu](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml),
[Jetty](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml)
- [Kubernetes](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-docker.yml)
- [CiscoSwitch](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml),
[HuaweiSwitch](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml),
[H3cSwitch](https://raw.githubusercontent.com/dromara/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
- And More Your Custom Template.
- Notified Support `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`.
## ๐ Quick Start
- If you donโt want to deploy but use it directly, we provide [SAAS Monitoring Cloud-TanCloud](https://console.tancloud.cn), **[Log In And Register For Free](https://console.tancloud.cn)**.
- If you want to deploy HertzBeat local, please refer to the following Deployment Documentation for operation.
### ๐ Install HertzBeat
> HertzBeat supports installation through source code, docker or package, cpu support X86/ARM64.
##### 1๏ผInstall quickly via docker
1. Just one command to get started: `docker run -d -p 1157:1157 --name hertzbeat tancloud/hertzbeat`
2. Access `localhost:1157` to start, default account: `admin/hertzbeat`
Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy)
##### 2๏ผInstall via package
1. Download the installation package [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
2. Need `Java11` Environment
3. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional)
4. Run shell `$ ./startup.sh ` or `startup.bat`
5. Access `localhost:1157` to start, default account: `admin/hertzbeat`
Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.com/docs/start/package-deploy)
##### 3๏ผStart via source code
1. Local source code debugging needs to start the back-end project `manager` and the front-end project `web-app`.
2. Backend๏ผneed `maven3+`, `java11`, `lombok`, start the `manager` service.
3. Web๏ผneed `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup.
4. Access `localhost:4200` to start, default account: `admin/hertzbeat`
Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md)
##### 4๏ผInstall All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose
Install and deploy the mysql database, iotdb/tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose).
Detailed steps refer to [Install via Docker-Compose](script/docker-compose/README.md)
**HAVE FUN**
## ๐ฅ Roadmap

## โจ Contributors
Thanks these wonderful people, welcome to join us:
[Contributor Guide](CONTRIBUTING.md)
## ๐ฌ Join discussion
HertzBeat is a project under the [Dromara Open Source Community](https://dromara.org/).
##### 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`
[Gitter Channel](https://gitter.im/hertzbeat/community)
[Github Discussion](https://github.com/dromara/hertzbeat/discussions)
[User Club](https://support.qq.com/products/379369)
##### Public
##### Friends
- [DynamicTp](https://github.com/dromara/dynamic-tp) : ่ฝป้็บงๅจๆ็บฟ็จๆฑ ๏ผๅ
็ฝฎ็ๆงๅ่ญฆๅ่ฝ๏ผ้ๆไธๆนไธญ้ดไปถ็บฟ็จๆฑ ็ฎก็๏ผๅบไบไธปๆต้
็ฝฎไธญๅฟ
- [Hippo4j](https://github.com/opengoofy/hippo4j/) : ๅผบๅคง็ๅจๆ็บฟ็จๆฑ ๆกๆถ๏ผ้ๅธฆ็ๆงๆฅ่ญฆๅ่ฝ
- [Jpom](https://gitee.com/dromara/Jpom) : ็ฎ่่ฝป็ไฝไพตๅ
ฅๅผๅจ็บฟๆๅปบใ่ชๅจ้จ็ฝฒใๆฅๅธธ่ฟ็ปดใ้กน็ฎ็ๆง่ฝฏไปถ
- [ArgusDBM](https://github.com/zmops/ArgusDBM) : ๅผๆบๆฐๆฎๅบไธไฝๅ็ๆงๅนณๅฐ๏ผ่ดๅไบ็ๆงๆๆๆฐๆฎๅบ
##### Sponsor
- Postcat [An Open Source API Tool](https://datayi.cn/w/xRxVBBko) supporting api test, mock, documentation, team collaboration etc.
- Thanks [ๅๅฎไฟกๆฏ(ๆๅปบๅ
จๆฐ็ๅพฎๆณข+ๅ
ไบคๆ็ฝ็ป)](https://www.flarespeed.com) sponsored server node.
- Thanks [่ๆไบ(ๅ
จๆฐๆบๆ
งไธไบ)](https://www.tsyvps.com/aff/BZBEGYLX) sponsored server node.
## ๐ก๏ธ License
[`Apache License, Version 2.0`](https://www.apache.org/licenses/LICENSE-2.0.html)