Readme: English | 中文 | 日本語

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

Apache HertzBeat™ is an AI-powered next-generation open source real-time observability system. Unified metrics and logs collection, centralized alerting distribution, intelligent management and analysis. No Agent required, high performance cluster, provides powerful custom monitoring and status page building capabilities.

• Integrates collection + analysis + alerting + notification into one platform, with new AI-powered interactions and features under HertzBeat AI, and built-in MCP Server capabilities.
• Unified metrics platform, agentless, Prometheus-compatible, supports application services, programs, databases, caches, operating systems, big data, middleware, web servers, cloud-native, networks, custom monitoring and more.
• Unified logging platform, seamlessly integrates multiple log sources through OTLP protocol for reporting.
• Unified alerting platform, integrates internal alerts with various external alert sources, unified alert processing and analysis, flexible real-time and periodic threshold rules, grouping convergence, silence, suppression, etc.
• Unified message distribution, alerts processed by the alerting platform are distributed via Email Discord Slack Telegram DingTalk WeChat FeiShu SMS Webhook ServerChan and other methods.
• 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.
• High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration.
• Provides powerful status page building capabilities, easily communicate the real-time status of your service to users.

HertzBeat's unified platform, AI intelligence, powerful customization, multi-type support, high performance, and easy expansion, aims to help users quickly and conveniently achieve observability requirements.

• Community alpha preview users can start from docs/alpha-preview.md for the current Next.js frontend, entity-centered observability, local smoke, and known alpha limitations.

• If you wish to deploy HertzBeat locally, please refer to the following Deployment Documentation for instructions.

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

1. Just one command to get started

   docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat

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

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

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

1. Local source code debugging needs to start the back-end project hertzbeat-startup and the front-end project web-app.
2. Backend: need maven3+, Java 25, and lombok; add VM options in IDE: --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED, then start the hertzbeat-startup service.
3. Web: need Node.js 22 and pnpm 10, run corepack pnpm@10.9.0 install --frozen-lockfile && corepack pnpm@10.9.0 dev in web-app after backend startup.
4. Access http://localhost:4200 to start, default account: admin/hertzbeat

Detailed steps refer to CONTRIBUTING

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

Install HertzBeat cluster in a Kubernetes cluster by Helm chart.

Detailed steps refer to Artifact Hub

HAVE FUN

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

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

Chat On Discord

WeChat Group : Add friend ahertzbeat and invite to the group.

WeChat Public : Search ID usthecom.

QQ Group : Group num 1035688434

Github Discussion

Reddit Community

Follow Us Twitter

Subscribe YouTube

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 Next.js React Tailwind CSS Node.js Npm ECharts G6 MonacoEditor Docusaurus ...

  

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

Apache License, Version 2.0