github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/docs/Quick-Start.md

2.3 KiB
Raw Blame History

Quick Start

  1. If you run Ubuntu, then just run snap install victoriametrics command in order to install and start VictoriaMetrics, then read these docs. Otherwise download the latest VictoriaMetrics release from releases page, from Docker hub or build it from sources.

  2. This step isn't needed if you run VictoriaMetrics via snap install victoriametrics as described above. Otherwise run the binary or Docker image with the desired command-line flags. Pass -help in order to see description for all the available flags and their default values. Default flag values should fit the majoirty of cases. The minimum required flags to configure are:

    • -storageDataPath - path to directory where VictoriaMetrics stores all the data.
    • -retentionPeriod - data retention.

    For instance:

    ./victoria-metrics-prod -storageDataPath=/var/lib/victoria-metrics-data -retentionPeriod=3

    See these instructions in order to configure VictoriaMetrics as OS service. It is recommended setting up VictoriaMetrics monitoring.

  3. Configure vmagent or Prometheus to write data to VictoriaMetrics. It is recommended to use vmagent instead of Prometheus, since it is more resource efficient. If you still prefer Prometheus, then see these instructions for details on how to configure Prometheus.

  4. Configure Grafana to query VictoriaMetrics instead of Prometheus. See these instructions.

There is also cluster version and SaaS playground.