Project: HertzBeat (Observability and Analysis / Observability)
File: docker-deploy.md

id: docker-deploy title: Install HertzBeat via Docker sidebar_label: Install via Docker Recommend to use docker deploy HertzBeat Download and install the Docker environment Docker tools download refer to After the installation you can check if the Docker version normally output at the terminal. ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` pull HertzBeat Docker mirror you can look up the mirror version TAG in or in ```shell $ docker pull apache/hertzbeat $ docker pull apache/hertzbeat-collector ``` or ```shell $ docker pull quay.io/tancloud/hertzbeat $ docker pull quay.io/tancloud/hertzbeat-collector ``` Mounted HertzBeat configuration file (optional) Download and config `application.yml` in the host directory, eg:`$(pwd)/application.yml` Download from or . You can modify the configuration yml file according to your needs. If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` Recommended If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see Recommended If you need to use the time series database TDengine to store metric data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see Recommended If you need to use the time series database IotDB to store the metric database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see Mounted the account file(optional) HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` If you need update account or password, configure `sureness.yml`. Ignore this step without this demand. Download and config `sureness.yml` in the host directoryeg:`$(pwd)/sureness.yml` Download from or For detail steps, please refer to Start the HertzBeat Docker container ```shell $ docker run -d -p 1157:1157 -p 1158:1158 \ -e LANG=en_US.UTF-8 \ -e TZ=Asia/Shanghai \ -v $(pwd)/data:/opt/hertzbeat/data \ -v $(pwd)/logs:/opt/hertzbeat/logs \ -v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml \ -v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml \ --name hertzbeat apache/hertzbeat ``` This command starts a running HertzBeat Docker container with mapping port 1157-1158. If existing processes on the host use the port, please modify host mapped port. `docker run -d` : Run a container in the background via Docker `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port. `-e LANG=en_US.UTF-8` : Set the system language `-e TZ=Asia/Shanghai` : Set the system timezone `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container. `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional, if you don't have a need, just delete it) Mount the log file to the local host, to ensure the log will not be lost due creating or deleting container. `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional, if you don't have a need, just delete it) Mount the local configuration file into the container which has been modified in the previous step, namely using the local configuration file to cover container configuration file. `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional, if you don't have a need, just delete it) Mount account configuration file modified in the previous step into the container. Delete this command parameters if no needs. `--name hertzbeat` : Naming container name hertzbeat `apache/hertzbeat` : Use the pulled latest HertzBeat official application mirror to start the container. Use `quay.io/tancloud/hertzbeat` instead if you pull `quay.io` docker image. Begin to explore HertzBeat Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! Deploy collector cluster (Optional) ```shell $ docker run -d \ -e IDENTITY=custom-collector-name \ -e MODE=public \ -e

\ -e MANAGER_PORT=1158 \ --name hertzbeat-collector apache/hertzbeat-collector ``` This command starts a running HertzBeat-Collector container. `docker run -d` : Run a container in the background via Docker `-e IDENTITY=custom-collector-name` : (optional) Set the collector unique identity name. Attention the clusters collector name must unique. `-e MODE=public` : set the running mode(public or private), public cluster or private cloud-edge. `-e MANAGER_HOST=127.0.0.1` : Important Set the main hertzbeat server ip. `-e MANAGER_PORT=1158` : (optional) Set the main hertzbeat server port, default 1158. `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` : (optional) Mount the log file to the local host, to ensure the log will not be lost due creating or deleting container. `--name hertzbeat-collector` : Naming container name hertzbeat-collector `apache/hertzbeat-collector` : Use the pulled latest HertzBeat-Collector official application mirror to start the container. Use `quay.io/tancloud/hertzbeat-collector` instead if you pull `quay.io` docker image. Access `http://localhost:1157` and you will see the registered new collector in dashboard. HAVE FUN The most common problem is network problems, please check in advance MYSQL, TDENGINE, IoTDB and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail The problems lies in Docker container failed to visit and connect localhost port. Because the docker default network mode is Bridge mode which can't access local machine through localhost. Solution AConfigure application.yml. Change database connection address from localhost to external IP of the host machine. Solution BUse the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` According to the process deployvisit http://ip:1157/ no interface Please refer to the following points to troubleshoot issues 1If you switch to dependency service MYSQL databasecheck whether the database is created and started successfully. 2Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. 3`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community. Log an error TDengine connection or insert SQL failed 1Check whether database account and password configured is correct, the database is created. 2If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. Historical monitoring charts have been missing data for a long time 1Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data. 2Check whether Tdengine database `hertzbeat` is created. 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. If the history chart on the monitoring page is not displayedpopup [please configure time series database] As shown in the popup windowthe premise of history chart display is that you need install and configure hertzbeat's dependency service - IoTDB or TDengine database. Installation and initialization this database refer to or The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database] Please check if the configuration parameters are correct Is iot-db or td-engine enable set to true NoteIf both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed You can check the startup logs according to the logs directory