赫兹比特

🍞 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

1. 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 apache-hertzbeat-xx-bin.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 apache-hertzbeat-collector-xx-bin.tar.gz (JVM collector) or the native collector package for your platform, such as apache-hertzbeat-collector-native-xx-linux-amd64-bin.tar.gz or apache-hertzbeat-collector-native-xx-windows-amd64-bin.zip, to the 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}
      

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 hertzbeat-startup and the front-end project web-app.
2. Backend：need maven3+, java25, 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 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

🐕 Quick Start

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