update doc
1 file changed
tree: cf330e6b63c098b46e450f4dd632324beeed93f5
  1. .github/
  2. .idea/
  3. alerter/
  4. collector/
  5. common/
  6. e2e/
  7. home/
  8. manager/
  9. push/
  10. remoting/
  11. script/
  12. warehouse/
  13. web-app/
  14. .all-contributorsrc
  15. .gitignore
  16. .gitpod.yml
  17. CODE_OF_CONDUCT.md
  18. CONTRIBUTING.md
  19. LICENSE
  20. NOTICE
  21. pom.xml
  22. README.md
  23. README_CN.md
  24. SECURITY.md
README.md

HertzBeat | 中文文档

A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
实时监控系统,无需Agent,性能集群,兼容Prometheus,自定义监控和状态页构建能力。

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

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

🎡 Introduction

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

  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 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
  1. Download the release package hertzbeat-xx.tar.gz GITEE Release 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 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
  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+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

hertzBeat

✨ Contributors

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

💬 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

Github Discussion

Reddit Community

Follow Us Twitter

Subscribe YouTube

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

Star History

Star History Chart

🛡️ License

Apache License, Version 2.0