HertzBeat | 中文文档

An open-source, real-time monitoring system with custom-monitoring, performance-cluster, prometheus-compatible and agentless. | 易用友好的开源实时监控告警系统，无需Agent，高性能集群，兼容Prometheus，强大自定义监控能力.

Home: hertzbeat.dromara.org Global | hertzbeat.com China

Cloud: console.tancloud.cn

🎡 Introduction

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, web-based and with one-click monitoring and alerting, zero learning curve.
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 webui.
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 users quickly build their own monitoring system.
We also provide SaaS Monitoring Cloud, users no longer need to deploy a cumbersome monitoring system to monitor their resources. Get started online for free.

🥐 Architecture

⛄ Supported

We define all monitoring collection types such as mysql, jvm, and k8s as YML monitoring templates, allowing users to import them to support corresponding types of monitoring. Welcome everyone to contribute your customized general monitoring type YML template during use.

Website, Port Telnet, Http Api, Ping Connect, Jvm, SiteMap, Ssl Certificate, SpringBoot2, FTP Server, SpringBoot3, Udp Port, Dns, Pop3, Ntp, Api Code, Smtp, Nginx
Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, DM, OpenGauss, ClickHouse, IoTDB, Redis Cluster, Redis Sentinel Doris BE, Doris FE, Memcached, NebulaGraph
Linux, Ubuntu, CentOS, Windows, EulerOS, Fedora CoreOS, OpenSUSE, Rocky Linux, Red Hat, FreeBSD, AlmaLinux, Debian Linux
Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ, Spring Gateway, EMQX MQTT, AirFlow, Hive, Spark, Hadoop
Kubernetes, Docker
CiscoSwitch, HpeSwitch, HuaweiSwitch, TpLinkSwitch, H3cSwitch
And More Your Custom Template.
Notified Support Discord Slack Telegram Email Dingtalk WeChat FeiShu Webhook SMS ServerChan.

🐕 Quick Start

If you prefer to use HertzBeat directly without deploying it, we provide SAAS Monitoring Cloud-TanCloud, Log In For Free.
If you wish to deploy HertzBeat locally, please refer to the following Deployment Documentation for instructions.

🍞 Install HertzBeat

HertzBeat supports installation through source code, docker or package, cpu support x86/arm64.

1：Install quickly via docker

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

Access http://localhost:1157 to start, default account: admin/hertzbeat
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 MODE=public : set the running mode(public or private), public cluster or private cloud-edge.
-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

2：Install via package

Download the release package hertzbeat-xx.tar.gz GITEE Release GITHUB Release
Configure the HertzBeat configuration yml file hertzbeat/config/application.yml (optional)
Run command $ ./bin/startup.sh or bin/startup.bat
Access http://localhost:1157 to start, default account: admin/hertzbeat
Deploy collector clusters
- Download the release package hertzbeat-collector-xx.tar.gz to new machine GITEE Release GITHUB Release
- Configure the collector configuration yml file hertzbeat-collector/config/application.yml: unique identity name, running mode (public or private), hertzbeat manager-host, hertzbeat manager-port
```
collector:
  dispatch:
    entrance:
      netty:
        enabled: true
        identity: ${IDENTITY:}
        mode: ${MODE:public}
        manager-host: ${MANAGER_HOST:127.0.0.1}
        manager-port: ${MANAGER_PORT:1158}
```
- Run command $ ./bin/startup.sh or bin/startup.bat
- Access http://localhost:1157 and you will see the registered new collector in dashboard

Detailed config refer to Install HertzBeat via Package

3：Start via source code

Local source code debugging needs to start the back-end project manager and the front-end project web-app.
Backend：need maven3+, java11, lombok, start the manager service.
Web：need nodejs npm angular-cli environment, Run ng serve --open in web-app directory after backend startup.
Access http://localhost:4200 to start, default account: admin/hertzbeat

Detailed steps refer to CONTRIBUTING

4：Install All(hertzbeat+mysql+tsdb) via Docker-compose

Install the mysql/postgresql database, iotdb/tdengine/victoria-metrics database and hertzbeat at one time through docker-compose deployment script.

Detailed steps refer to Install via Docker-Compose

5. Install All(hertzbeat+collector+mysql+tsdb) via kubernetes helm charts

Install HertzBeat cluster in a Kubernetes cluster by Helm chart.

Detailed steps refer to Artifact Hub

HAVE FUN

🥐 Roadmap

✨ Contributors

Thanks to these wonderful people, welcome to join us:
Contributor Guide

_tomsun28 💻 📖 🎨	_{会编程的王学长} 💻 📖 🎨	_MaxKey 💻 🎨 🤔	_观沧海 💻 🎨 🐛	_yuye 💻 📖	_jx10086 💻 🐛	_winnerTimer 💻 🐛
_goo-kits 💻 🐛	_brave4Time 💻 🐛	_WalkerLee 💻 🐛	_jianghang 💻 🐛	_ChineseTony 💻 🐛	_wyt199905 💻	_卫傅庆 💻 🐛
_zklmcookle 💻	_DevilX5 📖 💻	_tea 💻	_yangshihui 💻 🐛	_DreamGirl524 💻 📖	_gzwlly 📖	_{cuipiheqiuqiu} 💻 ⚠️ 🎨
_lambert 💻	_mroldx 📖	_{woshiniusange} 📖	_VampireAchao 💻	_zcx 💻 🐛 🎨	_CharlieXCL 📖	_Privauto 💻 📖
_emrys 📖	_SxLiuYu 🐛	_{All Contributors} 📖	_铁甲小宝 💻 📖	_click33 📖	_蒋小小 📖	_{Kevin Huang} 📖
_铁甲小宝 🐛 💻 📖	_{Captain Jack} 📖	_haibo.duan ⚠️ 💻	_assassin 🐛 💻	_{Reverse wind} ⚠️ 💻	_luxx 💻	_{Ikko Ashimine} 📖
_leizenan 💻	_BKing 📖	_xingshuaiLi 📖	_wangke6666 📖	_刺猬 🐛 💻	_Haste 💻	_zhongshi.yi 📖
_{Qi Zhang} 📖	_MrAndyMing 📖	_idongliming 💻	_{Zichao Lin} 💻 📖	_liudonghua 💻 🤔	_Jerry 💻 ⚠️ 🤔	_yanhom 📖
_fsl 💻	_xttttv 📖	_{NavinKumarBarnwal} 💻	_Zakkary 📖	_sunxinbo 💻 ⚠️	_ldzbook 📖 🐛	_余与雨 💻 ⚠️
_{MysticalDream} 💻 ⚠️	_zhouyoulin12 💻 ⚠️	_jerjjj 💻	_wjl110 💻	_Sean 📖	_chenyiqin 💻 ⚠️	_{hudongdong129} 💻 ⚠️ 📖
_TherChenYang 💻 ⚠️	_HattoriHenzo 💻 ⚠️	_ycilry 📖	_aoshiguchen 📖 💻	_蔡本祥 💻	_浮游 💻	_Grass-Life 💻
_xiaohe428 💻 📖	_TableRow 📖 💻	_ByteIDance 💻	_Jangfe 💻	_zqr10159 📖 💻	_vinci 💻 📖 🎨	_js110 💻
_CrazyLionLi 📖	_banmajio 💻	_topsuder 💻	_richar2022 💻	_fcb-xiaobo 💻	_wenkyzhang 📖	_ZangJuxy 📖
_l646505418 💻	_Carpe-Wang 💻	_莫枢 💻	_huangcanda 💻	_{世纪末的架构师} 💻	_ShuningWan 📖	_MrYZhou 📖
_suncqujsj 📖	_sunqinbo 💻	_haoww 📖	_i-mayuan 📖	_fengruge 📖	_zhanghuan 💻	_shenymin 💻
_{Dhruva Chandra} 💻	_{miss_z} 📖	_wyt990 💻	_licocon 💻	_{Mi Na} 💻	_Kylin-Guo 📖	_{Mr灬Dong先生} 💻
_{Pratyay Banerjee} 📖 💻	_{yujianzhong520} 💻	_SPPan 💻	_ZhangJiashu 💻	_impress 💻	_{凌晨一点半} 📖	_{Eeshaan Sawant} 💻
_{nandofromthebando} 💻	_caiboking 💻	_baixing99 💻	_{Yang Chuang} 💻	_wlin20 💻	_guojing1983 💻	_moxi 📖
_qq471754603 💻	_渭雨 💻	_liuxuezhuo 💻	_lisongning 💻	_YutingNie 💻 📖 🎨	_{Mike Zhou} 💻 📖 🎨	_小笨蛋 💻
_{littlezhongzer} 💻	_{ChenXiangxxxxx} 💻	_Mr.zhou 💻	_姚贤丰 💻	_lingluojun 💻	_1ue 💻	_qyaaaa 💻
_novohit 💻	_zhuoshangyi 💻	_ruanliang 📖 💻	_Eden4701 💻 📖 🎨	_XiaTian688 📖	_liyinjiang 💻	_ZhangJiashu 📖
_moghn 📖	_xiaoguolong 💻	_Smliexx 💻	_Naruse 📖 💻	_{Bala Sukesh} 💻	_{Jinyao Ma} 💻	_Rick 💻 ⚠️
_东风 💻 🎨 📖	_{sonam singh} 💻	_{ZhangZixuan1994} 💻	_SHIG 💻	_泰上老菌 💻	_ldysdu 💻	_梁同学 💻
_avv 💻	_yqxxgh 📖

💬 Join discussion

HertzBeat is a top project under the Dromara Open Source Community. Gitee GVP.

Channel

Chat On Discord

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

QQ Group : Group num 236915833

Public

Friends

Sa-Token : 一个轻量级 java 权限认证框架，让鉴权变得简单、优雅
DynamicTp : 轻量级动态线程池，内置监控告警功能，集成三方中间件线程池管理，基于主流配置中心
Hippo4j : 强大的动态线程池框架，附带监控报警功能
Jpom : 简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
ArgusDBM : 开源数据库一体化监控平台，致力于监控所有数据库
WangMarket : 开源 SAAS 云建站系统
API Testing：轻量级、可扩展的接口开发、测试工具

Sponsor

Thanks 吉实信息(构建全新的微波+光交易网络) sponsored server node.

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 ...

Landscape

HertzBeat has been included in the CNCF Observability And Analysis - Monitoring Landscape.

Star History

🛡️ License

Apache License, Version 2.0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

HertzBeat | 中文文档

🎡 Introduction

Features

🥐 Architecture

⛄ Supported

🐕 Quick Start

🍞 Install HertzBeat

1：Install quickly via docker

2：Install via package

3：Start via source code

4：Install All(hertzbeat+mysql+tsdb) via Docker-compose

5. Install All(hertzbeat+collector+mysql+tsdb) via kubernetes helm charts

🥐 Roadmap

✨ Contributors

💬 Join discussion

Channel

Public

Friends

Sponsor

Open-Source Project Build From Open-Source

Landscape

Star History

🛡️ License

Files

README.md

Latest commit

History

README.md

File metadata and controls

HertzBeat | 中文文档

🎡 Introduction

Features

🥐 Architecture

⛄ Supported

🐕 Quick Start

🍞 Install HertzBeat

1：Install quickly via docker

2：Install via package

3：Start via source code

4：Install All(hertzbeat+mysql+tsdb) via Docker-compose

5. Install All(hertzbeat+collector+mysql+tsdb) via kubernetes helm charts

🥐 Roadmap

✨ Contributors

💬 Join discussion

Channel

Public

Friends

Sponsor

Open-Source Project Build From Open-Source

Landscape

Star History

🛡️ License