Skip to main content
Version: v1.5.x

Use Time Series Database VictoriaMetrics to Store Metrics Data (Recommended)

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

It is recommended to use VictoriaMetrics as metrics storage.

VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database.Recommend Version(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+)

Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance ⚠️ If you do not configure a time series database, only the last hour of historical data is retained.

If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step.

Install VictoriaMetrics via Docker​

  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 VictoriaMetrics via Docker

    $ docker run -d -p 8428:8428 \
        -v $(pwd)/victoria-metrics-data:/victoria-metrics-data \
        --name victoria-metrics \
        victoriametrics/victoria-metrics:v1.95.1

    -v $(pwd)/victoria-metrics-data:/victoria-metrics-data is local persistent mount of VictoriaMetrics data directory
    use$ docker ps to check if the database started successfully

  3. Configure the database connection in hertzbeat application.ymlconfiguration file

    Modify hertzbeat/config/application.yml configuration file 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 Config the warehouse.store.jpa.enabled false. Replace warehouse.store.victoria-metrics data source parameters, HOST account and password.

    warehouse:
      store:
         # disable JPA
        jpa:
          enabled: false
        # enable victoria-metrics
        victoria-metrics:
           enabled: true
           url: http://localhost:8428
           username: root
           password: root

  4. Restart HertzBeat

FAQ​

  1. Do both the time series databases 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 can affects the historical chart data.