Apache HertzBeat(incubating) is a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
English Document | ไธญๆๆๆกฃ
A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
Home: hertzbeat.apache.org
Email: Mail to [email protected] 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, Prometheusconfigurable, allowing you to collect any metrics by simply configuring the templateYMLfile 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
Prometheusecosystem and more, can monitoring whatPrometheuscan 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
DiscordSlackTelegramEmailDingtalkWeChatFeiShuWebhookSMSServerChan. - 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.
๐ฅ Architecture
โ Supported
We define all monitoring collection types such as
mysql,jvm, andk8sasYMLmonitoring 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
DiscordSlackTelegramEmailDingtalkWeChatFeiShuWebhookSMSServerChan.
๐ 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
-
Just one command to get started
docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat -
Access
http://localhost:1157to start, default account:admin/hertzbeat -
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
- Download the release package
hertzbeat-xx.tar.gzDownload - Configure the HertzBeat configuration yml file
hertzbeat/config/application.yml(optional) - Run command
$ ./bin/startup.shorbin/startup.bat - Access
http://localhost:1157to start, default account:admin/hertzbeat - Deploy collector clusters (Optional)
- Download the release package
hertzbeat-collector-xx.tar.gzto new machine Download - Configure the collector configuration yml file
hertzbeat-collector/config/application.yml: uniqueidentityname, runningmode(public or private), hertzbeatmanager-host, hertzbeatmanager-portcollector: 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.shorbin/startup.bat - Access
http://localhost:1157and you will see the registered new collector in dashboard
- Download the release package
Detailed config refer to Install HertzBeat via Package
3๏ผStart via source code
- Local source code debugging needs to start the back-end project
managerand the front-end projectweb-app. - Backend๏ผneed
maven3+,java17,lombok, start themanagerservice. - Web๏ผneed
nodejs npm angular-clienvironment, Runng serve --openinweb-appdirectory after backend startup. - Access
http://localhost:4200to 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
โจ Contributors
Thanks to these wonderful people, welcome to join us:
Contributor Guide
๐ฌ Join discussion
Channel
Join the Mailing Lists : Mail to [email protected] to subscribe mailing lists.
WeChat Group : Add friend ahertzbeat and invite to the group.
WeChat Public : Search ID usthecom.
QQ Group : Group num 630061200
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.