Skip to main content
Version: v1.3.x

Use Time Series Database GreptimeDB to Store Metrics Data (Optional)

HertzBeat's historical data storage depends on the time series database GreptimeDB, TDengine or IoTDB, choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)

GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency.

It's designed to work on infrastructure of the cloud era, and users benefit from its elasticity and commodity storage.

⚠️ If you do not configure a time series database, only the last hour of historical data is retained.

Install GreptimeDB via Docker

Refer to the official website installation tutorial

  1. Download and install Docker environment
    Docker tools download refer to Docker official document.
    After the installation you can check if the Docker version normally output at the terminal.
    $ docker -v
    Docker version 20.10.12, build e91ed57
  2. Install GreptimeDB with Docker
$ docker run -p 4000-4004:4000-4004 \
-p 4242:4242 -v /opt/greptimedb:/tmp/greptimedb \
--name greptime \
greptime/greptimedb standalone start \
--http-addr \
--rpc-addr \

-v /opt/greptimedb:/tmp/greptimedb is local persistent mount of greptimedb data directory. /opt/greptimedb should be replaced with the actual local directory. use$ docker ps to check if the database started successfully

Configure the database connection in hertzbeat application.yml configuration file

  1. Configure HertzBeat's configuration file
    Modify hertzbeat/config/application.yml configuration file /script/application.yml
    Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify hertzbeat/config/application.yml
    Replace data source parameters, URL account and password.
# disable jpa
enabled: false
# enable greptime
enabled: true
endpoint: localhost:4001
  1. Restart HertzBeat


  1. Do both the time series databases Greptime, IoTDB or TDengine need to be configured? Can they both be used?

You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data.