Skip to content

Apache HertzBeat(incubating) is a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.

License

Notifications You must be signed in to change notification settings

apache/hertzbeat

Repository files navigation

hertzbeat

A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.

Discord Reddit Twitter OpenSSF Best Practices codecov Docker Pulls Artifact Hub YouTube Channel Subscribers

Home: hertzbeat.apache.org
Email: Mail to dev-subscribe@hertzbeat.apache.org to subscribe mailing lists

🎡 Introduction

Apache HertzBeat (incubating) is an easy-to-use, open source, real-time monitoring system with agentless, high performance cluster, prometheus-compatible, offers powerful custom monitoring and status page building 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.
  • Provides powerful status page building capabilities, easily communicate the real-time status of your service to users.

HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system.


hertzbeat

hertzbeat

hertzbeat


🥐 Architecture

hertzBeat

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

🐕 Quick Start

  • 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 apache/hertzbeat

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

  2. Deploy collector clusters (Optional)

docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/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
  1. Download the release package hertzbeat-xx.tar.gz GITHUB Release
  2. Configure the HertzBeat configuration yml file hertzbeat/config/application.yml (optional)
  3. Run command $ ./bin/startup.sh or bin/startup.bat
  4. Access http://localhost:1157 to start, default account: admin/hertzbeat
  5. Deploy collector clusters (Optional)
    • Download the release package hertzbeat-collector-xx.tar.gz to new machine 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
  1. Local source code debugging needs to start the back-end project manager and the front-end project web-app.
  2. Backend:need maven3+, java17, 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 http://localhost:4200 to start, default account: admin/hertzbeat

Detailed steps refer to CONTRIBUTING

4:Install All(hertzbeat+postgresql+tsdb) via Docker-compose

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

Detailed steps refer to Install via Docker-Compose

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

Install HertzBeat cluster in a Kubernetes cluster by Helm chart.

Detailed steps refer to Artifact Hub

HAVE FUN

🥐 Roadmap

hertzBeat

✨ Contributors

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

tomsun28
tomsun28

💻 📖 🎨
会编程的王学长
会编程的王学长

💻 📖 🎨
MaxKey
MaxKey

💻 🎨 🤔
观沧海
观沧海

💻 🎨 🐛
yuye
yuye

💻 📖
jx10086
jx10086

💻 🐛
winnerTimer
winnerTimer

💻 🐛
goo-kits
goo-kits

💻 🐛
brave4Time
brave4Time

💻 🐛
WalkerLee
WalkerLee

💻 🐛
jianghang
jianghang

💻 🐛
ChineseTony
ChineseTony

💻 🐛
wyt199905
wyt199905

💻
卫傅庆
卫傅庆

💻 🐛
zklmcookle
zklmcookle

💻
DevilX5
DevilX5

📖 💻
tea
tea

💻
yangshihui
yangshihui

💻 🐛
DreamGirl524
DreamGirl524

💻 📖
gzwlly
gzwlly

📖
cuipiheqiuqiu
cuipiheqiuqiu

💻 ⚠️ 🎨
lambert
lambert

💻
mroldx
mroldx

📖
woshiniusange
woshiniusange

📖
VampireAchao
VampireAchao

💻
zcx
zcx

💻 🐛 🎨
CharlieXCL
CharlieXCL

📖
Privauto
Privauto

💻 📖
emrys
emrys

📖
SxLiuYu
SxLiuYu

🐛
All Contributors
All Contributors

📖
铁甲小宝
铁甲小宝

💻 📖
click33
click33

📖
蒋小小
蒋小小

📖
Kevin Huang
Kevin Huang

📖
铁甲小宝
铁甲小宝

🐛 💻 📖
Captain Jack
Captain Jack

📖
haibo.duan
haibo.duan

⚠️ 💻
assassin
assassin

🐛 💻
Reverse wind
Reverse wind

⚠️ 💻
luxx
luxx

💻
Ikko Ashimine
Ikko Ashimine

📖
leizenan
leizenan

💻
BKing
BKing

📖
xingshuaiLi
xingshuaiLi

📖
wangke6666
wangke6666

📖
刺猬
刺猬

🐛 💻
Haste
Haste

💻
zhongshi.yi
zhongshi.yi

📖
Qi Zhang
Qi Zhang

📖
MrAndyMing
MrAndyMing

📖
idongliming
idongliming

💻
Zichao Lin
Zichao Lin

💻 📖
liudonghua
liudonghua

💻 🤔
Jerry
Jerry

💻 ⚠️ 🤔
yanhom
yanhom

📖
fsl
fsl

💻
xttttv
xttttv

📖
NavinKumarBarnwal
NavinKumarBarnwal

💻
Zakkary
Zakkary

📖
sunxinbo
sunxinbo

💻 ⚠️
ldzbook
ldzbook

📖 🐛
余与雨
余与雨

💻 ⚠️
MysticalDream
MysticalDream

💻 ⚠️
zhouyoulin12
zhouyoulin12

💻 ⚠️
jerjjj
jerjjj

💻
wjl110
wjl110

💻
Sean
Sean

📖
chenyiqin
chenyiqin

💻 ⚠️
hudongdong129
hudongdong129

💻 ⚠️ 📖
TherChenYang
TherChenYang

💻 ⚠️
HattoriHenzo
HattoriHenzo

💻 ⚠️
ycilry
ycilry

📖
aoshiguchen
aoshiguchen

📖 💻
蔡本祥
蔡本祥

💻
浮游
浮游

💻
Grass-Life
Grass-Life

💻
xiaohe428
xiaohe428

💻 📖
TableRow
TableRow

📖 💻
ByteIDance
ByteIDance

💻
Jangfe
Jangfe

💻
zqr10159
zqr10159

📖 💻
vinci
vinci

💻 📖 🎨
js110
js110

💻
CrazyLionLi
CrazyLionLi

📖
banmajio
banmajio

💻
topsuder
topsuder

💻
richar2022
richar2022

💻
fcb-xiaobo
fcb-xiaobo

💻
wenkyzhang
wenkyzhang

📖
ZangJuxy
ZangJuxy

📖
l646505418
l646505418

💻
Carpe-Wang
Carpe-Wang

💻
莫枢
莫枢

💻
huangcanda
huangcanda

💻
世纪末的架构师
世纪末的架构师

💻
ShuningWan
ShuningWan

📖
MrYZhou
MrYZhou

📖
suncqujsj
suncqujsj

📖
sunqinbo
sunqinbo

💻
haoww
haoww

📖
i-mayuan
i-mayuan

📖
fengruge
fengruge

📖
zhanghuan
zhanghuan

💻
shenymin
shenymin

💻
Dhruva Chandra
Dhruva Chandra

💻
miss_z
miss_z

📖
wyt990
wyt990

💻
licocon
licocon

💻
Mi Na
Mi Na

💻
Kylin-Guo
Kylin-Guo

📖
Mr灬Dong先生
Mr灬Dong先生

💻
Pratyay Banerjee
Pratyay Banerjee

📖 💻
yujianzhong520
yujianzhong520

💻
SPPan
SPPan

💻
ZhangJiashu
ZhangJiashu

💻
impress
impress

💻
凌晨一点半
凌晨一点半

📖
Eeshaan Sawant
Eeshaan Sawant

💻
nandofromthebando
nandofromthebando

💻
caiboking
caiboking

💻
baixing99
baixing99

💻
Yang Chuang
Yang Chuang

💻
wlin20
wlin20

💻
guojing1983
guojing1983

💻
moxi
moxi

📖
qq471754603
qq471754603

💻
渭雨
渭雨

💻
liuxuezhuo
liuxuezhuo

💻
lisongning
lisongning

💻
YutingNie
YutingNie

💻 📖 🎨
Mike Zhou
Mike Zhou

💻 📖 🎨
小笨蛋
小笨蛋

💻
littlezhongzer
littlezhongzer

💻
ChenXiangxxxxx
ChenXiangxxxxx

💻
Mr.zhou
Mr.zhou

💻
姚贤丰
姚贤丰

💻
lingluojun
lingluojun

💻
1ue
1ue

💻
qyaaaa
qyaaaa

💻
novohit
novohit

💻
zhuoshangyi
zhuoshangyi

💻
ruanliang
ruanliang

📖 💻
Eden4701
Eden4701

💻 📖 🎨
XiaTian688
XiaTian688

📖
liyinjiang
liyinjiang

💻
ZhangJiashu
ZhangJiashu

📖
moghn
moghn

📖
xiaoguolong
xiaoguolong

💻
Smliexx
Smliexx

💻
Naruse
Naruse

📖 💻 🎨
Bala Sukesh
Bala Sukesh

💻
Jinyao Ma
Jinyao Ma

💻
Rick
Rick

💻 ⚠️
东风
东风

💻 🎨 📖
sonam singh
sonam singh

💻
ZhangZixuan1994
ZhangZixuan1994

💻
SHIG
SHIG

💻
泰上老菌
泰上老菌

💻
ldysdu
ldysdu

💻
梁同学
梁同学

💻
avv
avv

💻
yqxxgh
yqxxgh

📖
CharlieShi46
CharlieShi46

💻
Nctllnty
Nctllnty

💻
Wang-Yonghao
Wang-Yonghao

📖
读钓
读钓

💻
Xin
Xin

💻
handy
handy

💻
LiuTianyou
LiuTianyou

💻 📖
WinterKi1ler
WinterKi1ler

💻
miki
miki

💻
Keshav Carpenter
Keshav Carpenter

💻 📖
makechoicenow
makechoicenow

💻
Gao Jian
Gao Jian

💻 🎨
Hyeon Sung
Hyeon Sung

💻
crossoverJie
crossoverJie

💻 📖
PeixyJ
PeixyJ

💻
风如歌
风如歌

💻
Manan Pujara
Manan Pujara

💻
xuziyang
xuziyang

💻
lwqzz
lwqzz

💻
YxYL
YxYL

💻
tomorrowshipyltm
tomorrowshipyltm

📖
栗磊
栗磊

💻
Alan
Alan

📖
Jast
Jast

💻
Zhang Yuxuan
Zhang Yuxuan

💻
P.P.
P.P.

💻
llp2333
llp2333

💻
feiyang li
feiyang li

📖
aias00
aias00

💻
Jin
Jin

📖
YuLuo
YuLuo

💻
xiaoming student
xiaoming student

💻
lwjxy
lwjxy

💻
John
John

💻
boatrainlsz
boatrainlsz

📖
Bill Lau
Bill Lau

💻
lwyang
lwyang

📖
xfl12345
xfl12345

📖
Limbo
Limbo

💻
哈哈哈哈哈哈哈哈哈
哈哈哈哈哈哈哈哈哈

💻
Leon Li
Leon Li

💻
dennis zhuang
dennis zhuang

💻
Kerwin Bryant
Kerwin Bryant

💻

💬 Join discussion

Channel

Join the Mailing Lists : Mail to dev-subscribe@hertzbeat.apache.org to subscribe mailing lists.

Chat On Discord

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

WeChat Public : Search ID usthecom.

QQ Group : Group num 630061200

Github Discussion

Reddit Community

Follow Us Twitter

Subscribe YouTube

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

Star History Chart

🛡️ License

Apache License, Version 2.0