victoriametrics/vmstorage repository overview

⁠VictoriaMetrics Cluster

⁠What is the VictoriaMetrics Cluster?

The VictoriaMetrics cluster is composed of three main services that scale independently.

• vminsert: Accepts incoming data and routes it to vmstorage nodes.
• vmselect: Receives queries, fetches data from all vmstorage nodes, and merges the results.
• vmstorage: Stores the time series data and handles requests from vminsert and vmselect.

⁠How to Use These Images

Running a cluster involves networking all three components together. Below is a simplified example.

⁠Run vmstorage:

docker run -d --name vmstorage -p 8482:8482 -p 8400:8400 -p 8401:8401

-v /path/to/vmdata-cluster:/storage

victoriametrics/vmstorage:latest

-storageDataPath=/storage -vminsertAddr=:8400 -vmselectAddr=:8401

⁠Run vminsert:

docker run -d --name vminsert -p 8480:8480

victoriametrics/vminsert:latest

-storageNode=vmstorage:8400

⁠Run vmselect:

docker run -d --name vmselect -p 8481:8481

victoriametrics/vmselect:latest

-storageNode=vmstorage:8400

⁠Configuration

• -storageNode (vminsert/vmselect): Address of vmstorage nodes. Can be specified multiple times.
• -storageDataPath (vmstorage): Path to data directory.
• -retentionPeriod (vmstorage): Data retention period.
• -vminsertAddr / -vmselectAddr (vmstorage): The address where vmstorage listens for internal traffic from vminsert and vmselect.

⁠Where to Get Help

If you have any questions, feel free to reach out to the VictoriaMetrics community.

• Slack: Join our community Slack⁠
• Community Forum: Ask questions on our community forum⁠
• Bug Reports: File a bug report on GitHub⁠

⁠Source Code

The source code for each cluster component is available in the VictoriaMetrics GitHub repository:

• vminsert: https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vminsert⁠
• vmselect: https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmselect⁠
• vmstorage: https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmstorage⁠

`vmstorage` is a component of [VictoriaMetrics cluster](https://docs.victoriametrics.com/cluster-victoriametrics/#architecture-overview).

### Docker Pull Command

We recommend specifying the exact tag of the image:

docker pull victoriametrics/vmstorage:{TAG}

See [how to start VictoriaMetrics cluster via docker](https://docs.victoriametrics.com/victoriametrics/quick-start/#starting-vm-cluster-via-docker).

See examples of configuring [VictoriaMetrics cluster](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/deployment/docker#victoriametrics-cluster).