VictoriaMetrics/docs/Quick-Start.md

sort
13

Quick start

Installation

Single-server-VictoriaMetrics VictoriaMetrics is available as:

• Managed VictoriaMetrics at AWS
• Docker images
• Snap packages
• Helm Charts
• Binary releases
• Source code. See How to build from sources
• VictoriaMetrics on Linode
• VictoriaMetrics on DigitalOcean

Just download VictoriaMetrics and follow these instructions. Then read Prometheus setup and Grafana setup docs.

Starting VM-Signle via Docker:

The following commands download the latest available Docker image of VictoriaMetrics and start it at port 8428, while storing the ingested data at victoria-metrics-data subdirectory under the current directory:

docker pull victoriametrics/victoria-metrics:latest
docker run -it --rm -v `pwd`/victoria-metrics-data:/victoria-metrics-data -p 8428:8428 victoriametrics/victoria-metrics:latest

Open http://localhost:8428 in web browser and read these docs.

There are also the following versions of VictoriaMetrics available:

• VictoriaMetrics cluster - horizontally scalable VictoriaMetrics, which scales to multiple nodes.

Starting VM-Cluster via Docker:

The following commands clone the latest available VictoriaMetrics cluster repository and start the docker container via 'docker-compose'. Further customization is possible by editing the docker-compose.yaml file.

git clone https://github.com/VictoriaMetrics/VictoriaMetrics --branch cluster && cd VictoriaMetrics/deployment/docker && docker-compose up

• Cluster setup

Writing data

Data can be written to VictoriaMetrics in the following ways:

• DataDog agent
• InfluxDB-compatible agents such as Telegraf
• Graphite-compatible agents such as StatsD
• OpenTSDB-compatible agents
• Prometheus remote_write API
• In JSON line format
• Imported in CSV format
• Imported in Prometheus exposition format
• /api/v1/import for importing data obtained from /api/v1/export. See these docs for details.

Reading data

VictoriaMetrics various APIs for reading the data. This document briefly describes these APIs.

Grafana setup:

Create Prometheus datasource in Grafana with the following url:

http://<victoriametrics-addr>:8428

Substitute <victoriametrics-addr> with the hostname or IP address of VictoriaMetrics.

Then build graphs and dashboards for the created datasource using PromQL or MetricsQL.