victoriametrics/victoria-metrics repository overview

⁠VictoriaMetrics

⁠What is victoria-metrics?

victoria-metrics is the single-node version of VictoriaMetrics, a fast, cost-effective, and scalable time series database (TSDB) and monitoring solution. It combines all the necessary components for ingestion, storage, and querying into a single, easy-to-deploy binary, making it perfect for small to medium-sized setups or for getting started quickly.

⁠How to Use This Image

Run a single-node VictoriaMetrics instance:

docker run -d --name victoriametrics -p 8428:8428 victoriametrics/victoria-metrics:latest

Common Scenarios:

Persisting Data: To store data on the host machine, mount a volume to the container.

docker run -d --name victoriametrics -p 8428:8428 \
  -v /path/to/vmdata:/victoria-metrics-data \
  victoriametrics/victoria-metrics:latest \
  -storageDataPath=/victoria-metrics-data

⁠Configuration

• -storageDataPath: The path to the directory where time series data is stored. Default: victoria-metrics-data.

• -retentionPeriod: Specifies how long to keep the data. For example, 3m for 3 months or 1y for one year. Default: 1m (1 month).

• -httpListenAddr: The TCP address to listen on for HTTP requests. Default: :8428.

⁠Advanced Usage

While the flags above cover common use cases, VictoriaMetrics is highly configurable. You can view all available configuration flags, their descriptions, and default values by passing the --help flag to the container.

docker run --rm victoriametrics/victoria-metrics:latest --help

For comprehensive details on configuration and tuning, please refer to the official documentation⁠.

⁠Benchmarking VictoriaMetrics

VictoriaMetrics is built for performance and resource efficiency. We encourage you to compare it against other time series databases like TimescaleDB, InfluxDB, Thanos, Mimir, M3, and Cortex on your own workloads.

When comparing, pay close attention to RAM usage, CPU usage, and on-disk storage size. and feel free to share your results with the community!

⁠Where to Get Help

⁠Source Code

The source code for victoria-metrics is available on GitHub: https://github.com/VictoriaMetrics/VictoriaMetrics⁠