Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2025-01-20 15:29:24 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

update wiki pages

Vika 2021-03-10 08:14:56 +00:00
parent 51017ade11
commit a79dc1056e
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
BestPractices.md

@ -4,11 +4,11 @@
VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database. It can be used as a long-term, remote storage for Prometheus which allows it to gather metrics from different systems and store them in a single location or separate them for different purposes (short-, long-term, responsibility zones etc). VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database. It can be used as a long-term, remote storage for Prometheus which allows it to gather metrics from different systems and store them in a single location or separate them for different purposes (short-, long-term, responsibility zones etc).
## Install Recommendation ## Install Recommendation
There is no need to tuneVictoriaMetrics 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 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 for 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, so Prometheus instances could establish more connections to VictoriaMetrics (65535 standard production value).
There is no need for 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, so Prometheus instances could establish more connections to VictoriaMetrics (65535 standard production value). ## Filesystem Considerations
Filesystem Considerations
The recommended filesystem is 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: The recommended filesystem is 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:
mkfs.ext4 ... -O 64bit,huge_file,extent -T huge mkfs.ext4 ... -O 64bit,huge_file,extent -T huge
## Operation System ## Operation System
When configuring VictoriaMetrics, the best practice is to use the latest Ubuntu OS version. When configuring VictoriaMetrics, the best practice is to use the latest Ubuntu OS version.
@ -18,12 +18,12 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t
## Upgrade ## Upgrade
It is safe to upgrade VictoriaMetrics to new versions unless the release notes 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 safe to upgrade VictoriaMetrics to new versions unless the release notes 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. 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 process: The following steps must be performed during the upgrade / downgrade process:
Send SIGINT signal to VictoriaMetrics process so that it is stopped gracefully. -Send SIGINT signal to VictoriaMetrics process so that it is stopped gracefully.
Wait until the process stops. This can take a few seconds. -Wait until the process stops. This can take a few seconds.
Start the upgraded VictoriaMetrics. -Start the upgraded VictoriaMetrics.
Prometheus doesn't drop data during theVictoriaMetrics restart. See this article for details. Prometheus doesn't drop data during theVictoriaMetrics restart. See this article for details.
## Security ## Security
Do not forget to protect sensitive endpoints in VictoriaMetrics when exposing them to untrusted networks such as the internet. Please consider setting the following command-line flags: Do not forget to protect sensitive endpoints in VictoriaMetrics when exposing them to untrusted networks such as the internet. Please consider setting the following command-line flags:
@ -34,7 +34,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t
-forceMergeAuthKey for protecting /internal/force_merge endpoint. See force merge docs. -forceMergeAuthKey for protecting /internal/force_merge endpoint. See force merge docs.
-search.resetCacheAuthKey for protecting /internal/resetRollupResultCache endpoint. See backfilling for more details. -search.resetCacheAuthKey for protecting /internal/resetRollupResultCache endpoint. See backfilling for more details.
Explicitly set internal network interface to TCP and UDP ports for data ingestion with Graphite and OpenTSDB formats. For example, substitute -graphiteListenAddr=:2003 with -graphiteListenAddr=<internal_iface_ip>:2003. Explicitly set internal network interface to TCP and UDP ports for data ingestion with Graphite and OpenTSDB formats. For example, substitute -graphiteListenAddr=:2003 with -graphiteListenAddr=<internal_iface_ip>:2003.
It is preferable to authorize all incoming requests from untrusted networks with vmauth or a similar auth proxy. It is preferable to authorize all incoming requests from untrusted networks with vmauth or a similar auth proxy.
## Backup Recommendations ## Backup Recommendations
VictoriaMetrics supports backups via vmbackup and vmrestore tools. We also provide the vmbackuper tool for our paid, enterprise subscribers - see this issue for additional details. VictoriaMetrics supports backups via vmbackup and vmrestore tools. We also provide the vmbackuper tool for our paid, enterprise subscribers - see this issue for additional details.