From b9f7cb4e2669631b19c90a2f8c12042b52c6a83b Mon Sep 17 00:00:00 2001 From: Vika Date: Thu, 20 May 2021 13:19:18 +0000 Subject: [PATCH] update wiki pages --- Cluster-VictoriaMetrics.md | 5 +++-- FAQ.md | 30 ++++++++++++++++++++++++++++-- 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/Cluster-VictoriaMetrics.md b/Cluster-VictoriaMetrics.md index 128cc06..7ea98b4 100644 --- a/Cluster-VictoriaMetrics.md +++ b/Cluster-VictoriaMetrics.md @@ -50,14 +50,15 @@ See [these docs](#url-format) for details. Some facts about tenants in VictoriaM * Each `accountID` and `projectID` is identified by an arbitrary 32-bit integer in the range `[0 .. 2^32)`. If `projectID` is missing, then it is automatically assigned to `0`. It is expected that other information about tenants such as auth tokens, tenant names, limits, accounting, etc. is stored in a separate relational database. This database must be managed -by a separate service sitting in front of VictoriaMetrics cluster such as [vmauth](https://docs.victoriametrics.com/vmauth.html). -[Contact us](mailto:info@victoriametrics.com) if you need help with creating such a service. +by a separate service sitting in front of VictoriaMetrics cluster such as [vmauth](https://docs.victoriametrics.com/vmauth.html) or [vmgateway](https://docs.victoriametrics.com/vmgateway.html). [Contact us](mailto:info@victoriametrics.com) if you need assistance with such service. * Tenants are automatically created when the first data point is written into the given tenant. * Data for all the tenants is evenly spread among available `vmstorage` nodes. This guarantees even load among `vmstorage` nodes when different tenants have different amounts of data and different query load. +* The database performance and resource usage doesn't depend on the number of tenants. It depends mostly on the total number of active time series in all the tenants. A time series is considered active if it received at least a single sample during the last hour or it has been touched by queries during the last hour. + * VictoriaMetrics doesn't support querying multiple tenants in a single request. diff --git a/FAQ.md b/FAQ.md index 9acff61..cfaf3a2 100644 --- a/FAQ.md +++ b/FAQ.md @@ -223,6 +223,32 @@ Questions about VictoriaMetrics can be asked via the following channels: File bugs and feature requests [here](https://github.com/VictoriaMetrics/VictoriaMetrics/issues). -### Are you looking for investors? +### Where I can find information about multi-tenancy? -Yes. [Mail us](mailto:info@victoriametrics.com) if you are interested in. +See more details about multi-tenancy [here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#multitenancy). Please note, this feature is supported only by [cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html) version of VictoriaMetrics. + + +### How to set a memory limit for VictoriaMetrics components? + +All the VictoriaMetrics component provide command-line flags to control the size of internal buffers and caches: `-memory.allowedPercent` and `-memory.allowedBytes` (pass `-help` to any VictoriaMetrics component in order to see the description for these flags). These limits don't take into account additional memory, which may be needed for processing incoming queries. Hard limits may be enforced only by the OS via [cgroups](https://en.wikipedia.org/wiki/Cgroups), Docker (see [these docs](https://docs.docker.com/config/containers/resource_constraints)) or Kubernetes (see [these docs](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers)). + +Memory usage for VictoriaMetrics components can be tuned according to the following docs: + +* [Capacity planning for single-node VictoriaMetrics](https://docs.victoriametrics.com/#capacity-planning) +* [Capacity planning for cluster VictoriaMetrics](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#capacity-planning) +* [Troubleshooting for vmagent](https://docs.victoriametrics.com/vmagent.html#troubleshooting) +* [Troubleshooting for single-node VictoriaMetrics](https://docs.victoriametrics.com/#troubleshooting) + + +### Can I use VictoriaMetrics instead of Prometheus? + +Yes in most cases. VictoriaMetrics can substitute Prometheus in the following aspects: + +* Prometheus-compatible service discovery and target scraping can be done with [vmagent](https://docs.victoriametrics.com/vmagent.html) and with single-node VictoriaMetrics - see [these docs](https://docs.victoriametrics.com/#how-to-scrape-prometheus-exporters-such-as-node-exporter). +* Prometheus-compatible alerting rules and recording rules can be processed with [vmalert](https://docs.victoriametrics.com/vmalert.html). +* Prometheus-compatible querying in Grafana is supported by VictoriaMetrics. See [these docs](https://docs.victoriametrics.com/#grafana-setup). + + +### How can I run VictoriaMetrics on FreeBSD? + +VictoriaMetrics is included in FreeBSD ports, so just install it from there. See [this link](https://www.freebsd.org/cgi/ports.cgi?query=victoria&stype=all).