mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
56a6e680e3
### Describe Your Changes
- replace docs in root README with a link to official documentation
- remove old make commands for documentation
- remove redundant "VictoriaMetrics" from document titles
- merge changelog docs into a section
- rm content of Single-server-VictoriaMetrics.md as it can be included from docs/README
- add basic information to README in the root folder, so it will be useful for github users
- rm `picture` tag from docs/README as it was needed for github only, we don't display VM logo at docs.victoriametrics.com
- update `## documentation` section in docs/README to reflect the changes
- rename DD pictures, as they now belong to docs/README
Signed-off-by: hagen1778 <roman@victoriametrics.com>
Co-authored-by: hagen1778 <roman@victoriametrics.com>
(cherry picked from commit 58e667c895)
Signed-off-by: hagen1778 <roman@victoriametrics.com>
78 lines
3.4 KiB
Markdown
78 lines
3.4 KiB
Markdown
---
|
|
sort: 32
|
|
weight: 32
|
|
title: Best practices
|
|
menu:
|
|
docs:
|
|
identifier: vm-best-practices
|
|
parent: 'victoriametrics'
|
|
weight: 32
|
|
aliases:
|
|
- /BestPractices.html
|
|
---
|
|
## Install Recommendation
|
|
|
|
It is recommended running the latest available release of VictoriaMetrics from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest),
|
|
since it contains all the bugfixes and enhancements.
|
|
|
|
There is no need to tune VictoriaMetrics because it uses reasonable defaults for command-line flags. These flags are automatically adjusted for the available CPU and RAM resources. There is no need in Operating System tuning because VictoriaMetrics is optimized for default OS settings. The only option is to increase the limit on the [number of open files in the OS](https://medium.com/@muhammadtriwibowo/set-permanently-ulimit-n-open-files-in-ubuntu-4d61064429a), so VictoriaMetrics could accept more incoming connections and could keep open more data files.
|
|
|
|
## Filesystem
|
|
|
|
The recommended filesystem for VictoriaMetrics is [ext4](https://en.wikipedia.org/wiki/Ext4). If you plan to store more than 1TB of data on ext4 partition or plan to extend 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
|
|
```
|
|
|
|
VictoriaMetrics should work OK with other filesystems too.
|
|
|
|
## Operating System
|
|
|
|
VictoriaMetrics is production-ready for the following operating systems:
|
|
|
|
* Linux (Alpine, Ubuntu, Debian, RedHat, etc.)
|
|
* FreeBSD
|
|
* OpenBSD
|
|
* Solaris/SmartOS
|
|
|
|
There is an experimental support of VictoriaMetrics components for Windows.
|
|
|
|
VictoriaMetrics can run also on MacOS for testing and development purposes.
|
|
|
|
## Supported Architectures
|
|
|
|
* **Linux**: i386, amd64, arm, arm64, ppc64le
|
|
* **FreeBSD**: i386, amd64, arm
|
|
* **OpenBSD**: i386, amd64, arm
|
|
* **Solaris/SmartOS**: i386, amd64
|
|
* **MacOS**: amd64, arm64 (for testing and development purposes)
|
|
* **Windows**: amd64
|
|
|
|
## Upgrade procedure
|
|
|
|
It is safe to upgrade VictoriaMetrics to new versions unless the [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise.
|
|
It is safe to skip multiple versions during the upgrade unless release notes say otherwise. It is recommended to perform regular upgrades to the latest version,
|
|
since it may contain important bug fixes, performance optimizations or new features.
|
|
|
|
It is also safe to downgrade to the previous version unless release notes say otherwise.
|
|
|
|
The following steps must be performed during the upgrade / downgrade procedure:
|
|
|
|
* Send SIGINT signal to VictoriaMetrics process so that it is stopped gracefully.
|
|
* Wait until the process stops. This can take a few seconds.
|
|
* Start the upgraded VictoriaMetrics.
|
|
|
|
## Backup Recommendations
|
|
|
|
VictoriaMetrics supports backups via [vmbackup](https://docs.victoriametrics.com/vmbackup/) and [vmrestore](https://docs.victoriametrics.com/vmrestore/) tools. There is also [vmbackupmanager](https://docs.victoriametrics.com/vmbackupmanager/), which simplifies backup automation.
|
|
|
|
## Technical Support and Services
|
|
|
|
There are the following channels for providing technical support for VictoriaMetrics:
|
|
|
|
* [GitHub issues](https://github.com/VictoriaMetrics/VictoriaMetrics/issues)
|
|
* [Slack Inviter](https://slack.victoriametrics.com/) and [Slack channel](https://victoriametrics.slack.com/)
|
|
* [Telegram channel](https://t.me/VictoriaMetrics_en)
|
|
|
|
We also provide [Enterprise support](https://docs.victoriametrics.com/enterprise/).
|