From 67b4059aa43b4aa64b93d139a7eab46ad7384fa7 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Tue, 29 Oct 2024 11:23:20 +0100 Subject: [PATCH] docs/VictoriaLogs/README.md: add `tuning` chapter --- docs/VictoriaLogs/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/VictoriaLogs/README.md b/docs/VictoriaLogs/README.md index dcdaff12d..a818b7b95 100644 --- a/docs/VictoriaLogs/README.md +++ b/docs/VictoriaLogs/README.md @@ -31,6 +31,20 @@ you can join it via [Slack Inviter](https://slack.victoriametrics.com/). See [Quick start docs](https://docs.victoriametrics.com/victorialogs/quickstart/) for start working with VictoriaLogs. +## Tuning + +* No need in tuning for VictoriaLogs - it uses reasonable defaults for command-line flags, which are automatically adjusted for the available CPU and RAM resources. +* No need in tuning for Operating System - VictoriaLogs is optimized for default OS settings. + The only option is increasing the limit on [the number of open files in the OS](https://medium.com/@muhammadtriwibowo/set-permanently-ulimit-n-open-files-in-ubuntu-4d61064429a). +* The recommended filesystem is `ext4`, the recommended persistent storage is [persistent HDD-based disk on GCP](https://cloud.google.com/compute/docs/disks/#pdspecs), + since it is protected from hardware failures via internal replication and it can be [resized on the fly](https://cloud.google.com/compute/docs/disks/add-persistent-disk#resize_pd). + If you plan to store more than 1TB of data on `ext4` partition or plan extending it to more than 16TB, + then the following options are recommended to pass to `mkfs.ext4`: + +```sh +mkfs.ext4 ... -O 64bit,huge_file,extent -T huge +``` + ## Monitoring VictoriaLogs exposes internal metrics in Prometheus exposition format at `http://localhost:9428/metrics` page.