README.md

HertzBeat | 中文文档

An open-source, real-time monitoring system with custom monitoring and agentless capabilities. | 易用友好的开源实时监控告警系统，无需Agent，强大自定义监控能力.

Home: hertzbeat.dromara.org | hertzbeat.com

Cloud: tancloud.cn

🎡 Introduction

HertzBeat is an open source, real-time monitoring system with custom monitoring and agentless capabilities.
It combines monitoring, alarm, and notification features into one platform, and supports monitoring for web service, database, os, middleware, cloud-native, network and more.

Features

• Easy to use, offering full web-based operations for monitoring and alerting with just a click of a mouse, all at zero learning cost.
• Provides a more flexible threshold rules and timely notifications delivered via Discord Slack Telegram Email DingDing WeChat FeiShu Webhook SMS.
• Makes protocols such as Http, Jmx, Ssh, Snmp, Jdbc configurable, allowing you to collect any desired metrics by simply configuring the YML file online. Imagine being able to quickly adapt to a new monitoring type like K8s or Docker simply by configuring online with HertzBeat.
• Powerful customization, multi-type support, easy expansion, and low coupling.

HertzBeat aims to help developers and teams quickly build their own monitoring system. We also provide Monitoring SaaS Cloud, users no longer need to deploy a cumbersome monitoring system to monitor their resources. Get started 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
• Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, DM, OpenGauss, ClickHouse, IoTDB, Redis Cluster, Redis Sentinel
• 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
• Kubernetes, Docker
• CiscoSwitch, HpeSwitch, HuaweiSwitch, TpLinkSwitch, H3cSwitch
• And More Your Custom Template.
• Notified Support Discord Slack Telegram Email DingDing WeChat FeiShu Webhook SMS.

🐕 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

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 localhost:1157 to start, default account: admin/hertzbeat

Detailed config refer to Install HertzBeat via Docker

2：Install via package

1. Download the installation package GITEE Release GITHUB Release
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

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

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.

Detailed steps refer to Install via Docker-Compose

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 💻

💬 Join discussion

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

Channel

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

QQ Group : Add group num 236915833

Gitter Channel

Github Discussion

User Club

Public

Friends

• DynamicTp : 轻量级动态线程池，内置监控告警功能，集成三方中间件线程池管理，基于主流配置中心
• Hippo4j : 强大的动态线程池框架，附带监控报警功能
• Jpom : 简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
• ArgusDBM : 开源数据库一体化监控平台，致力于监控所有数据库

Sponsor

• Postcat An Open Source API Tool supporting api test, mock, documentation, team collaboration etc.
• Thanks 吉实信息(构建全新的微波+光交易网络) sponsored server node.
• Thanks 蓝易云(全新智慧上云) sponsored server node.

🛡️ License

Apache License, Version 2.0