github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-01 14:47:38 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/docs/Cluster-VictoriaMetrics.md

1973 lines
184 KiB
Markdown
Raw Normal View History

docs: update docs ordering and formatting (#1192) The major change is adding `sort` directive to docs. For those docs which are copied from internal packages `sort` is added via makefile command. For the rest it is added manually since they're updated manually as well. The rest of changes is connected with markdown formatting. For example, changing headers in some files (`##` => `#`) makes navigation on .github.io to look better. This especially useful for `changelog` docs. Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io. No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 10:39:16 +00:00
---
prepare static docs to migration Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-30 10:31:45 +00:00
weight: 2
menu:
docs:
docs: grouped changelog docs, removed old make commands, replaced docs in root README with official docs links (#6727) ### 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 58e667c89511ea86a22b88b6a1379bb342b8dd01) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-07-31 14:03:18 +00:00
identifier: vm-cluster-version
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
parent: 'victoriametrics'
prepare static docs to migration Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-30 10:31:45 +00:00
weight: 2
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
title: Cluster version
prepare static docs to migration Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-30 10:31:45 +00:00
aliases:
- /Cluster-VictoriaMetrics.html
docs: update docs ordering and formatting (#1192) The major change is adding `sort` directive to docs. For those docs which are copied from internal packages `sort` is added via makefile command. For the rest it is added manually since they're updated manually as well. The rest of changes is connected with markdown formatting. For example, changing headers in some files (`##` => `#`) makes navigation on .github.io to look better. This especially useful for `changelog` docs. Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io. No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 10:39:16 +00:00
---
docs/Cluster-VictoriaMetrics.md: move VictoriaMetrics logo below "Cluster version" heading, since it is heeded for proper navigation at https://victoriametrics.github.io
2020-06-24 09:05:40 +00:00
docs/Cluster-VictoriaMetrics.md: document Graphite Render API endpoint
2021-02-03 10:03:40 +00:00
VictoriaMetrics is a fast, cost-effective and scalable time series database. It can be used as a long-term remote storage for Prometheus.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
It is recommended to use the [single-node version](https://github.com/VictoriaMetrics/VictoriaMetrics) instead of the cluster version
for ingestion rates lower than a million data points per second.
The single-node version [scales perfectly](https://medium.com/@valyala/measuring-vertical-scalability-for-time-series-databases-in-google-cloud-92550d78d8ae)
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
with the number of CPU cores, RAM and available storage space.
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
The single-node version is easier to configure and operate compared to the cluster version, so think twice before choosing the cluster version.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
See [this question](https://docs.victoriametrics.com/faq/#which-victoriametrics-type-is-recommended-for-use-in-production---single-node-or-cluster) for more details.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
There is also user-friendly database for logs - [VictoriaLogs](https://docs.victoriametrics.com/victorialogs/).
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
docs: mention slack inviter and slack channel (#5817) Signed-off-by: Artem Navoiev <tenmozes@gmail.com> (cherry picked from commit 5b652bccadda84212fb6686f55c128901ba36fd5)
2024-02-19 16:18:31 +00:00
If you have questions about VictoriaMetrics, then feel free asking them at [VictoriaMetrics community Slack chat](https://victoriametrics.slack.com/),
you can join it via [Slack Inviter](https://slack.victoriametrics.com/).
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
[Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
See [features available in enterprise package](https://docs.victoriametrics.com/enterprise/).
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Enterprise binaries can be downloaded and evaluated for free
docs: use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest instead of https://github.com/VictoriaMetrics/VictoriaMetrics/releases link where needed The https://github.com/VictoriaMetrics/VictoriaMetrics/releases link may show non-latest releases at the top, such as LTS releases or VictoriaLogs releases. So it is better to use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest link, which always redirect to the latest available release of VictoriaMetrics.
2023-10-18 18:06:23 +00:00
from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest).
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/).
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/changelog/) and performing [regular upgrades](#how-to-upgrade-victoriametrics).
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
VictoriaMetrics has achieved security certifications for Database Software Development and Software-Based Monitoring Services. We apply strict security measures in everything we do. See our [Security page](https://victoriametrics.com/security/) for more details.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
## Prominent features
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
- Supports all the features of the [single-node version](https://github.com/VictoriaMetrics/VictoriaMetrics).
- Performance and capacity scale horizontally. See [these docs for details](#cluster-resizing-and-scalability).
app/vminsert: add `-replicationFactor` command-line flag for enabling data replication among available -storageNode instances
2020-05-27 14:29:37 +00:00
- Supports multiple independent namespaces for time series data (aka multi-tenancy). See [these docs for details](#multitenancy).
- Supports replication. See [these docs for details](#replication-and-data-safety).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
## Architecture overview
VictoriaMetrics cluster consists of the following services:
docs/Cluster-VictoriaMetrics.md: clarify docs about VictoriaMetrics cluster architecture
2021-06-18 11:35:55 +00:00
- `vmstorage` - stores the raw data and returns the queried data on the given time range for the given label filters
- `vminsert` - accepts the ingested data and spreads it among `vmstorage` nodes according to consistent hashing over metric name and all its labels
- `vmselect` - performs incoming queries by fetching the needed data from all the configured `vmstorage` nodes
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Each service may scale independently and may run on the most suitable hardware.
README.md: mention that VictoriaMetrics is built on `shared nothing` architecture
2019-12-05 18:37:27 +00:00
`vmstorage` nodes don't know about each other, don't communicate with each other and don't share any data.
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
This is a [shared nothing architecture](https://en.wikipedia.org/wiki/Shared-nothing_architecture).
It increases cluster availability, and simplifies cluster maintenance as well as cluster scaling.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
view documentation locally (#6677) - moved files from root to VictoriaMetrics folder to be able to mount operator docs and VictoriaMetrics docs independently - added ability to run website locally The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/).
2024-07-24 08:00:31 +00:00
![Cluster Scheme](Cluster-VictoriaMetrics_cluster-scheme.webp)
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs: add more details to -cacheDataPath vmselect flag (#6708) vmselect will create `./tmp` dir under `cacheDataPath`. If `cacheDataPath` is set to `/`, vmselect will use `/tmp`. content under `/tmp` dir might be auto removed based on the OS behaviour. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5770 - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: hagen1778 <roman@victoriametrics.com>
2024-08-13 13:17:43 +00:00
> Note that `vmselect` despite being stateless still requires some disk space (a few GBs) for temporary caches. Refer to the `-cacheDataPath` command-line flag for more details.
docs: add vmui section to cluster docs It looks like users get confused with vmui availability in vmselect. Adding a note about it to cluster docs should improve situation. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/7631 Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-11-24 13:18:26 +00:00
## vmui
VictoriaMetrics cluster version provides UI for query troubleshooting and exploration. The UI is available at
`http://<vmselect>:8481/select/<accountID>/vmui/` in each `vmeselect` service.
The UI allows exploring query results via graphs and tables. See more details about [vmui](https://docs.victoriametrics.com/#vmui).
docs/Cluster-VictoriaMetrics.md: add `Multitenancy` chapter
2020-05-03 15:00:40 +00:00
## Multitenancy
VictoriaMetrics cluster supports multiple isolated tenants (aka namespaces).
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
Tenants are identified by `accountID` or `accountID:projectID`, which are put inside request URLs for writes and reads.
app/vminsert: allows parsing tenant id from labels (#3009) * app/vminsert: allows parsing tenant id from labels it should help mitigate issues with vmagent's multiTenant mode, which works incorrectly at heavy load and it cannot handle more then 100 different tenants. This functional hidden with flag and do not change vminsert default behaviour https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2970 * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * wip * app/vminsert/netstorage: clean remaining labels in order to free up GC * docs/Cluster-VictoriaMetrics.md: typo fix * wip * wip Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-30 14:28:35 +00:00
See [these docs](#url-format) for details.
Some facts about tenants in VictoriaMetrics:
docs/Cluster-VictoriaMetrics.md: add `Multitenancy` chapter
2020-05-03 15:00:40 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- Each `accountID` and `projectID` is identified by an arbitrary 32-bit integer in the range `[0 .. 2^32)`.
docs/Cluster-VictoriaMetrics.md: add `Multitenancy` chapter
2020-05-03 15:00:40 +00:00
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
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
by a separate service sitting in front of VictoriaMetrics cluster such as [vmauth](https://docs.victoriametrics.com/vmauth/)
or [vmgateway](https://docs.victoriametrics.com/vmgateway/). [Contact us](mailto:info@victoriametrics.com) if you need assistance with such service.
docs/Cluster-VictoriaMetrics.md: add `Multitenancy` chapter
2020-05-03 15:00:40 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- Tenants are automatically created when the first data point is written into the given tenant.
docs/Cluster-VictoriaMetrics.md: add `Multitenancy` chapter
2020-05-03 15:00:40 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- Data for all the tenants is evenly spread among available `vmstorage` nodes. This guarantees even load among `vmstorage` nodes
docs/Cluster-VictoriaMetrics.md: add `Multitenancy` chapter
2020-05-03 15:00:40 +00:00
when different tenants have different amounts of data and different query load.
docs: make all statement of active time series consistent (#7242) ### Describe Your Changes https://github.com/VictoriaMetrics/VictoriaMetrics/issues/7212 ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). (cherry picked from commit 343463fc0fa5ec9d3375aad7cd788b4d8b5603c7)
2024-10-14 13:38:34 +00:00
- 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](https://docs.victoriametrics.com/faq/#what-is-an-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.
docs/Cluster-VictoriaMetrics.md: add `Multitenancy` chapter
2020-05-03 15:00:40 +00:00
{app/vmstorage,app/vmselect}: add API to get list of existing tenants (#3348) * {app/vmstorage,app/vmselect}: add API to get list of existing tenants * {app/vmstorage,app/vmselect}: add API to get list of existing tenants * app/vmselect: fix error message * {app/vmstorage,app/vmselect}: fix error messages * app/vmselect: change log level for error handling * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-11-25 18:32:45 +00:00
- The list of registered tenants can be obtained via `http://<vmselect>:8481/admin/tenants` url. See [these docs](#url-format).
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- VictoriaMetrics exposes various per-tenant statistics via metrics - see [these docs](https://docs.victoriametrics.com/pertenantstatistic/).
{app/vmstorage,app/vmselect}: add API to get list of existing tenants (#3348) * {app/vmstorage,app/vmselect}: add API to get list of existing tenants * {app/vmstorage,app/vmselect}: add API to get list of existing tenants * app/vmselect: fix error message * {app/vmstorage,app/vmselect}: fix error messages * app/vmselect: change log level for error handling * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-11-25 18:32:45 +00:00
app/vminsert: allows parsing tenant id from labels (#3009) * app/vminsert: allows parsing tenant id from labels it should help mitigate issues with vmagent's multiTenant mode, which works incorrectly at heavy load and it cannot handle more then 100 different tenants. This functional hidden with flag and do not change vminsert default behaviour https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2970 * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * wip * app/vminsert/netstorage: clean remaining labels in order to free up GC * docs/Cluster-VictoriaMetrics.md: typo fix * wip * wip Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-30 14:28:35 +00:00
See also [multitenancy via labels](#multitenancy-via-labels).
docs: re-structure multitenancy docs Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-11-25 12:10:30 +00:00
### Multitenancy via labels
app/vminsert: allows parsing tenant id from labels (#3009) * app/vminsert: allows parsing tenant id from labels it should help mitigate issues with vmagent's multiTenant mode, which works incorrectly at heavy load and it cannot handle more then 100 different tenants. This functional hidden with flag and do not change vminsert default behaviour https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2970 * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * wip * app/vminsert/netstorage: clean remaining labels in order to free up GC * docs/Cluster-VictoriaMetrics.md: typo fix * wip * wip Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-30 14:28:35 +00:00
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
**Writes**
app/vminsert: allows parsing tenant id from labels (#3009) * app/vminsert: allows parsing tenant id from labels it should help mitigate issues with vmagent's multiTenant mode, which works incorrectly at heavy load and it cannot handle more then 100 different tenants. This functional hidden with flag and do not change vminsert default behaviour https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2970 * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * wip * app/vminsert/netstorage: clean remaining labels in order to free up GC * docs/Cluster-VictoriaMetrics.md: typo fix * wip * wip Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-30 14:28:35 +00:00
`vminsert` can accept data from multiple [tenants](#multitenancy) via a special `multitenant` endpoints `http://vminsert:8480/insert/multitenant/<suffix>`,
where `<suffix>` can be replaced with any supported suffix for data ingestion from [this list](#url-format).
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
In this case the account ID and project ID are obtained from optional `vm_account_id` and `vm_project_id` labels of the incoming samples.
If `vm_account_id` or `vm_project_id` labels are missing or invalid, then the corresponding account ID and project ID are set to 0.
app/vminsert: allows parsing tenant id from labels (#3009) * app/vminsert: allows parsing tenant id from labels it should help mitigate issues with vmagent's multiTenant mode, which works incorrectly at heavy load and it cannot handle more then 100 different tenants. This functional hidden with flag and do not change vminsert default behaviour https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2970 * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * wip * app/vminsert/netstorage: clean remaining labels in order to free up GC * docs/Cluster-VictoriaMetrics.md: typo fix * wip * wip Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-30 14:28:35 +00:00
These labels are automatically removed from samples before forwarding them to `vmstorage`.
For example, if the following samples are written into `http://vminsert:8480/insert/multitenant/prometheus/api/v1/write`:
```
http_requests_total{path="/foo",vm_account_id="42"} 12
http_requests_total{path="/bar",vm_account_id="7",vm_project_id="9"} 34
```
Then the `http_requests_total{path="/foo"} 12` would be stored in the tenant `accountID=42, projectID=0`,
while the `http_requests_total{path="/bar"} 34` would be stored in the tenant `accountID=7, projectID=9`.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The `vm_account_id` and `vm_project_id` labels are extracted after applying the [relabeling](https://docs.victoriametrics.com/relabeling/)
app/vminsert: allows parsing tenant id from labels (#3009) * app/vminsert: allows parsing tenant id from labels it should help mitigate issues with vmagent's multiTenant mode, which works incorrectly at heavy load and it cannot handle more then 100 different tenants. This functional hidden with flag and do not change vminsert default behaviour https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2970 * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * wip * app/vminsert/netstorage: clean remaining labels in order to free up GC * docs/Cluster-VictoriaMetrics.md: typo fix * wip * wip Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-30 14:28:35 +00:00
set via `-relabelConfig` command-line flag, so these labels can be set at this stage.
docs/Cluster-VictoriaMetrics.md: document that multitenancy via labels is applied to data ingested via non-http protocols Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3009
2023-11-27 09:13:32 +00:00
The `vm_account_id` and `vm_project_id` labels are also taken into account when ingesting data via non-http-based protocols
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
such as [Graphite](https://docs.victoriametrics.com/#how-to-send-data-from-graphite-compatible-agents-such-as-statsd),
[InfluxDB line protocol via TCP and UDP](https://docs.victoriametrics.com/#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf) and
[OpenTSDB telnet put protocol](https://docs.victoriametrics.com/#sending-data-via-telnet-put-protocol).
docs/Cluster-VictoriaMetrics.md: document that multitenancy via labels is applied to data ingested via non-http protocols Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3009
2023-11-27 09:13:32 +00:00
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
**Reads**
_For better performance prefer specifying [tenants in read URL](https://docs.victoriametrics.com/cluster-victoriametrics/#url-format)._
vmselect: add support of multi-tenant queries (#6346) ### Describe Your Changes Added an ability to query data across multiple tenants. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1434 Currently, the following endpoints work with multi-tenancy: - /prometheus/api/v1/query - /prometheus/api/v1/query_range - /prometheus/api/v1/series - /prometheus/api/v1/labels - /prometheus/api/v1/label/<label_name>/values - /prometheus/api/v1/status/active_queries - /prometheus/api/v1/status/top_queries - /prometheus/api/v1/status/tsdb - /prometheus/api/v1/export - /prometheus/api/v1/export/csv - /vmui A note regarding VMUI: endpoints such as `active_queries` and `top_queries` have been updated to indicate whether query was a single-tenant or multi-tenant, but UI needs to be updated to display this info. cc: @Loori-R --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Signed-off-by: f41gh7 <nik@victoriametrics.com> Co-authored-by: f41gh7 <nik@victoriametrics.com>
2024-10-01 14:37:18 +00:00
docs: use `available_from` shortcode for versioning features (#7492) ### Describe Your Changes Please provide a brief description of the changes you made. Be as specific as possible to help others understand the purpose and impact of your modifications. ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-11-10 23:54:28 +00:00
`vmselect` can execute {{% available_from "v1.104.0" %}} queries over multiple [tenants](#multitenancy) via special `multitenant` endpoints `http://vmselect:8481/select/multitenant/<suffix>`.
vmselect: add support of multi-tenant queries (#6346) ### Describe Your Changes Added an ability to query data across multiple tenants. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1434 Currently, the following endpoints work with multi-tenancy: - /prometheus/api/v1/query - /prometheus/api/v1/query_range - /prometheus/api/v1/series - /prometheus/api/v1/labels - /prometheus/api/v1/label/<label_name>/values - /prometheus/api/v1/status/active_queries - /prometheus/api/v1/status/top_queries - /prometheus/api/v1/status/tsdb - /prometheus/api/v1/export - /prometheus/api/v1/export/csv - /vmui A note regarding VMUI: endpoints such as `active_queries` and `top_queries` have been updated to indicate whether query was a single-tenant or multi-tenant, but UI needs to be updated to display this info. cc: @Loori-R --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Signed-off-by: f41gh7 <nik@victoriametrics.com> Co-authored-by: f41gh7 <nik@victoriametrics.com>
2024-10-01 14:37:18 +00:00
Currently supported endpoints for `<suffix>` are:
- `/prometheus/api/v1/query`
- `/prometheus/api/v1/query_range`
- `/prometheus/api/v1/series`
- `/prometheus/api/v1/labels`
- `/prometheus/api/v1/label/<label_name>/values`
- `/prometheus/api/v1/status/active_queries`
- `/prometheus/api/v1/status/top_queries`
- `/prometheus/api/v1/status/tsdb`
- `/prometheus/api/v1/export`
- `/prometheus/api/v1/export/csv`
- `/vmui`
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
It is allowed to explicitly specify tenant IDs via `vm_account_id` and `vm_project_id` labels in the query.
For example, the following query fetches metric `up` for the tenants `accountID=42` and `accountID=7, projectID=9`:
vmselect: add support of multi-tenant queries (#6346) ### Describe Your Changes Added an ability to query data across multiple tenants. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1434 Currently, the following endpoints work with multi-tenancy: - /prometheus/api/v1/query - /prometheus/api/v1/query_range - /prometheus/api/v1/series - /prometheus/api/v1/labels - /prometheus/api/v1/label/<label_name>/values - /prometheus/api/v1/status/active_queries - /prometheus/api/v1/status/top_queries - /prometheus/api/v1/status/tsdb - /prometheus/api/v1/export - /prometheus/api/v1/export/csv - /vmui A note regarding VMUI: endpoints such as `active_queries` and `top_queries` have been updated to indicate whether query was a single-tenant or multi-tenant, but UI needs to be updated to display this info. cc: @Loori-R --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Signed-off-by: f41gh7 <nik@victoriametrics.com> Co-authored-by: f41gh7 <nik@victoriametrics.com>
2024-10-01 14:37:18 +00:00
```
up{vm_account_id="7", vm_project_id="9" or vm_account_id="42"}
```
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
`vm_account_id` and `vm_project_id` labels support all operators for label matching. For example:
```
up{vm_account_id!="42"} # selects all the time series except those belonging to accountID=42
up{vm_account_id=~"4.*"} # selects all the time series belonging to accountIDs starting with 4
```
Alternatively, it is possible to use [`extra_filters[]` and `extra_label`](https://docs.victoriametrics.com/#prometheus-querying-api-enhancements)
query args to apply additional filters for the query:
vmselect: add support of multi-tenant queries (#6346) ### Describe Your Changes Added an ability to query data across multiple tenants. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1434 Currently, the following endpoints work with multi-tenancy: - /prometheus/api/v1/query - /prometheus/api/v1/query_range - /prometheus/api/v1/series - /prometheus/api/v1/labels - /prometheus/api/v1/label/<label_name>/values - /prometheus/api/v1/status/active_queries - /prometheus/api/v1/status/top_queries - /prometheus/api/v1/status/tsdb - /prometheus/api/v1/export - /prometheus/api/v1/export/csv - /vmui A note regarding VMUI: endpoints such as `active_queries` and `top_queries` have been updated to indicate whether query was a single-tenant or multi-tenant, but UI needs to be updated to display this info. cc: @Loori-R --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Signed-off-by: f41gh7 <nik@victoriametrics.com> Co-authored-by: f41gh7 <nik@victoriametrics.com>
2024-10-01 14:37:18 +00:00
```
curl 'http://vmselect:8481/select/multitenant/prometheus/api/v1/query' \
-d 'query=up' \
-d 'extra_filters[]={vm_account_id="7",vm_project_id="9"}' \
-d 'extra_filters[]={vm_account_id="42"}'
```
The precedence for applying filters for tenants follows this order:
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
1. Filter tenants by `extra_label` and `extra_filters` filters.
vmselect: add support of multi-tenant queries (#6346) ### Describe Your Changes Added an ability to query data across multiple tenants. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1434 Currently, the following endpoints work with multi-tenancy: - /prometheus/api/v1/query - /prometheus/api/v1/query_range - /prometheus/api/v1/series - /prometheus/api/v1/labels - /prometheus/api/v1/label/<label_name>/values - /prometheus/api/v1/status/active_queries - /prometheus/api/v1/status/top_queries - /prometheus/api/v1/status/tsdb - /prometheus/api/v1/export - /prometheus/api/v1/export/csv - /vmui A note regarding VMUI: endpoints such as `active_queries` and `top_queries` have been updated to indicate whether query was a single-tenant or multi-tenant, but UI needs to be updated to display this info. cc: @Loori-R --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Signed-off-by: f41gh7 <nik@victoriametrics.com> Co-authored-by: f41gh7 <nik@victoriametrics.com>
2024-10-01 14:37:18 +00:00
These filters have the highest priority and are applied first when provided through the query arguments.
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
2. Filter tenants from labels selectors defined at metricsQL query expression.
vmselect: add support of multi-tenant queries (#6346) ### Describe Your Changes Added an ability to query data across multiple tenants. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1434 Currently, the following endpoints work with multi-tenancy: - /prometheus/api/v1/query - /prometheus/api/v1/query_range - /prometheus/api/v1/series - /prometheus/api/v1/labels - /prometheus/api/v1/label/<label_name>/values - /prometheus/api/v1/status/active_queries - /prometheus/api/v1/status/top_queries - /prometheus/api/v1/status/tsdb - /prometheus/api/v1/export - /prometheus/api/v1/export/csv - /vmui A note regarding VMUI: endpoints such as `active_queries` and `top_queries` have been updated to indicate whether query was a single-tenant or multi-tenant, but UI needs to be updated to display this info. cc: @Loori-R --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Signed-off-by: f41gh7 <nik@victoriametrics.com> Co-authored-by: f41gh7 <nik@victoriametrics.com>
2024-10-01 14:37:18 +00:00
docs: actualize multitenancy docs Follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6346 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cd8a478a8ddf8645960ffa3aa021cbcf3b1ca436)
2024-10-02 12:35:29 +00:00
**Security considerations**
It is recommended restricting access to `multitenant` endpoints only to trusted sources,
vmselect: add support of multi-tenant queries (#6346) ### Describe Your Changes Added an ability to query data across multiple tenants. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1434 Currently, the following endpoints work with multi-tenancy: - /prometheus/api/v1/query - /prometheus/api/v1/query_range - /prometheus/api/v1/series - /prometheus/api/v1/labels - /prometheus/api/v1/label/<label_name>/values - /prometheus/api/v1/status/active_queries - /prometheus/api/v1/status/top_queries - /prometheus/api/v1/status/tsdb - /prometheus/api/v1/export - /prometheus/api/v1/export/csv - /vmui A note regarding VMUI: endpoints such as `active_queries` and `top_queries` have been updated to indicate whether query was a single-tenant or multi-tenant, but UI needs to be updated to display this info. cc: @Loori-R --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Signed-off-by: f41gh7 <nik@victoriametrics.com> Co-authored-by: f41gh7 <nik@victoriametrics.com>
2024-10-01 14:37:18 +00:00
since untrusted source may break per-tenant data by writing unwanted samples or get access to data of arbitrary tenants.
docs/Cluster-VictoriaMetrics.md: add a security note for multitenant support via labels
2022-10-01 15:56:56 +00:00
app/vminsert: allows parsing tenant id from labels (#3009) * app/vminsert: allows parsing tenant id from labels it should help mitigate issues with vmagent's multiTenant mode, which works incorrectly at heavy load and it cannot handle more then 100 different tenants. This functional hidden with flag and do not change vminsert default behaviour https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2970 * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * wip * app/vminsert/netstorage: clean remaining labels in order to free up GC * docs/Cluster-VictoriaMetrics.md: typo fix * wip * wip Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-30 14:28:35 +00:00
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
## Binaries
docs: use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest instead of https://github.com/VictoriaMetrics/VictoriaMetrics/releases link where needed The https://github.com/VictoriaMetrics/VictoriaMetrics/releases link may show non-latest releases at the top, such as LTS releases or VictoriaLogs releases. So it is better to use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest link, which always redirect to the latest available release of VictoriaMetrics.
2023-10-18 18:06:23 +00:00
Compiled binaries for the cluster version are available in the `assets` section of the [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest).
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
Also see archives containing the word `cluster`.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
Docker images for the cluster version are available here:
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- `vminsert` - <https://hub.docker.com/r/victoriametrics/vminsert/tags>
- `vmselect` - <https://hub.docker.com/r/victoriametrics/vmselect/tags>
- `vmstorage` - <https://hub.docker.com/r/victoriametrics/vmstorage/tags>
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
## Building from sources
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
The source code for the cluster version is available in the [cluster branch](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
### Production builds
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
There is no need to install Go on a host system since binaries are built
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
inside [the official docker container for Go](https://hub.docker.com/_/golang).
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
This allows reproducible builds.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
So [install docker](https://docs.docker.com/install/) and run the following command:
```
make vminsert-prod vmselect-prod vmstorage-prod
```
docs/Cluster-VictoriaMetrics.md: run `make docs-sync` after 1c96dce367530b2673f2f4f7a59d58dc5e4de8bf
2022-06-07 11:30:09 +00:00
Production binaries are built into statically linked binaries. They are put into the `bin` folder with `-prod` suffixes:
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
```
$ make vminsert-prod vmselect-prod vmstorage-prod
$ ls -1 bin
vminsert-prod
vmselect-prod
vmstorage-prod
```
docs/Cluster-VictoriaMetrics.md: swap `production build` and `development build` chapters
2020-04-01 14:48:36 +00:00
### Development Builds
all: upgrade Go builder from Go1.21.7 to Go1.22.0 See https://go.dev/doc/go1.22
2024-02-12 19:59:41 +00:00
1. [Install go](https://golang.org/doc/install). The minimum supported version is Go 1.22.
docs/Cluster-VictoriaMetrics.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:11:28 +00:00
1. Run `make` from [the repository root](https://github.com/VictoriaMetrics/VictoriaMetrics). It should build `vmstorage`, `vmselect`
docs/Cluster-VictoriaMetrics.md: swap `production build` and `development build` chapters
2020-04-01 14:48:36 +00:00
and `vminsert` binaries and put them into the `bin` folder.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
### Building docker images
Run `make package`. It will build the following docker images locally:
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- `victoriametrics/vminsert:<PKG_TAG>`
- `victoriametrics/vmselect:<PKG_TAG>`
- `victoriametrics/vmstorage:<PKG_TAG>`
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs: add a link to the repository from build instruction for all the VictoriaMetrics components
2021-03-25 15:14:38 +00:00
`<PKG_TAG>` is auto-generated image tag, which depends on source code in [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
The `<PKG_TAG>` may be manually set via `PKG_TAG=foobar make package`.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
By default, images are built on top of [alpine](https://hub.docker.com/_/scratch) image in order to improve debuggability.
docs: update the info that docker images are built on top of `alpine` image now A follow-up after the commit ff624c9125c45ba00bc6dec57cc5c784e319262b Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/522
2020-06-26 10:47:21 +00:00
It is possible to build an image on top of any other base image by setting it via `<ROOT_IMAGE>` environment variable.
For example, the following command builds images on top of [scratch](https://hub.docker.com/_/scratch) image:
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs: follow-up after 491287ed1552798161c6e197fbf391770602d2b9 * port un-synced changed from docs/readme to readme * consistently use `sh` instead of `console` highlight, as it looks like a more appropriate syntax highlight * consistently use `sh` instead of `bash`, as it is shorter * consistently use `yaml` instead of `yml` See syntax codes here https://gohugo.io/content-management/syntax-highlighting/ Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-01-27 18:29:11 +00:00
```sh
deployment/docker: use alpine base image for docker images in order to improve debuggability Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/522
2020-06-02 19:40:59 +00:00
ROOT_IMAGE=scratch make package
deployment/docker: allow building docker images on top of any base image set via ROOT_IMAGE environment var For example, the following command will build VictoriaMetrics docker image on top of alpine image: ROOT_IMAGE=alpine make package-victoria-metrics
2020-04-19 22:09:52 +00:00
```
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
## Operation
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Cluster setup
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
A minimal cluster must contain the following nodes:
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- a single `vmstorage` node with `-retentionPeriod` and `-storageDataPath` flags
- a single `vminsert` node with `-storageNode=<vmstorage_host>`
- a single `vmselect` node with `-storageNode=<vmstorage_host>`
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[Enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise/) supports automatic discovering and updating of `vmstorage` nodes.
app/{vminsert,vmselect}: add support for automatic discovery and update of vmstorage nodes Thanks to @dmitryk-dk for the initial implemenation at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/446
2022-10-28 10:07:40 +00:00
See [these docs](#automatic-vmstorage-discovery) for details.
docs/Cluster-VictoriaMetrics.md: improve docs on cluster setup, resizing and scalability
2022-04-15 12:04:10 +00:00
It is recommended to run at least two nodes for each service for high availability purposes. In this case the cluster continues working when a single node is temporarily unavailable and the remaining nodes can handle the increased workload. The node may be temporarily unavailable when the underlying hardware breaks, during software upgrades, migration or other maintenance tasks.
It is preferred to run many small `vmstorage` nodes over a few big `vmstorage` nodes, since this reduces the workload increase on the remaining `vmstorage` nodes when some of `vmstorage` nodes become temporarily unavailable.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
An http load balancer such as [vmauth](https://docs.victoriametrics.com/vmauth/) or `nginx` must be put in front of `vminsert` and `vmselect` nodes.
app/vmauth: improve load balancing by sending incoming requests to backends with the lowest number of concurrent requests While at it, stop sending requests to unavailable backend for 3 seconds before the next attempt. This should reduce the amounts of useless work and the number of useless network packets when the backend is temporarily unavailable.
2023-02-11 08:27:40 +00:00
It must contain the following routing configs according to [the url format](#url-format):
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
- requests starting with `/insert` must be routed to port `8480` on `vminsert` nodes.
- requests starting with `/select` must be routed to port `8481` on `vmselect` nodes.
Ports may be altered by setting `-httpListenAddr` on the corresponding nodes.
It is recommended setting up [monitoring](#monitoring) for the cluster.
docs/Cluster-VictoriaMetrics.md: typo fix: siplify -> simplify
2021-07-02 07:50:26 +00:00
The following tools can simplify cluster setup:
deployment/docker: move cluster compose env to master branch (#3130) * deployment/docker: move cluster compose env to master branch The change supposed to simplify the process of maintaining for single/cluster docker-compose envs, alerts, dashboards. It also supposes to reduce confusion for users when looking for cluster related alerts/configs. Signed-off-by: hagen1778 <roman@victoriametrics.com> * deployment/docker: move cluster compose env to master branch Review updates. Signed-off-by: hagen1778 <roman@victoriametrics.com> Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-09-21 08:48:38 +00:00
- [An example docker-compose config for VictoriaMetrics cluster](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/docker-compose-cluster.yml)
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- [Helm charts for VictoriaMetrics](https://github.com/VictoriaMetrics/helm-charts)
- [Kubernetes operator for VictoriaMetrics](https://github.com/VictoriaMetrics/operator)
docs/Cluster-VictoriaMetrics.md: add a chapter describing a toy cluster setup on a single host While at it, refer to available tools, which can simplify cluster setup
2021-07-02 07:43:22 +00:00
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
It is possible manually setting up a toy cluster on a single host. In this case every cluster component - `vminsert`, `vmselect` and `vmstorage` - must have distinct values for `-httpListenAddr` command-line flag. This flag specifies http address for accepting http requests for [monitoring](#monitoring) and [profiling](#profiling). `vmstorage` node must have distinct values for the following additional command-line flags in order to prevent resource usage clash:
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- `-storageDataPath` - every `vmstorage` node must have a dedicated data storage.
- `-vminsertAddr` - every `vmstorage` node must listen for a distinct tcp address for accepting data from `vminsert` nodes.
- `-vmselectAddr` - every `vmstorage` node must listen for a distinct tcp address for accepting requests from `vmselect` nodes.
docs/Cluster-VictoriaMetrics.md: add a chapter describing a toy cluster setup on a single host While at it, refer to available tools, which can simplify cluster setup
2021-07-02 07:43:22 +00:00
docs/Cluster-VictoriaMetrics.md: move `environment variables` entry closer to `cluster setup` section
2022-05-04 15:41:36 +00:00
### Environment variables
lib/envtemplate: allow referring env vars from other env vars via %{ENV_VAR} syntax This is a follow-up for 02096e06d020b1828c285ca68b16074d2e6d03c3
2022-10-26 11:49:20 +00:00
All the VictoriaMetrics components allow referring environment variables in command-line flags via `%{ENV_VAR}` syntax.
docs/Cluster-VictoriaMetrics.md: update docs about env vars usage in command-line flags This is a follow-up for 02096e06d020b1828c285ca68b16074d2e6d03c3
2022-10-25 22:54:13 +00:00
For example, `-metricsAuthKey=%{METRICS_AUTH_KEY}` is automatically expanded to `-metricsAuthKey=top-secret`
if `METRICS_AUTH_KEY=top-secret` environment variable exists at VictoriaMetrics startup.
lib/envtemplate: allow referring env vars from other env vars via %{ENV_VAR} syntax This is a follow-up for 02096e06d020b1828c285ca68b16074d2e6d03c3
2022-10-26 11:49:20 +00:00
This expansion is performed by VictoriaMetrics itself.
VictoriaMetrics recursively expands `%{ENV_VAR}` references in environment variables on startup.
For example, `FOO=%{BAR}` environment variable is expanded to `FOO=abc` if `BAR=a%{BAZ}` and `BAZ=bc`.
docs/Cluster-VictoriaMetrics.md: update docs about env vars usage in command-line flags This is a follow-up for 02096e06d020b1828c285ca68b16074d2e6d03c3
2022-10-25 22:54:13 +00:00
Additionally, all the VictoriaMetrics components allow setting flag values via environment variables according to these rules:
docs/Cluster-VictoriaMetrics.md: move `environment variables` entry closer to `cluster setup` section
2022-05-04 15:41:36 +00:00
- The `-envflag.enable` flag must be set
- Each `.` in flag names must be substituted by `_` (for example `-insert.maxQueueDuration <duration>` will translate to `insert_maxQueueDuration=<duration>`)
- For repeating flags, an alternative syntax can be used by joining the different values into one using `,` as separator (for example `-storageNode <nodeA> -storageNode <nodeB>` will translate to `storageNode=<nodeA>,<nodeB>`)
- It is possible setting prefix for environment vars with `-envflag.prefix`. For instance, if `-envflag.prefix=VM_`, then env vars must be prepended with `VM_`
app/{vminsert,vmselect}: add support for automatic discovery and update of vmstorage nodes Thanks to @dmitryk-dk for the initial implemenation at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/446
2022-10-28 10:07:40 +00:00
## Automatic vmstorage discovery
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
`vminsert` and `vmselect` components in [enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise/) support
docs/Cluster-VictoriaMetrics.md: `make docs-sync` after 5de8330ce00adfc5ac794070d30a2617ddc14bf2
2022-12-07 20:01:51 +00:00
the following approaches for automatic discovery of `vmstorage` nodes:
- file-based discovery - put the list of `vmstorage` nodes into a file - one node address per each line - and then pass `-storageNode=file:/path/to/file-with-vmstorage-list`
to `vminsert` and `vmselect`. It is possible to read the list of vmstorage nodes from http or https urls.
For example, `-storageNode=file:http://some-host/vmstorage-list` would read the list of storage nodes
from `http://some-host/vmstorage-list`.
The list of discovered `vmstorage` nodes is automatically updated when the file contents changes.
The update frequency can be controlled with `-storageNode.discoveryInterval` command-line flag.
app/{vminsert,vmselect}: support for `srv+addr` scheme for specifying DNS SRV addresses at -storageNode flag The new scheme is consistent with SRV urls introduced at b426d1084751737e8ee3435e4d039c76f3c891c1 and dc326f70b4026a802ba0db0c891b856d56b08c0d Deprecte the old scheme: `dns+srv:addr` by removing it from the docs. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6053
2024-04-17 21:08:31 +00:00
- [DNS SRV](https://en.wikipedia.org/wiki/SRV_record) - pass `srv+some-name` value to `-storageNode` command-line flag.
In this case the provided `some-name` is resolved into tcp addresses of `vmstorage` nodes.
docs/Cluster-VictoriaMetrics.md: `make docs-sync` after 5de8330ce00adfc5ac794070d30a2617ddc14bf2
2022-12-07 20:01:51 +00:00
The list of discovered `vmstorage` nodes is automatically updated at `vminsert` and `vmselect`
app/{vminsert,vmselect}: support for `srv+addr` scheme for specifying DNS SRV addresses at -storageNode flag The new scheme is consistent with SRV urls introduced at b426d1084751737e8ee3435e4d039c76f3c891c1 and dc326f70b4026a802ba0db0c891b856d56b08c0d Deprecte the old scheme: `dns+srv:addr` by removing it from the docs. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6053
2024-04-17 21:08:31 +00:00
when it changes behind the `some-name` DNS SRV record.
docs/Cluster-VictoriaMetrics.md: `make docs-sync` after 5de8330ce00adfc5ac794070d30a2617ddc14bf2
2022-12-07 20:01:51 +00:00
The update frequency can be controlled with `-storageNode.discoveryInterval` command-line flag.
app/{vminsert,vmselect}: support for `srv+addr` scheme for specifying DNS SRV addresses at -storageNode flag The new scheme is consistent with SRV urls introduced at b426d1084751737e8ee3435e4d039c76f3c891c1 and dc326f70b4026a802ba0db0c891b856d56b08c0d Deprecte the old scheme: `dns+srv:addr` by removing it from the docs. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6053
2024-04-17 21:08:31 +00:00
It is possible passing multiple `file` and DNS SRV names to `-storageNode` command-line flag. In this case all these names
docs/Cluster-VictoriaMetrics.md: `make docs-sync` after 5de8330ce00adfc5ac794070d30a2617ddc14bf2
2022-12-07 20:01:51 +00:00
are resolved to tcp addresses of `vmstorage` nodes to connect to.
app/{vminsert,vmselect}: support for `srv+addr` scheme for specifying DNS SRV addresses at -storageNode flag The new scheme is consistent with SRV urls introduced at b426d1084751737e8ee3435e4d039c76f3c891c1 and dc326f70b4026a802ba0db0c891b856d56b08c0d Deprecte the old scheme: `dns+srv:addr` by removing it from the docs. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6053
2024-04-17 21:08:31 +00:00
For example, `-storageNode=file:/path/to/local-vmstorage-list -storageNode='srv+vmstorage-hot' -storageNode='srv+vmstorage-cold'`.
docs/Cluster-VictoriaMetrics.md: `make docs-sync` after 5de8330ce00adfc5ac794070d30a2617ddc14bf2
2022-12-07 20:01:51 +00:00
app/{vminsert,vmselect}: support for `srv+addr` scheme for specifying DNS SRV addresses at -storageNode flag The new scheme is consistent with SRV urls introduced at b426d1084751737e8ee3435e4d039c76f3c891c1 and dc326f70b4026a802ba0db0c891b856d56b08c0d Deprecte the old scheme: `dns+srv:addr` by removing it from the docs. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6053
2024-04-17 21:08:31 +00:00
It is OK to pass regular static `vmstorage` addresses together with `file` and DNS SRV addresses at `-storageNode`. For example,
`-storageNode=vmstorage1,vmstorage2 -storageNode='srv+vmstorage-autodiscovery'`.
docs/Cluster-VictoriaMetrics.md: improve docs for `dns+srv` service discovery
2022-10-28 11:23:02 +00:00
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
The discovered addresses can be filtered with optional `-storageNode.filter` command-line flag, which can contain arbitrary regular expression filter.
For example, `-storageNode.filter='^[^:]+:8400$'` would leave discovered addresses ending with `8400` port only, e.g. the default port used
for sending data from `vminsert` to `vmstorage` node according to `-vminsertAddr` command-line flag.
docs: typo fixes
2022-10-29 01:52:18 +00:00
The currently discovered `vmstorage` nodes can be [monitored](#monitoring) with `vm_rpc_vmstorage_is_reachable` and `vm_rpc_vmstorage_is_read_only` metrics.
app/{vminsert,vmselect}: add support for automatic discovery and update of vmstorage nodes Thanks to @dmitryk-dk for the initial implemenation at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/446
2022-10-28 10:07:40 +00:00
Improving docs by adding additional security sections (#3713) * docs/Cluster-VictoriaMetrics.md: adds security section * docs/Quick-Start.md: adds Security recommendation section
2023-01-27 23:22:21 +00:00
## Security
General security recommendations:
docs: update security chapters after bd716d1b0cda860f090fcf0d882dec35e0ebcfd5
2023-01-27 23:39:27 +00:00
- All the VictoriaMetrics cluster components must run in protected private network without direct access from untrusted networks such as Internet.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- External clients must access `vminsert` and `vmselect` via auth proxy such as [vmauth](https://docs.victoriametrics.com/vmauth/)
or [vmgateway](https://docs.victoriametrics.com/vmgateway/).
lib/httpserver: add flags to specify HSTS / Frame-Options / CSP headers for httpserver (#5111) support `Strict-Transport-Security`, `Content-Security-Policy` and `X-Frame-Options` HTTP headers in all VictoriaMetrics components. The values for headers can be specified by users via the following flags: `-http.header.hsts`, `-http.header.csp` and `-http.header.frameOptions`. Co-authored-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit ad839aa492704dda3a9f8e5fe9de58c4074bd39a) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-10-30 10:33:38 +00:00
- The auth proxy must accept auth tokens from untrusted networks only via https in order to protect the auth tokens from MitM attacks.
docs: update security chapters after bd716d1b0cda860f090fcf0d882dec35e0ebcfd5
2023-01-27 23:39:27 +00:00
- It is recommended using distinct auth tokens for distinct [tenants](#multitenancy) in order to reduce potential damage in case of compromised auth token for some tenants.
- Prefer using lists of allowed [API endpoints](#url-format), while disallowing access to other endpoints when configuring auth proxy in front of `vminsert` and `vmselect`.
This minimizes attack surface.
Improving docs by adding additional security sections (#3713) * docs/Cluster-VictoriaMetrics.md: adds security section * docs/Quick-Start.md: adds Security recommendation section
2023-01-27 23:22:21 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
See also [security recommendation for single-node VictoriaMetrics](https://docs.victoriametrics.com/#security)
docs: update security chapters after bd716d1b0cda860f090fcf0d882dec35e0ebcfd5
2023-01-27 23:39:27 +00:00
and [the general security page at VictoriaMetrics website](https://victoriametrics.com/security/).
Improving docs by adding additional security sections (#3713) * docs/Cluster-VictoriaMetrics.md: adds security section * docs/Quick-Start.md: adds Security recommendation section
2023-01-27 23:22:21 +00:00
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
## mTLS protection
lib/httpserver: add support for mTLS for requests to -httpListenAddr
2024-02-06 15:40:48 +00:00
By default `vminsert` and `vmselect` nodes accept http requests at `8480` and `8481` ports accordingly (these ports can be changed via `-httpListenAddr` command-line flags),
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
since it is expected that [vmauth](https://docs.victoriametrics.com/vmauth/) is used for authorization and [TLS termination](https://en.wikipedia.org/wiki/TLS_termination_proxy)
lib/httpserver: add support for mTLS for requests to -httpListenAddr
2024-02-06 15:40:48 +00:00
in front of `vminsert` and `vmselect`.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[Enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise/) supports the ability to accept [mTLS](https://en.wikipedia.org/wiki/Mutual_authentication)
lib/httpserver: add support for mTLS for requests to -httpListenAddr
2024-02-06 15:40:48 +00:00
requests at `8480` and `8481` ports for `vminsert` and `vmselect` nodes, by specifying `-tls` and `-mtls` command-line flags.
For example, the following command runs `vmselect`, which accepts only mTLS requests at port `8481`:
```
./vmselect -tls -mtls
```
By default system-wide [TLS Root CA](https://en.wikipedia.org/wiki/Root_certificate) is used for verifying client certificates if `-mtls` command-line flag is specified.
It is possible to specify custom TLS Root CA via `-mtlsCAFile` command-line flag.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
By default `vminsert` and `vmselect` nodes use unencrypted connections to `vmstorage` nodes, since it is assumed that all the cluster components [run in a protected environment](#security). [Enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise/) provides optional support for [mTLS connections](https://en.wikipedia.org/wiki/Mutual_authentication#mTLS) between cluster components. Pass `-cluster.tls=true` command-line flag to `vminsert`, `vmselect` and `vmstorage` nodes in order to enable mTLS protection. Additionally, `vminsert`, `vmselect` and `vmstorage` must be configured with mTLS certificates via `-cluster.tlsCertFile`, `-cluster.tlsKeyFile` command-line options. These certificates are mutually verified when `vminsert` and `vmselect` dial `vmstorage`.
app/vmstorage: add support for mTLS cipher suites via `-cluster.tlsCipherSuites` command-line flag Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2404
2022-04-16 13:32:17 +00:00
docs/Cluster-VictoriaMetrics.md: mention that enterprise binaries are available for evaluation
2022-04-21 12:57:13 +00:00
The following optional command-line flags related to mTLS are supported:
app/vmstorage: add support for mTLS cipher suites via `-cluster.tlsCipherSuites` command-line flag Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2404
2022-04-16 13:32:17 +00:00
all: add -cluster.tlsInsecureSkipVerify command-line option to vminsert, vmselect and vmstorage components in order to be able to disable TLS certificate verification in mTLS mode See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2490
2022-05-03 10:08:01 +00:00
- `-cluster.tlsInsecureSkipVerify` can be set at `vminsert`, `vmselect` and `vmstorage` in order to disable peer certificate verification. Note that this breaks security.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
- `-cluster.tlsCAFile` can be set at `vminsert`, `vmselect` and `vmstorage` for verifying peer certificates issued with custom [certificate authority](https://en.wikipedia.org/wiki/Certificate_authority). By default, system-wide certificate authority is used for peer certificate verification.
app/vmstorage: add support for mTLS cipher suites via `-cluster.tlsCipherSuites` command-line flag Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2404
2022-04-16 13:32:17 +00:00
- `-cluster.tlsCipherSuites` can be set to the list of supported TLS cipher suites at `vmstorage`. See [the list of supported TLS cipher suites](https://pkg.go.dev/crypto/tls#pkg-constants).
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
app/vmselect: add `-clusternative.tls*` options for mTLS setup in multi-level clusters
2022-07-06 10:46:19 +00:00
When `vmselect` runs with `-clusternativeListenAddr` command-line option, then it can be configured with `-clusternative.tls*` options similar to `-cluster.tls*` for accepting `mTLS` connections from top-level `vmselect` nodes in [multi-level cluster setup](#multi-level-cluster-setup).
docs/Cluster-VictoriaMetrics.md: refer to the doc on how to set up mTLS
2022-05-03 08:36:58 +00:00
See [these docs](https://gist.github.com/f41gh7/76ed8e5fb1ebb9737fe746bae9175ee6) on how to set up mTLS in VictoriaMetrics cluster.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[Enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise/) can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest).
docs: mention the free trial for enterprise Signed-off-by: Artem Navoiev <tenmozes@gmail.com> (cherry picked from commit 636d4ea1966fff070a365ed3735f06da0d38d9bf)
2023-10-08 18:11:55 +00:00
See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/).
docs/Cluster-VictoriaMetrics.md: mention that enterprise binaries are available for evaluation
2022-04-21 12:57:13 +00:00
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Monitoring
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
All the cluster components expose various metrics in Prometheus-compatible format at `/metrics` page on the TCP port set in `-httpListenAddr` command-line flag.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
By default, the following TCP ports are used:
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
- `vminsert` - 8480
- `vmselect` - 8481
- `vmstorage` - 8482
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
It is recommended setting up [vmagent](https://docs.victoriametrics.com/vmagent/)
docs/Cluster-VictoriaMetrics.md: mention that cluster components may be monitored with vmagent
2020-05-23 11:29:21 +00:00
or Prometheus to scrape `/metrics` pages from all the cluster components, so they can be monitored and analyzed
docs: use persistent links to Grafana dashboards These links do not depend on the dashboard name, so they do not break after the renaming of the dashboard. This is a follow-up for ff33e60a3d46b50bc585a66c433fd62ec00ec7ca
2024-01-21 22:09:19 +00:00
with [the official Grafana dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176)
docs/Cluster-VictoriaMetrics.md: mention -metrics.exposeMetadata command-line flag in `Monitoring` section
2024-02-05 09:47:32 +00:00
or [an alternative dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11831).
Graphs on these dashboards contain useful hints - hover the `i` icon at the top left corner of each graph in order to read it.
If you use Google Cloud Managed Prometheus for scraping metrics from VictoriaMetrics components, then pass `-metrics.exposeMetadata`
command-line to them, so they add `TYPE` and `HELP` comments per each exposed metric at `/metrics` page.
See [these docs](https://cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting#missing-metric-type) for details.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
It is recommended setting up alerts in [vmalert](https://docs.victoriametrics.com/vmalert/) or in Prometheus from [this list](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/deployment/docker#alerts).
docs: mention VictoriaMetrics Monitoring blog post (#3152) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-09-23 05:12:15 +00:00
See more details in the article [VictoriaMetrics Monitoring](https://victoriametrics.com/blog/victoriametrics-monitoring/).
docs/Single-server-VictoriaMetrics.md: recommend using the official alerts for VictoriaMetrics in `Monitoring` section
2021-04-08 09:12:30 +00:00
app/vmstorage: expose `vm_{hourly,daily}_series_limit_{max,current}_series` metrics if `-storage.max{Hourly,Daily}Series` limits are set These metrics allow alerting when the number of unique series approach the limit. For example, the following query alerts when the number of series reaches 90% of the configured limit: vm_hourly_series_limit_current_series / vm_hourly_series_limit_max_series > 0.9
2022-08-24 10:41:53 +00:00
## Cardinality limiter
`vmstorage` nodes can be configured with limits on the number of unique time series across all the tenants with the following command-line flags:
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `-storage.maxHourlySeries` is the limit on the number of [active time series](https://docs.victoriametrics.com/faq/#what-is-an-active-time-series) during the last hour.
- `-storage.maxDailySeries` is the limit on the number of unique time series during the day. This limit can be used for limiting daily [time series churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate).
app/vmstorage: expose `vm_{hourly,daily}_series_limit_{max,current}_series` metrics if `-storage.max{Hourly,Daily}Series` limits are set These metrics allow alerting when the number of unique series approach the limit. For example, the following query alerts when the number of series reaches 90% of the configured limit: vm_hourly_series_limit_current_series / vm_hourly_series_limit_max_series > 0.9
2022-08-24 10:41:53 +00:00
Note that these limits are set and applied individually per each `vmstorage` node in the cluster. So, if the cluster has `N` `vmstorage` nodes, then the cluster-level limits will be `N` times bigger than the per-`vmstorage` limits.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
See more details about cardinality limiter in [these docs](https://docs.victoriametrics.com/#cardinality-limiter).
app/vmstorage: expose `vm_{hourly,daily}_series_limit_{max,current}_series` metrics if `-storage.max{Hourly,Daily}Series` limits are set These metrics allow alerting when the number of unique series approach the limit. For example, the following query alerts when the number of series reaches 90% of the configured limit: vm_hourly_series_limit_current_series / vm_hourly_series_limit_max_series > 0.9
2022-08-24 10:41:53 +00:00
docs: add Troubleshooting doc This doc contains troubleshooting guides for typical problems with VictoriaMetrics.
2022-06-30 10:35:20 +00:00
## Troubleshooting
vmcluster: re-routing enhancement (#5293) * app/vmstorage: close vminsert connections gradually before stopping storage Implements graceful shutdown approach suggested here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1768146878 Test results for this can be found here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1790640274 Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * app/vmstorage: update graceful shutdown logic - close connections from vminsert in determenistic order - update flag description - lower default timeout to 25 seconds. 25 seconds value was chosen because the lowest default value used in default configuration deployments is 30s(default value in Kubernetes and ansible-playbooks). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add information about re-routing enhancement during restart Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/changelog: add entry for new command-line flag Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * {app/vmstorage,lib/ingestserver}: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add note to update workload scheduler timeout Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * wip --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-14 00:00:42 +00:00
- If your VictoriaMetrics cluster experiences data ingestion delays during
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[rolling restarts and configuration updates](https://docs.victoriametrics.com/cluster-victoriametrics/#updating--reconfiguring-cluster-nodes),
vmcluster: re-routing enhancement (#5293) * app/vmstorage: close vminsert connections gradually before stopping storage Implements graceful shutdown approach suggested here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1768146878 Test results for this can be found here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1790640274 Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * app/vmstorage: update graceful shutdown logic - close connections from vminsert in determenistic order - update flag description - lower default timeout to 25 seconds. 25 seconds value was chosen because the lowest default value used in default configuration deployments is 30s(default value in Kubernetes and ansible-playbooks). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add information about re-routing enhancement during restart Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/changelog: add entry for new command-line flag Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * {app/vmstorage,lib/ingestserver}: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add note to update workload scheduler timeout Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * wip --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-14 00:00:42 +00:00
then see [these docs](#improving-re-routing-performance-during-restart).
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[Troubleshooting docs for single-node VictoriaMetrics](https://docs.victoriametrics.com/troubleshooting/) apply to VictoriaMetrics cluster as well.
docs: add Troubleshooting doc This doc contains troubleshooting guides for typical problems with VictoriaMetrics.
2022-06-30 10:35:20 +00:00
app/{vminsert,vmstorage}: follow-up after a171916ef5664690c9b596fe73b095aa75fa5d5c Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/269
2021-10-08 10:52:56 +00:00
## Readonly mode
docs/Cluster-VictoriaMetrics.md: mention the `vm_storage_is_read_only` metric, which can help debugging readonly mode at vmstorage
2022-12-14 17:31:28 +00:00
`vmstorage` nodes automatically switch to readonly mode when the directory pointed by `-storageDataPath`
contains less than `-storage.minFreeDiskSpaceBytes` of free space. `vminsert` nodes stop sending data to such nodes
and start re-routing the data to the remaining `vmstorage` nodes.
`vmstorage` sets `vm_storage_is_read_only` metric at `http://vmstorage:8482/metrics` to `1` when it enters read-only mode.
The metric is set to `0` when the `vmstorage` isn't in read-only mode.
app/{vminsert,vmstorage}: follow-up after a171916ef5664690c9b596fe73b095aa75fa5d5c Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/269
2021-10-08 10:52:56 +00:00
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## URL format
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The main differences between URL formats of cluster and [Single server](https://docs.victoriametrics.com/single-server-victoriametrics/)
Clarifications between standalone/cluster ingestion endpoints (#3771) docs: clarifications between standalone/cluster ingestion endpoints This is an attempt to make it a bit clearer to the user that the cluster version ingestion URLs are different from the standalone ones. I have also changed the order of the list items to make it a bit clearer and hopefully stop the user simply inferring that `/prometheus/api/v1` is only related to Prometheus data.
2023-02-07 14:17:12 +00:00
versions are that cluster has separate components for read and ingestion path, and because of multi-tenancy support.
Also in the cluster version the `/prometheus/api/v1` endpoint ingests `jsonl`, `csv`, `native` and `prometheus` data formats **not** only `prometheus` data.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Check practical examples of VictoriaMetrics API [here](https://docs.victoriametrics.com/url-examples/).
Clarifications between standalone/cluster ingestion endpoints (#3771) docs: clarifications between standalone/cluster ingestion endpoints This is an attempt to make it a bit clearer to the user that the cluster version ingestion URLs are different from the standalone ones. I have also changed the order of the list items to make it a bit clearer and hopefully stop the user simply inferring that `/prometheus/api/v1` is only related to Prometheus data.
2023-02-07 14:17:12 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- URLs for data ingestion: `http://<vminsert>:8480/insert/<accountID>/<suffix>`, where:
docs/Cluster-VictoriaMetrics.md: add `Multitenancy` chapter
2020-05-03 15:00:40 +00:00
- `<accountID>` is an arbitrary 32-bit integer identifying namespace for data ingestion (aka tenant). It is possible to set it as `accountID:projectID`,
app/vminsert: allows parsing tenant id from labels (#3009) * app/vminsert: allows parsing tenant id from labels it should help mitigate issues with vmagent's multiTenant mode, which works incorrectly at heavy load and it cannot handle more then 100 different tenants. This functional hidden with flag and do not change vminsert default behaviour https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2970 * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * wip * app/vminsert/netstorage: clean remaining labels in order to free up GC * docs/Cluster-VictoriaMetrics.md: typo fix * wip * wip Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-30 14:28:35 +00:00
where `projectID` is also arbitrary 32-bit integer. If `projectID` isn't set, then it equals to `0`. See [multitenancy docs](#multitenancy) for more details.
The `<accountID>` can be set to `multitenant` string, e.g. `http://<vminsert>:8480/insert/multitenant/<suffix>`. Such urls accept data from multiple tenants
specified via `vm_account_id` and `vm_project_id` labels. See [multitenancy via labels](#multitenancy-via-labels) for more details.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
- `<suffix>` may have the following values:
lib/protoparser: adds opentelemetry parser (#2570) * lib/protoparser: adds opentelemetry parser app/{vmagent,vminsert}: adds opentelemetry ingestion path Adds ability to ingest data with opentelemetry protocol protobuf and json encoding is supported data converted into prometheus protobuf timeseries each data type has own converter and it may produce multiple timeseries from single datapoint (for summary and histogram). only cumulative aggregationFamily is supported for sum(prometheus counter) and histogram. Apply suggestions from code review Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> updates deps fixes tests wip wip wip wip lib/protoparser/opentelemetry: moves to vtprotobuf generator go mod vendor lib/protoparse/opentelemetry: reduce memory allocations * wip - Remove support for JSON parsing, since it is too fragile and is rarely used in practice. The most clients send OpenTelemetry metrics in protobuf. The JSON parser can be added in the future if needed. - Remove unused code from lib/protoparser/opentelemetry/pb and lib/protoparser/opentelemetry/proto - Do not re-use protobuf message between ParseStream() calls, since there is high chance of high fragmentation of the re-used message because of too complex nested structure of the message. * wip * wip * wip --------- Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-07-27 20:26:45 +00:00
- `prometheus` and `prometheus/api/v1/write` - for ingesting data with [Prometheus remote write API](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write).
Clarifications between standalone/cluster ingestion endpoints (#3771) docs: clarifications between standalone/cluster ingestion endpoints This is an attempt to make it a bit clearer to the user that the cluster version ingestion URLs are different from the standalone ones. I have also changed the order of the list items to make it a bit clearer and hopefully stop the user simply inferring that `/prometheus/api/v1` is only related to Prometheus data.
2023-02-07 14:17:12 +00:00
- `prometheus/api/v1/import` - for importing data obtained via `api/v1/export` at `vmselect` (see below), JSON line format.
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- `prometheus/api/v1/import/native` - for importing data obtained via `api/v1/export/native` on `vmselect` (see below).
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `prometheus/api/v1/import/csv` - for importing arbitrary CSV data. See [these docs](https://docs.victoriametrics.com/single-server-victoriametrics/#how-to-import-csv-data) for details.
- `prometheus/api/v1/import/prometheus` - for importing data in [Prometheus text exposition format](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#text-based-format) and in [OpenMetrics format](https://github.com/OpenObservability/OpenMetrics/blob/master/specification/OpenMetrics.md). This endpoint also supports [Pushgateway protocol](https://github.com/prometheus/pushgateway#url). See [these docs](https://docs.victoriametrics.com/single-server-victoriametrics/#how-to-import-data-in-prometheus-exposition-format) for details.
- `opentelemetry/v1/metrics` - for ingesting data via [OpenTelemetry protocol for metrics](https://github.com/open-telemetry/opentelemetry-specification/blob/ffddc289462dfe0c2041e3ca42a7b1df805706de/specification/metrics/data-model.md). See [these docs](https://docs.victoriametrics.com/single-server-victoriametrics/#sending-data-via-opentelemetry).
- `datadog/api/v1/series` - for ingesting data with DataDog submit metrics API v1. See [these docs](https://docs.victoriametrics.com/url-examples/#datadogapiv1series) for details.
- `datadog/api/v2/series` - for ingesting data with [DataDog submit metrics API](https://docs.datadoghq.com/api/latest/metrics/#submit-metrics). See [these docs](https://docs.victoriametrics.com/single-server-victoriametrics/#how-to-send-data-from-datadog-agent) for details.
docs/Cluster-VictoriaMetrics.md: document the /datadog/api/beta/sketches endpoint This is a follow-up for a1d1ccd6f21c3ffa40b45112ec4d37ab7cb05d82 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5584
2024-02-06 23:35:06 +00:00
- `datadog/api/beta/sketches` - for ingesting data with [DataDog lambda extension](https://docs.datadoghq.com/serverless/libraries_integrations/extension/).
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `influx/write` and `influx/api/v2/write` - for ingesting data with [InfluxDB line protocol](https://docs.influxdata.com/influxdb/v1.7/write_protocols/line_protocol_tutorial/). TCP and UDP receiver is disabled by default. It is exposed on a distinct TCP address set via `-influxListenAddr` command-line flag. See [these docs](https://docs.victoriametrics.com/single-server-victoriametrics/#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf) for details.
- `newrelic/infra/v2/metrics/events/bulk` - for accepting data from [NewRelic infrastructure agent](https://docs.newrelic.com/docs/infrastructure/install-infrastructure-agent). See [these docs](https://docs.victoriametrics.com/#how-to-send-data-from-newrelic-agent) for details.
- `opentsdb/api/put` - for accepting [OpenTSDB HTTP /api/put requests](http://opentsdb.net/docs/build/html/api_http/put.html). This handler is disabled by default. It is exposed on a distinct TCP address set via `-opentsdbHTTPListenAddr` command-line flag. See [these docs](https://docs.victoriametrics.com/single-server-victoriametrics/#sending-opentsdb-data-via-http-apiput-requests) for details.
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- URLs for [Prometheus querying API](https://prometheus.io/docs/prometheus/latest/querying/api/): `http://<vmselect>:8481/select/<accountID>/prometheus/<suffix>`, where:
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
- `<accountID>` is an arbitrary number identifying data namespace for the query (aka tenant)
- `<suffix>` may have the following values:
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `api/v1/query` - performs [PromQL instant query](https://docs.victoriametrics.com/keyconcepts/#instant-query).
- `api/v1/query_range` - performs [PromQL range query](https://docs.victoriametrics.com/keyconcepts/#range-query).
- `api/v1/series` - performs [series query](https://docs.victoriametrics.com/url-examples/#apiv1series).
- `api/v1/labels` - returns a [list of label names](https://docs.victoriametrics.com/url-examples/#apiv1labels).
- `api/v1/label/<label_name>/values` - returns values for the given `<label_name>` according [to the API](https://docs.victoriametrics.com/url-examples/#apiv1labelvalues).
docs/Cluster-VictoriaMetrics.md: add missing endpoints to the list: `api/v1/import/csv` and `api/v1/status/tsdb`
2020-05-16 19:12:53 +00:00
- `federate` - returns [federated metrics](https://prometheus.io/docs/prometheus/latest/federation/).
all: add native format for data export and import The data can be exported via [/api/v1/export/native](https://victoriametrics.github.io/#how-to-export-data-in-native-format) handler and imported via [/api/v1/import/native](https://victoriametrics.github.io/#how-to-import-data-in-native-format) handler.
2020-09-26 01:29:45 +00:00
- `api/v1/export` - exports raw data in JSON line format. See [this article](https://medium.com/@valyala/analyzing-prometheus-data-with-external-tools-5f3e5e147639) for details.
- `api/v1/export/native` - exports raw data in native binary format. It may be imported into another VictoriaMetrics via `api/v1/import/native` (see above).
docs/Cluster-VictoriaMetrics.md: clarify RAM requirements for `vmstorage` nodes
2020-10-13 13:47:19 +00:00
- `api/v1/export/csv` - exports data in CSV. It may be imported into another VictoriaMetrics via `api/v1/import/csv` (see above).
docs/Cluster-VictoriaMetrics.md: document `api/v1/series/count` endpoint
2021-04-30 08:41:40 +00:00
- `api/v1/series/count` - returns the total number of series.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `api/v1/status/tsdb` - for time series stats. See [these docs](https://docs.victoriametrics.com/#tsdb-stats) for details.
docs/Cluster-VictoriaMetrics.md: mention about `api/v1/status/active_queries` page Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/528
2020-07-08 16:15:35 +00:00
- `api/v1/status/active_queries` - for currently executed active queries. Note that every `vmselect` maintains an independent list of active queries,
which is returned in the response.
app/vmselect: add per-tenant `/api/v1/status/top_queries` handler
2020-12-27 10:53:50 +00:00
- `api/v1/status/top_queries` - for listing the most frequently executed queries and queries taking the most duration.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `metric-relabel-debug` - for debugging [relabeling rules](https://docs.victoriametrics.com/relabeling/).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- URLs for [Graphite Metrics API](https://graphite-api.readthedocs.io/en/latest/api.html#the-metrics-api): `http://<vmselect>:8481/select/<accountID>/graphite/<suffix>`, where:
- `<accountID>` is an arbitrary number identifying data namespace for query (aka tenant)
- `<suffix>` may have the following values:
app/vmselect/graphite: open source Graphite Render API
2023-04-01 06:35:26 +00:00
- `render` - implements Graphite Render API. See [these docs](https://graphite.readthedocs.io/en/stable/render_api.html).
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- `metrics/find` - searches Graphite metrics. See [these docs](https://graphite-api.readthedocs.io/en/latest/api.html#metrics-find).
- `metrics/expand` - expands Graphite metrics. See [these docs](https://graphite-api.readthedocs.io/en/latest/api.html#metrics-expand).
- `metrics/index.json` - returns all the metric names. See [these docs](https://graphite-api.readthedocs.io/en/latest/api.html#metrics-index-json).
- `tags/tagSeries` - registers time series. See [these docs](https://graphite.readthedocs.io/en/stable/tags.html#adding-series-to-the-tagdb).
- `tags/tagMultiSeries` - register multiple time series. See [these docs](https://graphite.readthedocs.io/en/stable/tags.html#adding-series-to-the-tagdb).
- `tags` - returns tag names. See [these docs](https://graphite.readthedocs.io/en/stable/tags.html#exploring-tags).
- `tags/<tag_name>` - returns tag values for the given `<tag_name>`. See [these docs](https://graphite.readthedocs.io/en/stable/tags.html#exploring-tags).
- `tags/findSeries` - returns series matching the given `expr`. See [these docs](https://graphite.readthedocs.io/en/stable/tags.html#exploring-tags).
- `tags/autoComplete/tags` - returns tags matching the given `tagPrefix` and/or `expr`. See [these docs](https://graphite.readthedocs.io/en/stable/tags.html#auto-complete-support).
- `tags/autoComplete/values` - returns tag values matching the given `valuePrefix` and/or `expr`. See [these docs](https://graphite.readthedocs.io/en/stable/tags.html#auto-complete-support).
- `tags/delSeries` - deletes series matching the given `path`. See [these docs](https://graphite.readthedocs.io/en/stable/tags.html#removing-series-from-the-tagdb).
- URL with basic Web UI: `http://<vmselect>:8481/select/<accountID>/vmui/`.
- URL for query stats across all tenants: `http://<vmselect>:8481/api/v1/status/top_queries`. It lists with the most frequently executed queries and queries taking the most duration.
- URL for time series deletion: `http://<vmselect>:8481/delete/<accountID>/prometheus/api/v1/admin/tsdb/delete_series?match[]=<timeseries_selector_for_delete>`.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Note that the `delete_series` handler should be used only in exceptional cases such as deletion of accidentally ingested incorrect time series. It shouldn't
be used on a regular basis, since it carries non-zero overhead.
{app/vmstorage,app/vmselect}: add API to get list of existing tenants (#3348) * {app/vmstorage,app/vmselect}: add API to get list of existing tenants * {app/vmstorage,app/vmselect}: add API to get list of existing tenants * app/vmselect: fix error message * {app/vmstorage,app/vmselect}: fix error messages * app/vmselect: change log level for error handling * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-11-25 18:32:45 +00:00
- URL for listing [tenants](#multitenancy) with the ingested data on the given time range: `http://<vmselect>:8481/admin/tenants?start=...&end=...` .
The `start` and `end` query args are optional. If they are missing, then all the tenants with at least one sample stored in VictoriaMetrics are returned.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- URL for accessing [vmalerts](https://docs.victoriametrics.com/vmalert/) UI: `http://<vmselect>:8481/select/<accountID>/prometheus/vmalert/`.
vmselect: allow proxying requests to vmalert (#2833) The change allows to proxy requests with prefix `/vmalert` to the vmalert component if `-vmalert.proxyURL` is set. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2825 and https://github.com/VictoriaMetrics/VictoriaMetrics/pull/2831 Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-07-06 08:47:51 +00:00
This URL works only when `-vmalert.proxyURL` flag is set. See more about vmalert [here](#vmalert).
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- `vmstorage` nodes provide the following HTTP endpoints on `8482` port:
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `/internal/force_merge` - initiate [forced compactions](https://docs.victoriametrics.com/#forced-merge) on the given `vmstorage` node.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
- `/snapshot/create` - create [instant snapshot](https://medium.com/@valyala/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282),
which can be used for backups in background. Snapshots are created in `<storageDataPath>/snapshots` folder, where `<storageDataPath>` is the corresponding
command-line flag value.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
- `/snapshot/list` - list available snapshots.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
- `/snapshot/delete?snapshot=<id>` - delete the given snapshot.
- `/snapshot/delete_all` - delete all the snapshots.
Snapshots may be created independently on each `vmstorage` node. There is no need in synchronizing snapshots' creation
across `vmstorage` nodes.
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Cluster resizing and scalability
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/Cluster-VictoriaMetrics.md: improve docs on cluster setup, resizing and scalability
2022-04-15 12:04:10 +00:00
Cluster performance and capacity can be scaled up in two ways:
- By adding more resources (CPU, RAM, disk IO, disk space, network bandwidth) to existing nodes in the cluster (aka vertical scalability).
- By adding more nodes to the cluster (aka horizontal scalability).
General recommendations for cluster scalability:
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/Cluster-VictoriaMetrics.md: remove incorrect information about the increase of workload on the remaining vmstorage nodes when one vmstorage node is unavailable If one out of 5 vmstorage nodes is unavailable, then the remaining 4 vmstorage nodes will recieve 1/5=20% increase of workload, not 5%. If one out of 10 vmstorage nodes is unavailable, then the remaining 9 vmstorage nodes will receive 1/10=10% increase of workload, not 1%. This is a follow-up for 458338afa52bdd83e05aa11d1cf5708b26a252d8 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6099
2024-04-17 08:06:39 +00:00
- Adding more CPU and RAM to existing `vmselect` nodes improves the performance for heavy queries, which process big number of time series with big number of raw samples.
See [this article on how to detect and optimize heavy queries](https://valyala.medium.com/how-to-optimize-promql-and-metricsql-queries-85a1b75bf986).
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- Adding more `vmstorage` nodes (aka horizontal scaling) increases the number of [active time series](https://docs.victoriametrics.com/faq/#what-is-an-active-time-series)
the cluster can handle. This also increases query performance over time series with [high churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate),
docs/Cluster-VictoriaMetrics.md: remove incorrect information about the increase of workload on the remaining vmstorage nodes when one vmstorage node is unavailable If one out of 5 vmstorage nodes is unavailable, then the remaining 4 vmstorage nodes will recieve 1/5=20% increase of workload, not 5%. If one out of 10 vmstorage nodes is unavailable, then the remaining 9 vmstorage nodes will receive 1/10=10% increase of workload, not 1%. This is a follow-up for 458338afa52bdd83e05aa11d1cf5708b26a252d8 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6099
2024-04-17 08:06:39 +00:00
since every `vmstorage` node contains lower number of time series when the number of `vmstorage` nodes increases.
The cluster stability is also improved with the number of `vmstorage` nodes, since active `vmstorage` nodes need to handle lower additional workload
docs/Cluster-VictoriaMetrics.md: clarify per-node workload increase when one of vmstorage node is unavailable in the cluster The docs update is based on https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6099#issuecomment-2060856417
2024-04-17 09:56:11 +00:00
when some of `vmstorage` nodes become unavailable. For example, if one node out of 3 nodes is unavailable, then `1/3=33%` of the load is re-distributed across 2 remaining nodes,
so per-node workload increase is `(1/3/2)/(1/3) = 1/2 = 50%`.
If one node out of 10 nodes is unavailable, then `1/10=10%` of the load is re-distributed across 9 remaining nodes, so per-node workload increase is `(1/10/9)/(1/10) = 1/9 =~ 11%`.
docs/Cluster-VictoriaMetrics.md: remove incorrect information about the increase of workload on the remaining vmstorage nodes when one vmstorage node is unavailable If one out of 5 vmstorage nodes is unavailable, then the remaining 4 vmstorage nodes will recieve 1/5=20% increase of workload, not 5%. If one out of 10 vmstorage nodes is unavailable, then the remaining 9 vmstorage nodes will receive 1/10=10% increase of workload, not 1%. This is a follow-up for 458338afa52bdd83e05aa11d1cf5708b26a252d8 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6099
2024-04-17 08:06:39 +00:00
- Adding more CPU and RAM to existing `vmstorage` nodes (aka vertical scaling) increases the number
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
of [active time series](https://docs.victoriametrics.com/faq/#what-is-an-active-time-series) the cluster can handle.
docs/Cluster-VictoriaMetrics.md: remove incorrect information about the increase of workload on the remaining vmstorage nodes when one vmstorage node is unavailable If one out of 5 vmstorage nodes is unavailable, then the remaining 4 vmstorage nodes will recieve 1/5=20% increase of workload, not 5%. If one out of 10 vmstorage nodes is unavailable, then the remaining 9 vmstorage nodes will receive 1/10=10% increase of workload, not 1%. This is a follow-up for 458338afa52bdd83e05aa11d1cf5708b26a252d8 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6099
2024-04-17 08:06:39 +00:00
It is preferred to add more `vmstorage` nodes over adding more CPU and RAM to existing `vmstorage` nodes, since higher number of `vmstorage` nodes
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
increases cluster stability and improves query performance over time series with [high churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate).
docs/Cluster-VictoriaMetrics.md: remove incorrect information about the increase of workload on the remaining vmstorage nodes when one vmstorage node is unavailable If one out of 5 vmstorage nodes is unavailable, then the remaining 4 vmstorage nodes will recieve 1/5=20% increase of workload, not 5%. If one out of 10 vmstorage nodes is unavailable, then the remaining 9 vmstorage nodes will receive 1/10=10% increase of workload, not 1%. This is a follow-up for 458338afa52bdd83e05aa11d1cf5708b26a252d8 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6099
2024-04-17 08:06:39 +00:00
docs/Cluster-VictoriaMetrics.md: improve docs on cluster setup, resizing and scalability
2022-04-15 12:04:10 +00:00
- Adding more `vminsert` nodes increases the maximum possible data ingestion speed, since the ingested data may be split among bigger number of `vminsert` nodes.
docs/Cluster-VictoriaMetrics.md: remove incorrect information about the increase of workload on the remaining vmstorage nodes when one vmstorage node is unavailable If one out of 5 vmstorage nodes is unavailable, then the remaining 4 vmstorage nodes will recieve 1/5=20% increase of workload, not 5%. If one out of 10 vmstorage nodes is unavailable, then the remaining 9 vmstorage nodes will receive 1/10=10% increase of workload, not 1%. This is a follow-up for 458338afa52bdd83e05aa11d1cf5708b26a252d8 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6099
2024-04-17 08:06:39 +00:00
docs/Cluster-VictoriaMetrics.md: improve docs on cluster setup, resizing and scalability
2022-04-15 12:04:10 +00:00
- Adding more `vmselect` nodes increases the maximum possible queries rate, since the incoming concurrent requests may be split among bigger number of `vmselect` nodes.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Steps to add `vmstorage` node:
1. Start new `vmstorage` node with the same `-retentionPeriod` as existing nodes in the cluster.
docs/Cluster-VictoriaMetrics.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:11:28 +00:00
1. Gradually restart all the `vmselect` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`.
1. Gradually restart all the `vminsert` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/cluster: update cluster resizing info (#6099) * docs/cluster: update cluster resizing info - add example of resources distribution - add info about how to handle uneven disk usage after adding a new storage node Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * Update docs/Cluster-VictoriaMetrics.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> (cherry picked from commit 458338afa52bdd83e05aa11d1cf5708b26a252d8)
2024-04-16 13:44:05 +00:00
In order to handle uneven disk space usage distribution after adding new `vmstorage` node it is possible to update `vminsert` configuration to route newly ingested metrics only to new storage nodes. Once disk usage will be similar configuration can be updated to include all nodes again. Note that `vmselect` nodes need to reference all storage nodes for querying.
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Updating / reconfiguring cluster nodes
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
All the node types - `vminsert`, `vmselect` and `vmstorage` - may be updated via graceful shutdown.
Send `SIGINT` signal to the corresponding process, wait until it finishes and then start new version
with new configs.
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
There are the following cluster update / upgrade approaches exist:
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
### No downtime strategy
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
Gracefully restart every node in the cluster one-by-one with the updated config / upgraded binary.
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
It is recommended restarting the nodes in the following order:
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
1. Restart `vmstorage` nodes.
docs/Cluster-VictoriaMetrics.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:11:28 +00:00
1. Restart `vminsert` nodes.
1. Restart `vmselect` nodes.
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
This strategy allows upgrading the cluster without downtime if the following conditions are met:
- The cluster has at least a pair of nodes of each type - `vminsert`, `vmselect` and `vmstorage`,
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
so it can continue to accept new data and serve incoming requests when a single node is temporary unavailable
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
during its restart. See [cluster availability docs](#cluster-availability) for details.
- The cluster has enough compute resources (CPU, RAM, network bandwidth, disk IO) for processing
the current workload when a single node of any type (`vminsert`, `vmselect` or `vmstorage`)
is temporarily unavailable during its restart.
- The updated config / upgraded binary is compatible with the remaining components in the cluster.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
See the [CHANGELOG](https://docs.victoriametrics.com/changelog/) for compatibility notes between different releases.
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
vmcluster: re-routing enhancement (#5293) * app/vmstorage: close vminsert connections gradually before stopping storage Implements graceful shutdown approach suggested here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1768146878 Test results for this can be found here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1790640274 Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * app/vmstorage: update graceful shutdown logic - close connections from vminsert in determenistic order - update flag description - lower default timeout to 25 seconds. 25 seconds value was chosen because the lowest default value used in default configuration deployments is 30s(default value in Kubernetes and ansible-playbooks). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add information about re-routing enhancement during restart Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/changelog: add entry for new command-line flag Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * {app/vmstorage,lib/ingestserver}: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add note to update workload scheduler timeout Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * wip --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-14 00:00:42 +00:00
If at least a single condition isn't met, then the rolling restart may result in cluster unavailability
during the config update / version upgrade. In this case the following strategy is recommended.
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
### Minimum downtime strategy
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
1. Gracefully stop all the `vminsert` and `vmselect` nodes in parallel.
docs/Cluster-VictoriaMetrics.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:11:28 +00:00
1. Gracefully restart all the `vmstorage` nodes in parallel.
1. Start all the `vminsert` and `vmselect` nodes in parallel.
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
The cluster is unavailable for data ingestion and querying when performing the steps above.
The downtime is minimized by restarting cluster nodes in parallel at every step above.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
The `minimum downtime` strategy has the following benefits comparing to `no downtime` strategy:
docs/Cluster-VictoriaMetrics.md: document the best strategies for cluster update / upgrade
2022-08-21 20:18:36 +00:00
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
- It allows performing config update / version upgrade with minimum disruption
when the previous config / version is incompatible with the new config / version.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
- It allows performing config update / version upgrade with minimum disruption
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
when the cluster has no enough compute resources (CPU, RAM, disk IO, network bandwidth)
for rolling upgrade.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
- It allows minimizing the duration of config update / version upgrade for clusters with big number of nodes
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
of for clusters with big `vmstorage` nodes, which may take long time for graceful restart.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/Cluster-VictoriaMetrics.md: move the `Improve re-routing performance during restart` to more appropriate place Previoulsy it was mistakenly inserted between `No downtime strategy` and 'Minimum downtime strategy' chapters. This is a follow-up for 37997abd148e41baad5e855d025b3ec3eca91662 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5293
2024-02-05 12:41:25 +00:00
## Improving re-routing performance during restart
`vmstorage` nodes may experience increased usage for CPU, RAM and disk IO during
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[rolling restarts](https://docs.victoriametrics.com/cluster-victoriametrics/#no-downtime-strategy),
docs/Cluster-VictoriaMetrics.md: move the `Improve re-routing performance during restart` to more appropriate place Previoulsy it was mistakenly inserted between `No downtime strategy` and 'Minimum downtime strategy' chapters. This is a follow-up for 37997abd148e41baad5e855d025b3ec3eca91662 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5293
2024-02-05 12:41:25 +00:00
since they need to process higher load when some of `vmstorage` nodes are temporarily unavailable in the cluster.
docs/Cluster-VictoriaMetrics.md: document -disableReroutingOnUnavailable command-line flag This is a follow-up for 88f0d1572e1f801f551485559e22753916b77416 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5713
2024-02-05 13:17:03 +00:00
The following approaches can be used for reducing resource usage at `vmstorage` nodes during rolling restart:
- To pass `-disableReroutingOnUnavailable` command-line flag to `vminsert` nodes, so they pause data ingestion when `vmstorage` nodes are restarted
instead of re-routing the ingested data to other available `vmstorage` nodes.
docs/Cluster-VictoriaMetrics.md: add a warning that -disableReroutingOnUnavailable command-line flag may result in long pause for data ingestion when some of vmstorage nodes are unavailable for long time
2024-02-06 13:56:43 +00:00
Note that the `-disableReroutingOnUnavailable` flag may pause data ingestion for long time when some `vmstorage` nodes are unavailable
for long time.
docs/Cluster-VictoriaMetrics.md: document -disableReroutingOnUnavailable command-line flag This is a follow-up for 88f0d1572e1f801f551485559e22753916b77416 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5713
2024-02-05 13:17:03 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- To pass bigger values to `-storage.vminsertConnsShutdownDuration` (available from [v1.95.0](https://docs.victoriametrics.com/changelog/#v1950))
docs/Cluster-VictoriaMetrics.md: document -disableReroutingOnUnavailable command-line flag This is a follow-up for 88f0d1572e1f801f551485559e22753916b77416 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5713
2024-02-05 13:17:03 +00:00
command-line flag at `vmstorage` nodes.In this case `vmstorage` increases the interval between gradual closing of `vminsert` connections during graceful shutdown.
This reduces data ingestion slowdown during rollout restarts.
Make sure that the `-storage.vminsertConnsShutdownDuration` is smaller than the graceful shutdown timeout configured at the system which manages `vmstorage`
(e.g. Docker, Kubernetes, systemd, etc.). Otherwise the system may kill `vmstorage` node before it finishes gradual closing of `vminsert` connections.
docs/Cluster-VictoriaMetrics.md: move the `Improve re-routing performance during restart` to more appropriate place Previoulsy it was mistakenly inserted between `No downtime strategy` and 'Minimum downtime strategy' chapters. This is a follow-up for 37997abd148e41baad5e855d025b3ec3eca91662 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5293
2024-02-05 12:41:25 +00:00
See also [minimum downtime strategy](#minimum-downtime-strategy).
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Cluster availability
`make docs-sync`
2020-06-18 20:54:44 +00:00
docs/Cluster-VictoriaMetrics.md: clarify required conditions for cluster availability
2022-08-20 06:39:07 +00:00
VictoriaMetrics cluster architecture prioritizes availability over data consistency.
This means that the cluster remains available for data ingestion and data querying
if some of its components are temporarily unavailable.
VictoriaMetrics cluster remains available if the following conditions are met:
app/vmauth: improve load balancing by sending incoming requests to backends with the lowest number of concurrent requests While at it, stop sending requests to unavailable backend for 3 seconds before the next attempt. This should reduce the amounts of useless work and the number of useless network packets when the backend is temporarily unavailable.
2023-02-11 08:27:40 +00:00
- HTTP load balancer must stop routing requests to unavailable `vminsert` and `vmselect` nodes
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
([vmauth](https://docs.victoriametrics.com/vmauth/) stops routing requests to unavailable nodes).
`make docs-sync`
2020-06-18 20:54:44 +00:00
docs/Cluster-VictoriaMetrics.md: clarify required conditions for cluster availability
2022-08-20 06:39:07 +00:00
- At least a single `vminsert` node must remain available in the cluster for processing data ingestion workload.
The remaining active `vminsert` nodes must have enough compute capacity (CPU, RAM, network bandwidth)
for handling the current data ingestion workload.
If the remaining active `vminsert` nodes have no enough resources for processing the data ingestion workload,
then arbitrary delays may occur during data ingestion.
See [capacity planning](#capacity-planning) and [cluster resizing](#cluster-resizing-and-scalability) docs for more details.
- At least a single `vmselect` node must remain available in the cluster for processing query workload.
The remaining active `vmselect` nodes must have enough compute capacity (CPU, RAM, network bandwidth, disk IO)
for handling the current query workload.
If the remaining active `vmselect` nodes have no enough resources for processing query workload,
then arbitrary failures and delays may occur during query processing.
See [capacity planning](#capacity-planning) and [cluster resizing](#cluster-resizing-and-scalability) docs for more details.
- At least a single `vmstorage` node must remain available in the cluster for accepting newly ingested data
and for processing incoming queries. The remaining active `vmstorage` nodes must have enough compute capacity
(CPU, RAM, network bandwidth, disk IO, free disk space) for handling the current workload.
If the remaining active `vmstorage` nodes have no enough resources for processing query workload,
then arbitrary failures and delay may occur during data ingestion and query processing.
See [capacity planning](#capacity-planning) and [cluster resizing](#cluster-resizing-and-scalability) docs for more details.
The cluster works in the following way when some of `vmstorage` nodes are unavailable:
- `vminsert` re-routes newly ingested data from unavailable `vmstorage` nodes to remaining healthy `vmstorage` nodes.
This guarantees that the newly ingested data is properly saved if the healthy `vmstorage` nodes have enough CPU, RAM, disk IO and network bandwidth
for processing the increased data ingestion workload.
`vminsert` spreads evenly the additional data among the healthy `vmstorage` nodes in order to spread evenly
docs: mentioned that re-routing increases number of active time series Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-12-08 12:29:23 +00:00
the increased load on these nodes. During re-routing, healthy `vmstorage` nodes will experience higher resource usage
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
and increase in number of [active time series](https://docs.victoriametrics.com/faq/#what-is-an-active-time-series).
docs/Cluster-VictoriaMetrics.md: clarify required conditions for cluster availability
2022-08-20 06:39:07 +00:00
- `vmselect` continues serving queries if at least a single `vmstorage` nodes is available.
It marks responses as partial for queries served from the remaining healthy `vmstorage` nodes,
since such responses may miss historical data stored on the temporarily unavailable `vmstorage` nodes.
Every partial JSON response contains `"isPartial": true` option.
If you prefer consistency over availability, then run `vmselect` nodes with `-search.denyPartialResponse` command-line flag.
In this case `vmselect` returns an error if at least a single `vmstorage` node is unavailable.
Another option is to pass `deny_partial_response=1` query arg to requests to `vmselect` nodes.
`make docs-sync`
2020-06-18 20:54:44 +00:00
app/vmselect/netstorage: follow-up after 173ccf4333ff7f5967268ef7bc6ce12512ac7f3b - Clarify docs about -replicationFactor command-line flag at vmselect - Clarify description for -replicationFactor and -search.skipSlowReplicas command-line flags - Fix the logic for returning responses if -search.skipSlowReplicas command-line flag is enabled. The logic was broken in the 173ccf4333ff7f5967268ef7bc6ce12512ac7f3b, so it could return responses only if some of vmstorage nodes return error, while it should return when query results are successfully collected from more than (len(storageNodes) - replicationFactor) vmstorage nodes. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1207 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/711
2023-07-09 18:58:12 +00:00
`vmselect` also accepts `-replicationFactor=N` command-line flag. This flag instructs `vmselect` to return full response
if less than `-replicationFactor` vmstorage nodes are unavailable during querying, since it assumes that the remaining
`vmstorage` nodes contain the full data. See [these docs](#replication-and-data-safety) for details.
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
It is also possible to configure independent replication factor per distinct `vmstorage` groups - see [these docs](#vmstorage-groups-at-vmselect).
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
`vmselect` doesn't serve partial responses for API handlers returning [raw datapoints](https://docs.victoriametrics.com/keyconcepts/#raw-samples),
docs/Cluster-VictoriaMetrics.md: document that /api/v1/query?series_lector[d] returns raw samples Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1148
2024-02-08 16:32:22 +00:00
since users usually expect this data is always complete. The following handlers return raw samples:
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- [`/api/v1/export*` endpoints](https://docs.victoriametrics.com/#how-to-export-time-series)
- [`/api/v1/query`](https://docs.victoriametrics.com/url-examples/#apiv1query) when the `query` contains [series selector](https://docs.victoriametrics.com/keyconcepts/#filtering)
docs/Cluster-VictoriaMetrics.md: document that /api/v1/query?series_lector[d] returns raw samples Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1148
2024-02-08 16:32:22 +00:00
ending with some duration in square brackets. For example, `/api/v1/query?query=up[1h]&time=2024-01-02T03:00:00Z`.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
This query returns [raw samples](https://docs.victoriametrics.com/keyconcepts/#raw-samples) for [time series](https://docs.victoriametrics.com/keyconcepts/#time-series)
docs/Cluster-VictoriaMetrics.md: document that /api/v1/query?series_lector[d] returns raw samples Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1148
2024-02-08 16:32:22 +00:00
with the `up` name on the time range `(2024-01-02T02:00:00 .. 2024-01-02T03:00:00]`. See [this article](https://valyala.medium.com/analyzing-prometheus-data-with-external-tools-5f3e5e147639)
for details.
docs/Cluster-VictoriaMetrics.md: mention that vmselect doesnt serve partial responses from export API Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1148
2021-03-25 19:03:29 +00:00
`make docs-sync`
2020-06-18 20:54:44 +00:00
Data replication can be used for increasing storage durability. See [these docs](#replication-and-data-safety) for details.
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Capacity planning
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
VictoriaMetrics uses lower amounts of CPU, RAM and storage space on production workloads compared to competing solutions (Prometheus, Thanos, Cortex, TimescaleDB, InfluxDB, QuestDB, M3DB) according to [our case studies](https://docs.victoriametrics.com/casestudies/).
docs: clarify `capacity planning` docs
2021-07-07 09:46:50 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Each node type - `vminsert`, `vmselect` and `vmstorage` - can run on the most suitable hardware. Cluster capacity scales linearly with the available resources. The needed amounts of CPU and RAM per each node type highly depends on the workload - the number of [active time series](https://docs.victoriametrics.com/faq/#what-is-an-active-time-series), [series churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate), query types, query qps, etc. It is recommended setting up a test VictoriaMetrics cluster for your production workload and iteratively scaling per-node resources and the number of nodes per node type until the cluster becomes stable. It is recommended setting up [monitoring for the cluster](#monitoring). It helps to determine bottlenecks in cluster setup. It is also recommended following [the troubleshooting docs](https://docs.victoriametrics.com/#troubleshooting).
docs: clarify `capacity planning` docs
2021-07-07 09:46:50 +00:00
The needed storage space for the given retention (the retention is set via `-retentionPeriod` command-line flag at `vmstorage`) can be extrapolated from disk space usage in a test run. For example, if the storage space usage is 10GB after a day-long test run on a production workload, then it will need at least `10GB*100=1TB` of disk space for `-retentionPeriod=100d` (100-days retention period). Storage space usage can be monitored with [the official Grafana dashboard for VictoriaMetrics cluster](#monitoring).
docs: clarify why spare CPU and RAM resources are needed in `capacity planning`
2021-07-13 12:48:25 +00:00
It is recommended leaving the following amounts of spare resources:
docs: clarify `capacity planning` docs
2021-07-07 09:46:50 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- 50% of free RAM across all the node types for reducing the probability of OOM (out of memory) crashes and slowdowns during temporary spikes in workload.
- 50% of spare CPU across all the node types for reducing the probability of slowdowns during temporary spikes in workload.
docs: reduce free disk recommendation from 30% to 20% (#2728) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-06-14 09:54:39 +00:00
- At least 20% of free storage space at the directory pointed by `-storageDataPath` command-line flag at `vmstorage` nodes. See also `-storage.minFreeDiskSpaceBytes` command-line flag [description for vmstorage](#list-of-command-line-flags-for-vmstorage).
docs: clarify `capacity planning` docs
2021-07-07 09:46:50 +00:00
Add note about final deduplication space needs (#5996) Addresses #5975 Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2024-04-03 23:04:12 +00:00
Increase free storage space and `-storage.minFreeDiskSpaceBytes` to match at least the amount of data you plan to ingest in a calendar month: on each vmstorage pod, the monthly final deduplication process will temporarily need as much space as is used for the previous month's data, before it can free up space. For example, if you have a 3 month retention period and you want to keep at least 10 % space free at all times, you could pick 35 % of your total space as value. When some of your vmstorage pods are in [read-only mode](#readonly-mode), the remaining pods will have a higher share of the total data ingestion, and will therefore need more free space the next month.
docs: clarify `capacity planning` docs
2021-07-07 09:46:50 +00:00
Some capacity planning tips for VictoriaMetrics cluster:
docs/Cluster-VictoriaMetrics.md: update cluster scalability tips
2022-05-05 18:08:50 +00:00
- The [replication](#replication-and-data-safety) increases the amounts of needed resources for the cluster by up to `N` times where `N` is replication factor. This is because `vminsert` stores `N` copies of every ingested sample on distinct `vmstorage` nodes. These copies are de-duplicated by `vmselect` during querying. The most cost-efficient and performant solution for data durability is to rely on replicated durable persistent disks such as [Google Compute persistent disks](https://cloud.google.com/compute/docs/disks#pdspecs) instead of using the [replication at VictoriaMetrics level](#replication-and-data-safety).
- It is recommended to run a cluster with big number of small `vmstorage` nodes instead of a cluster with small number of big `vmstorage` nodes. This increases chances that the cluster remains available and stable when some of `vmstorage` nodes are temporarily unavailable during maintenance events such as upgrades, configuration changes or migrations. For example, when a cluster contains 10 `vmstorage` nodes and a single node becomes temporarily unavailable, then the workload on the remaining 9 nodes increases by `1/9=11%`. When a cluster contains 3 `vmstorage` nodes and a single node becomes temporarily unavailable, then the workload on the remaining 2 nodes increases by `1/2=50%`. The remaining `vmstorage` nodes may have no enough free capacity for handling the increased workload. In this case the cluster may become overloaded, which may result to decreased availability and stability.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- Cluster capacity for [active time series](https://docs.victoriametrics.com/faq/#what-is-an-active-time-series) can be increased by increasing RAM and CPU resources per each `vmstorage` node or by adding new `vmstorage` nodes.
docs/Cluster-VictoriaMetrics.md: update cluster scalability tips
2022-05-05 18:08:50 +00:00
- Query latency can be reduced by increasing CPU resources per each `vmselect` node, since each incoming query is processed by a single `vmselect` node. Performance for heavy queries scales with the number of available CPU cores at `vmselect` node, since `vmselect` processes time series referred by the query on all the available CPU cores.
- If the cluster needs to process incoming queries at a high rate, then its capacity can be increased by adding more `vmselect` nodes, so incoming queries could be spread among bigger number of `vmselect` nodes.
docs/Cluster-VictoriaMetrics.md: make the description for `-rpc.disableCompression` command-line flag more clear
2022-05-06 13:24:45 +00:00
- By default `vminsert` compresses the data it sends to `vmstorage` in order to reduce network bandwidth usage. The compression takes additional CPU resources at `vminsert`. If `vminsert` nodes have limited CPU, then the compression can be disabled by passing `-rpc.disableCompression` command-line flag at `vminsert` nodes.
app/{vmselect,vmstorage}: return compression of the data passed from vmstorage to vmselect This reverts cd4f641d323cf0977c2e22915eb75edb765ad090 , since it has been appeared that the disabled compression for vmstorage->vmselect data increase network bandwidth usage by more than 10x on typical production workloads, while it decreases CPU usage at vmstorage by up to 10% and improves query latency by up to 10%. The 10x increase in network usage is too high price for 10% improvements on query latency and vmstorage CPU usage. This may result in network bandwidth bottlenecks, which can reduce the overall performance and stability of VictoriaMetrics cluster. That's why return back the vmstorage->vmselect data compression by default. The vmstorage->vmselect compression can be disabled by passing -rpc.disableCompression command-line flag to vmstorage. The vmselect->vmselect compression in multi-level cluster setup can be disabled by passing -clusternative.disableCompression command-line flag.
2024-01-24 11:32:13 +00:00
- By default `vmstorage` compresses the data it sends to `vmselect` during queries in order to reduce network bandwidth usage. The compression takes additional CPU resources at `vmstorage`. If `vmstorage` nodes have limited CPU, then the compression can be disabled by passing `-rpc.disableCompression` command-line flag at `vmstorage` nodes.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs: add `resource usage limits` docs, which describe fine-grained tuning for various resource usage limits
2022-05-11 16:52:03 +00:00
See also [resource usage limits docs](#resource-usage-limits).
## Resource usage limits
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
By default, cluster components of VictoriaMetrics are tuned for an optimal resource usage under typical workloads.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
Some workloads may need fine-grained resource usage limits. In these cases the following command-line flags may be useful:
- `-memory.allowedPercent` and `-memory.allowedBytes` limit the amounts of memory, which may be used for various internal caches
at all the cluster components of VictoriaMetrics - `vminsert`, `vmselect` and `vmstorage`. Note that VictoriaMetrics components may use more memory,
since these flags don't limit additional memory, which may be needed on a per-query basis.
- `-search.maxMemoryPerQuery` limits the amounts of memory, which can be used for processing a single query at `vmselect` node.
Queries, which need more memory, are rejected. Heavy queries, which select big number of time series,
may exceed the per-query memory limit by a small percent. The total memory limit for concurrently executed queries can be estimated
as `-search.maxMemoryPerQuery` multiplied by `-search.maxConcurrentRequests`.
vmstorage: auto calculate maxUniqueTimeseries based on resources (#6961) ### Describe Your Changes Add support for https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6930 Calculate `-search.maxUniqueTimeseries` by `-search.maxConcurrentRequests` and remaining memory if it's **not set** or **less equal than 0**. The remaining memory is affected by `-memory.allowedPercent`, `-memory.allowedBytes` and cgroup memory limit. ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2024-10-18 11:41:43 +00:00
- `-search.maxUniqueTimeseries` at `vmstorage` component limits the number of unique time series a single query can find and process.
This means that the maximum memory usage and CPU usage a single query can use at `vmstorage` is proportional to `-search.maxUniqueTimeseries`.
By default, `vmstorage` calculates this limit automatically based on the available memory and the maximum number of concurrent read requests (see `-search.maxConcurrentRequests`).
The calculated limit will be printed during process start-up logs and exposed as `vm_search_max_unique_timeseries` metric.
- `-search.maxUniqueTimeseries` at `vmselect` adjusts the limit with the same name at `vmstorage`. The vmstorage limit can be adjusted
only to **lower value** and can't exceed it. By default, vmselect doesn't apply limit adjustments.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-search.maxQueryDuration` at `vmselect` limits the duration of a single query. If the query takes longer than the given duration, then it is canceled.
This allows saving CPU and RAM at `vmselect` and `vmstorage` when executing unexpectedly heavy queries.
docs: clarify flags `-search.maxxxDuration` can only be overridden to… (#7227) … a smaller value with `timeout` arg
2024-10-25 09:11:09 +00:00
The limit can be overridden to a smaller value by passing `timeout` GET parameter.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-search.maxConcurrentRequests` at `vmselect` and `vmstorage` limits the number of concurrent requests a single `vmselect` / `vmstorage` node can process.
Bigger number of concurrent requests usually require bigger amounts of memory at both `vmselect` and `vmstorage`.
For example, if a single query needs 100 MiB of additional memory during its execution, then 100 concurrent queries
may need `100 * 100 MiB = 10 GiB` of additional memory. So it is better to limit the number of concurrent queries,
app/vmselect/prometheus: do not drop `match[]` filters if `-search.ignoreExtraFiltersAtLabelsAPI` flag is set The `match[]` filter is mandatory at /api/v1/series, so it mustn't be dropped here. There is no sense in dropping `match[]` filter together with `extra_label` and `extra_filters[]` at /api/v1/labels and /api/v1/label/.../values if -search.ignoreExtraFiltersAtLabelsAPI commnad-line flag is set, since: - the `match[]` filter triggers slow path at these APIs; - the `extra_label` and `extra_filters[]` filters narrow down the number of matched time series, so they improve performance comparing to the case when only `match[]` filter is left, while `extra_label` and `extra_filters[]` filters are dropped. This is a follow-up for 0b7a23a91d5f29535c3c485f0c1d92f87ae91fef
2024-03-06 11:25:49 +00:00
while pausing additional incoming queries if the concurrency limit is reached.
`vmselect` and `vmstorage` provides `-search.maxQueueDuration` command-line flag for limiting the maximum wait time for paused queries.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
See also `-search.maxMemoryPerQuery` command-line flag at `vmselect`.
- `-search.maxQueueDuration` at `vmselect` and `vmstorage` limits the maximum duration queries may wait for execution when `-search.maxConcurrentRequests`
all: small improvements in error messages and command-line flag descriptions related to concurrency limiters
2023-01-07 08:11:44 +00:00
concurrent queries are executed.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `-search.ignoreExtraFiltersAtLabelsAPI` at `vmselect` enables ignoring of `match[]`, [`extra_filters[]` and `extra_label`](https://docs.victoriametrics.com/#prometheus-querying-api-enhancements)
query args at [/api/v1/labels](https://docs.victoriametrics.com/url-examples/#apiv1labels) and
[/api/v1/label/.../values](https://docs.victoriametrics.com/url-examples/#apiv1labelvalues).
app/vmselect/prometheus: do not drop `match[]` filters if `-search.ignoreExtraFiltersAtLabelsAPI` flag is set The `match[]` filter is mandatory at /api/v1/series, so it mustn't be dropped here. There is no sense in dropping `match[]` filter together with `extra_label` and `extra_filters[]` at /api/v1/labels and /api/v1/label/.../values if -search.ignoreExtraFiltersAtLabelsAPI commnad-line flag is set, since: - the `match[]` filter triggers slow path at these APIs; - the `extra_label` and `extra_filters[]` filters narrow down the number of matched time series, so they improve performance comparing to the case when only `match[]` filter is left, while `extra_label` and `extra_filters[]` filters are dropped. This is a follow-up for 0b7a23a91d5f29535c3c485f0c1d92f87ae91fef
2024-03-06 11:25:49 +00:00
This may be useful for reducing the load on `vmstorage` if the provided extra filters match too many time series.
The downside is that the endpoints can return labels and series, which do not match the provided extra filters.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-search.maxSamplesPerSeries` at `vmselect` limits the number of raw samples the query can process per each time series.
`vmselect` processes raw samples sequentially per each found time series during the query. It unpacks raw samples on the selected time range
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
per each time series into memory and then applies the given [rollup function](https://docs.victoriametrics.com/metricsql/#rollup-functions).
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
The `-search.maxSamplesPerSeries` command-line flag allows limiting memory usage at `vmselect` in the case when the query is executed on a time range,
which contains hundreds of millions of raw samples per each located time series.
docs: add `resource usage limits` docs, which describe fine-grained tuning for various resource usage limits
2022-05-11 16:52:03 +00:00
- `-search.maxSamplesPerQuery` at `vmselect` limits the number of raw samples a single query can process. This allows limiting CPU usage at `vmselect` for heavy queries.
app/vmselect: add -search.maxResponseSeries command-line flag for limiting the number of time series a single response can return This limit can be used for preventing from high memory usage at Grafana when the response returns too many series. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5372
2023-12-09 22:50:35 +00:00
- `-search.maxResponseSeries` at `vmselect` limits the number of time series a single query can return
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
from [`/api/v1/query`](https://docs.victoriametrics.com/keyconcepts/#instant-query) and [`/api/v1/query_range`](https://docs.victoriametrics.com/keyconcepts/#range-query).
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-search.maxPointsPerTimeseries` limits the number of calculated points, which can be returned per each
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
matching time series from [range query](https://docs.victoriametrics.com/keyconcepts/#range-query).
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-search.maxPointsSubqueryPerTimeseries` limits the number of calculated points, which can be generated
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
per each matching time series during [subquery](https://docs.victoriametrics.com/metricsql/#subqueries) evaluation.
- `-search.maxSeriesPerAggrFunc` limits the number of time series, which can be generated by [MetricsQL aggregate functions](https://docs.victoriametrics.com/metricsql/#aggregate-functions) in a single query.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-search.maxSeries` at `vmselect` limits the number of time series, which may be returned from
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[/api/v1/series](https://docs.victoriametrics.com/url-examples/#apiv1series).
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
This endpoint is used mostly by Grafana for auto-completion of metric names, label names and label values.
Queries to this endpoint may take big amounts of CPU time and memory at `vmstorage` and `vmselect` when the database contains
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
big number of unique time series because of [high churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate).
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
In this case it might be useful to set the `-search.maxSeries` to quite low value in order limit CPU and memory usage.
Introduce a flag for limiting the number of time series to delete (cluster version) (#7112) ### Describe Your Changes Introduce the `-search.maxDeleteSeries` flag that limits the number of time series that can be deleted with a single `/api/v1/admin/tsdb/delete_series` call. Currently, any number can be deleted and if the number is big (millions) then the operation may result in unaccounted CPU and memory usage spikes which in some cases may result in OOM kill (see #7027). The flag limits the number to 30k by default and the users may override it if needed at the vmstorage start time. Related issue: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/7027 --------- Signed-off-by: Artem Fetishev <rtm@victoriametrics.com>
2024-09-30 10:43:11 +00:00
- `-search.maxDeleteSeries` at `vmselect` limits the number of unique time
series that can be deleted by a single
[/api/v1/admin/tsdb/delete_series](https://docs.victoriametrics.com/url-examples/#apiv1admintsdbdelete_series)
call. Deleting too many time series may require big amount of CPU and memory
at `vmstorage` and this limit guards against unplanned resource usage spikes.
Also see [How to delete time series](#how-to-delete-time-series) section to
learn about different ways of deleting series.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-search.maxTagKeys` at `vmstorage` limits the number of items, which may be returned from
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[/api/v1/labels](https://docs.victoriametrics.com/url-examples/#apiv1labels). This endpoint is used mostly by Grafana
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
for auto-completion of label names. Queries to this endpoint may take big amounts of CPU time and memory at `vmstorage` and `vmselect`
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
when the database contains big number of unique time series because of [high churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate).
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
In this case it might be useful to set the `-search.maxTagKeys` to quite low value in order to limit CPU and memory usage.
app/vmselect: add -search.maxLabelsAPIDuration and -search.maxLabelsAPISeries options for fine-tuning CPU and RAM usage for /api/v1/series , /api/v1/labels and /api/v1/label/.../values This commit returns back limits for these endpoints, which have been removed at 5d66ee88bdb2bbab6419a2854a130c8838998923 , since it has been appeared that missing limits result in high CPU usage, while the introduced concurrency limiter results in failed lightweight requests to these endpoints because of timeout when heavyweight requests are executed. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5055
2024-02-23 00:44:07 +00:00
See also `-search.maxLabelsAPIDuration` and `-search.maxLabelsAPISeries`.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-search.maxTagValues` at `vmstorage` limits the number of items, which may be returned from
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[/api/v1/label/.../values](https://docs.victoriametrics.com/url-examples/#apiv1labelvalues). This endpoint is used mostly by Grafana
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
for auto-completion of label values. Queries to this endpoint may take big amounts of CPU time and memory at `vmstorage` and `vmselect`
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
when the database contains big number of unique time series because of [high churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate).
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
In this case it might be useful to set the `-search.maxTagValues` to quite low value in order to limit CPU and memory usage.
app/vmselect: add -search.maxLabelsAPIDuration and -search.maxLabelsAPISeries options for fine-tuning CPU and RAM usage for /api/v1/series , /api/v1/labels and /api/v1/label/.../values This commit returns back limits for these endpoints, which have been removed at 5d66ee88bdb2bbab6419a2854a130c8838998923 , since it has been appeared that missing limits result in high CPU usage, while the introduced concurrency limiter results in failed lightweight requests to these endpoints because of timeout when heavyweight requests are executed. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5055
2024-02-23 00:44:07 +00:00
See also `-search.maxLabelsAPIDuration` and `-search.maxLabelsAPISeries`.
- `-search.maxLabelsAPISeries` at `vmselect` limits the number of time series, which can be scanned
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
when performing [/api/v1/labels](https://docs.victoriametrics.com/url-examples/#apiv1labels),
[/api/v1/label/.../values](https://docs.victoriametrics.com/url-examples/#apiv1labelvalues)
or [/api/v1/series](https://docs.victoriametrics.com/url-examples/#apiv1series) requests.
app/vmselect: add -search.maxLabelsAPIDuration and -search.maxLabelsAPISeries options for fine-tuning CPU and RAM usage for /api/v1/series , /api/v1/labels and /api/v1/label/.../values This commit returns back limits for these endpoints, which have been removed at 5d66ee88bdb2bbab6419a2854a130c8838998923 , since it has been appeared that missing limits result in high CPU usage, while the introduced concurrency limiter results in failed lightweight requests to these endpoints because of timeout when heavyweight requests are executed. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5055
2024-02-23 00:44:07 +00:00
These endpoints are used mostly by Grafana for auto-completion of label names and label values. Queries to these endpoints may take big amounts of CPU time and memory
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
when the database contains big number of unique time series because of [high churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate).
app/vmselect: add -search.maxLabelsAPIDuration and -search.maxLabelsAPISeries options for fine-tuning CPU and RAM usage for /api/v1/series , /api/v1/labels and /api/v1/label/.../values This commit returns back limits for these endpoints, which have been removed at 5d66ee88bdb2bbab6419a2854a130c8838998923 , since it has been appeared that missing limits result in high CPU usage, while the introduced concurrency limiter results in failed lightweight requests to these endpoints because of timeout when heavyweight requests are executed. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5055
2024-02-23 00:44:07 +00:00
In this case it might be useful to set the `-search.maxLabelsAPISeries` to quite low value in order to limit CPU and memory usage.
app/vmselect/prometheus: add -search.ignoreExtraFiltersAtLabelsAPI command-line flag for ignoring extra_filters and extra_label args at /api/v1/labels, /api/v1/label/.../values and /api/v1/series
2024-02-29 10:59:11 +00:00
See also `-search.maxLabelsAPIDuration` and `-search.ignoreExtraFiltersAtLabelsAPI`.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
- `-search.maxLabelsAPIDuration` at `vmselect` limits the duration for requests to [/api/v1/labels](https://docs.victoriametrics.com/url-examples/#apiv1labels),
[/api/v1/label/.../values](https://docs.victoriametrics.com/url-examples/#apiv1labelvalues)
or [/api/v1/series](https://docs.victoriametrics.com/url-examples/#apiv1series).
docs: clarify flags `-search.maxxxDuration` can only be overridden to… (#7227) … a smaller value with `timeout` arg
2024-10-25 09:11:09 +00:00
The limit can be overridden to a smaller value by passing `timeout` GET parameter.
app/vmselect: add -search.maxLabelsAPIDuration and -search.maxLabelsAPISeries options for fine-tuning CPU and RAM usage for /api/v1/series , /api/v1/labels and /api/v1/label/.../values This commit returns back limits for these endpoints, which have been removed at 5d66ee88bdb2bbab6419a2854a130c8838998923 , since it has been appeared that missing limits result in high CPU usage, while the introduced concurrency limiter results in failed lightweight requests to these endpoints because of timeout when heavyweight requests are executed. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5055
2024-02-23 00:44:07 +00:00
These endpoints are used mostly by Grafana for auto-completion of label names and label values. Queries to these endpoints may take big amounts of CPU time and memory
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
when the database contains big number of unique time series because of [high churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate).
app/vmselect: add -search.maxLabelsAPIDuration and -search.maxLabelsAPISeries options for fine-tuning CPU and RAM usage for /api/v1/series , /api/v1/labels and /api/v1/label/.../values This commit returns back limits for these endpoints, which have been removed at 5d66ee88bdb2bbab6419a2854a130c8838998923 , since it has been appeared that missing limits result in high CPU usage, while the introduced concurrency limiter results in failed lightweight requests to these endpoints because of timeout when heavyweight requests are executed. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5055
2024-02-23 00:44:07 +00:00
In this case it might be useful to set the `-search.maxLabelsAPIDuration` to quite low value in order to limit CPU and memory usage.
app/vmselect/prometheus: add -search.ignoreExtraFiltersAtLabelsAPI command-line flag for ignoring extra_filters and extra_label args at /api/v1/labels, /api/v1/label/.../values and /api/v1/series
2024-02-29 10:59:11 +00:00
See also `-search.maxLabelsAPISeries` and `-search.ignoreExtraFiltersAtLabelsAPI`.
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
- `-storage.maxDailySeries` at `vmstorage` can be used for limiting the number of time series seen per day aka
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[time series churn rate](https://docs.victoriametrics.com/faq/#what-is-high-churn-rate). See [cardinality limiter docs](#cardinality-limiter).
- `-storage.maxHourlySeries` at `vmstorage` can be used for limiting the number of [active time series](https://docs.victoriametrics.com/faq/#what-is-an-active-time-series).
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
See [cardinality limiter docs](#cardinality-limiter).
docs: add `resource usage limits` docs, which describe fine-grained tuning for various resource usage limits
2022-05-11 16:52:03 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
See also [capacity planning docs](#capacity-planning) and [cardinality limiter in vmagent](https://docs.victoriametrics.com/vmagent/#cardinality-limiter).
docs: add `resource usage limits` docs, which describe fine-grained tuning for various resource usage limits
2022-05-11 16:52:03 +00:00
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## High availability
docs/Cluster-VictoriaMetrics.md: add `high availability` chapter
2020-06-20 12:53:02 +00:00
docs/Cluster-VictoriaMetrics.md: clarify high availability docs
2022-04-08 09:51:14 +00:00
The database is considered highly available if it continues accepting new data and processing incoming queries when some of its components are temporarily unavailable.
VictoriaMetrics cluster is highly available according to this definition - see [cluster availability docs](#cluster-availability).
docs/Cluster-VictoriaMetrics.md: add `high availability` chapter
2020-06-20 12:53:02 +00:00
It is recommended to run all the components for a single cluster in the same subnetwork with high bandwidth, low latency and low error rates.
docs/Cluster-VictoriaMetrics.md: clarify high availability docs
2022-04-08 09:51:14 +00:00
This improves cluster performance and availability. It isn't recommended spreading components for a single cluster
across multiple availability zones, since cross-AZ network usually has lower bandwidth, higher latency and higher
error rates comparing the network inside a single AZ.
docs/Cluster-VictoriaMetrics.md: add `high availability` chapter
2020-06-20 12:53:02 +00:00
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
If you need multi-AZ setup, then it is recommended running independent clusters in each AZ and setting up
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[vmagent](https://docs.victoriametrics.com/vmagent/) in front of these clusters, so it could replicate incoming data
into all the cluster - see [these docs](https://docs.victoriametrics.com/vmagent/#multitenancy) for details.
app/vmselect: add ability to query `vmselect` from another `vmselect`
2022-07-06 10:19:45 +00:00
Then an additional `vmselect` nodes can be configured for reading the data from multiple clusters according to [these docs](#multi-level-cluster-setup).
docs/Cluster-VictoriaMetrics.md: add `high availability` chapter
2020-06-20 12:53:02 +00:00
app/vminsert: add support for data ingestion via other vminsert nodes
2021-05-08 14:55:44 +00:00
## Multi-level cluster setup
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
`vmselect` nodes can be queried by other `vmselect` nodes if they run with `-clusternativeListenAddr` command-line flag.
For example, if `vmselect` is started with `-clusternativeListenAddr=:8401`, then it can accept queries from another `vmselect` nodes at TCP port 8401
in the same way as `vmstorage` nodes do. This allows chaining `vmselect` nodes and building multi-level cluster topologies.
For example, the top-level `vmselect` node can query second-level `vmselect` nodes in different availability zones (AZ),
while the second-level `vmselect` nodes can query `vmstorage` nodes in local AZ. See also [vmstorage groups at vmselect](#vmstorage-groups-at-vmselect).
app/vmselect: add ability to query `vmselect` from another `vmselect`
2022-07-06 10:19:45 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
`vminsert` nodes can accept data from another `vminsert` nodes if they run with `-clusternativeListenAddr` command-line flag.
For example, if `vminsert` is started with `-clusternativeListenAddr=:8400`, then it can accept data from another `vminsert` nodes at TCP port 8400
in the same way as `vmstorage` nodes do. This allows chaining `vminsert` nodes and building multi-level cluster topologies.
For example, the top-level `vminsert` node can replicate data among the second level of `vminsert` nodes located in distinct availability zones (AZ),
while the second-level `vminsert` nodes can spread the data among `vmstorage` nodes in local AZ.
app/vminsert: add support for data ingestion via other vminsert nodes
2021-05-08 14:55:44 +00:00
docs/Cluster-VictoriaMetrics.md: mention about possible issues with multi-level cluster setup
2022-04-15 11:26:01 +00:00
The multi-level cluster setup for `vminsert` nodes has the following shortcomings because of synchronous replication and data sharding:
* Data ingestion speed is limited by the slowest link to AZ.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
* `vminsert` nodes at top level re-route incoming data to the remaining AZs when some AZs are temporarily unavailable. This results in data gaps at AZs which were temporarily unavailable.
docs/Cluster-VictoriaMetrics.md: mention about possible issues with multi-level cluster setup
2022-04-15 11:26:01 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
These issues are addressed by [vmagent](https://docs.victoriametrics.com/vmagent/) when it runs in [multitenancy mode](https://docs.victoriametrics.com/vmagent/#multitenancy).
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
`vmagent` buffers data, which must be sent to a particular AZ, when this AZ is temporarily unavailable. The buffer is stored on disk. The buffered data is sent to AZ as soon as it becomes available.
## vmstorage groups at vmselect
`vmselect` can be configured to query multiple distinct groups of `vmstorage` nodes with individual `-replicationFactor` per each group.
The following format for `-storageNode` command-line flag value should be used for assigning a particular `addr` of `vmstorage` to a particular `groupName` -
app/vmselect/netstorage: add support for the ability to set cross-group replication factor at vmselect The cross-group replication factor can be set via `-globalReplicationFactor` command-line flag at vmselect. In this case vmselect continues returning full responses if up to globalReplicationFactor-1 groups are unavailable. See https://docs.victoriametrics.com/cluster-victoriametrics/#vmstorage-groups-at-vmselect for details. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6054
2024-04-18 22:09:15 +00:00
`-storageNode=groupName/addr`. The `groupName` can contain arbitrary value. The only rule is that every `vmstorage` group must have an unique name.
For example, the following command runs `vmselect`, which continues returning full responses if up to one node per each group is temporarily unavailable
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
because the given `-replicationFactor=2` is applied individually per each group:
docs/Cluster-VictoriaMetrics.md: meniton that vmagent can be used for replicating the data among multiple clusters Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1491
2021-08-12 09:46:08 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
```
/path/to/vmselect \
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
-replicationFactor=2 \
app/vmselect/netstorage: add support for the ability to set cross-group replication factor at vmselect The cross-group replication factor can be set via `-globalReplicationFactor` command-line flag at vmselect. In this case vmselect continues returning full responses if up to globalReplicationFactor-1 groups are unavailable. See https://docs.victoriametrics.com/cluster-victoriametrics/#vmstorage-groups-at-vmselect for details. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6054
2024-04-18 22:09:15 +00:00
-storageNode=g1/host1,g1/host2,g1/host3 \
-storageNode=g2/host4,g2/host5,g2/host6 \
-storageNode=g3/host7,g3/host8,g3/host9
```
It is possible specifying distinct `-replicationFactor` per each group via the following format - `-replicationFactor=groupName:rf`.
For example, the following command runs `vmselect`, which uses `-replicationFactor=3` for the group `g1`, `-replicationFactor=2` for the group `g2`
and `-replicationFactor=1` for the group `g3`:
```
/path/to/vmselect \
-replicationFactor=g1:3 \
-storageNode=g1/host1,g1/host2,g1/host3 \
-replicationFactor=g2:2 \
-storageNode=g2/host4,g2/host5,g2/host6 \
-replicationFactor=g3:1 \
-storageNode=g3/host4,g3/host5,g3/host6
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
```
app/vmselect/netstorage: add support for the ability to set cross-group replication factor at vmselect The cross-group replication factor can be set via `-globalReplicationFactor` command-line flag at vmselect. In this case vmselect continues returning full responses if up to globalReplicationFactor-1 groups are unavailable. See https://docs.victoriametrics.com/cluster-victoriametrics/#vmstorage-groups-at-vmselect for details. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6054
2024-04-18 22:09:15 +00:00
If every ingested sample is replicated across multiple `vmstorage` groups, then pass `-globalReplicationFactor=N` command-line flag to `vmselect`,
so it could continue returning full responses if up to `N-1` `vmstorage` groups are temporarily unavailable.
For example, the following command runs `vmselect`, which continues returning full responses if any number of `vmstorage` nodes
in a single `vmstorage` group are temporarily unavailable:
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
```
/path/to/vmselect \
app/vmselect/netstorage: add support for the ability to set cross-group replication factor at vmselect The cross-group replication factor can be set via `-globalReplicationFactor` command-line flag at vmselect. In this case vmselect continues returning full responses if up to globalReplicationFactor-1 groups are unavailable. See https://docs.victoriametrics.com/cluster-victoriametrics/#vmstorage-groups-at-vmselect for details. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6054
2024-04-18 22:09:15 +00:00
-globalReplicationFactor=2 \
-storageNode=g1/host1,g1/host2,g1/host3 \
-storageNode=g2/host4,g2/host5,g2/host6 \
-storageNode=g3/host7,g3/host8,g3/host9
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
```
app/vmselect: add ability to query `vmselect` from another `vmselect`
2022-07-06 10:19:45 +00:00
docs/Cluster-VictoriaMetrics.md: typo fix after dadeb6620a716a90609de3282fb35deb4d98bc62: folling -> following
2024-04-18 22:24:46 +00:00
It is OK to mix `-replicationFactor` and `-globalReplicationFactor`. For example, the following command runs `vmselect`, which continues returning full responses
app/vmselect/netstorage: add support for the ability to set cross-group replication factor at vmselect The cross-group replication factor can be set via `-globalReplicationFactor` command-line flag at vmselect. In this case vmselect continues returning full responses if up to globalReplicationFactor-1 groups are unavailable. See https://docs.victoriametrics.com/cluster-victoriametrics/#vmstorage-groups-at-vmselect for details. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6054
2024-04-18 22:09:15 +00:00
if any number of `vmstorage` nodes in a single `vmstorage` group are temporarily unavailable and the remaining groups contain up to two unavailable `vmstorage` node:
```
/path/to/vmselect \
-globalReplicationFactor=2 \
-replicationFactor=3 \
-storageNode=g1/host1,g1/host2,g1/host3 \
-storageNode=g2/host4,g2/host5,g2/host6 \
-storageNode=g3/host7,g3/host8,g3/host9
```
See also [multi-level cluster setup](#multi-level-cluster-setup).
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Helm
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Helm chart simplifies managing cluster version of VictoriaMetrics in Kubernetes.
It is available in the [helm-charts](https://github.com/VictoriaMetrics/helm-charts) repository.
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Kubernetes operator
docs/Cluster-VictoriaMetrics.md: mention about Kubernetes operator
2020-08-12 18:14:55 +00:00
[K8s operator](https://github.com/VictoriaMetrics/operator) simplifies managing VictoriaMetrics components in Kubernetes.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Replication and data safety
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
By default, VictoriaMetrics offloads replication to the underlying storage pointed by `-storageDataPath` such as [Google compute persistent disk](https://cloud.google.com/compute/docs/disks#pdspecs),
which guarantees data durability. VictoriaMetrics supports application-level replication if replicated durable persistent disks cannot be used for some reason.
docs/Cluster-VictoriaMetrics.md: clarify replication docs
2021-02-14 23:44:11 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
The replication can be enabled by passing `-replicationFactor=N` command-line flag to `vminsert`. This instructs `vminsert` to store `N` copies for every ingested sample
on `N` distinct `vmstorage` nodes. This guarantees that all the stored data remains available for querying if up to `N-1` `vmstorage` nodes are unavailable.
app/vmselect/netstorage: follow-up after 173ccf4333ff7f5967268ef7bc6ce12512ac7f3b - Clarify docs about -replicationFactor command-line flag at vmselect - Clarify description for -replicationFactor and -search.skipSlowReplicas command-line flags - Fix the logic for returning responses if -search.skipSlowReplicas command-line flag is enabled. The logic was broken in the 173ccf4333ff7f5967268ef7bc6ce12512ac7f3b, so it could return responses only if some of vmstorage nodes return error, while it should return when query results are successfully collected from more than (len(storageNodes) - replicationFactor) vmstorage nodes. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1207 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/711
2023-07-09 18:58:12 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
Passing `-replicationFactor=N` command-line flag to `vmselect` instructs it to not mark responses as `partial` if less than `-replicationFactor` vmstorage nodes are unavailable during the query.
See [cluster availability docs](#cluster-availability) for details.
docs/Cluster-VictoriaMetrics.md: update `Replication and data safety` chapter
2020-06-03 17:24:15 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
The cluster must contain at least `2*N-1` `vmstorage` nodes, where `N` is replication factor, in order to maintain the given replication factor
for newly ingested data when `N-1` of storage nodes are unavailable.
docs/Cluster-VictoriaMetrics.md: update `Replication and data safety` chapter
2020-06-03 17:24:15 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
VictoriaMetrics stores timestamps with millisecond precision, so `-dedup.minScrapeInterval=1ms` command-line flag must be passed to `vmselect` nodes when the replication is enabled,
so they could de-duplicate replicated samples obtained from distinct `vmstorage` nodes during querying. If duplicate data is pushed to VictoriaMetrics
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
from identically configured [vmagent](https://docs.victoriametrics.com/vmagent/) instances or Prometheus instances, then the `-dedup.minScrapeInterval` must be set
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
to `scrape_interval` from scrape configs according to [deduplication docs](#deduplication).
docs/Cluster-VictoriaMetrics.md: update `Replication and data safety` chapter
2020-06-03 17:24:15 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
Note that [replication doesn't save from disaster](https://medium.com/@valyala/speeding-up-backups-for-big-time-series-databases-533c1a927883),
so it is recommended performing regular backups. See [these docs](#backups) for details.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
app/vmselect: add support for vmstorage groups with independent -replicationFactor per group Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5197 See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#vmstorage-groups-at-vmselect Thanks to @zekker6 for the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/718
2023-12-12 22:06:30 +00:00
Note that the replication increases resource usage - CPU, RAM, disk space, network bandwidth - by up to `-replicationFactor=N` times, because `vminsert` stores `N` copies
of incoming data to distinct `vmstorage` nodes and `vmselect` needs to de-duplicate the replicated data obtained from `vmstorage` nodes during querying.
So it is more cost-effective to offload the replication to underlying replicated durable storage pointed by `-storageDataPath`
such as [Google Compute Engine persistent disk](https://cloud.google.com/compute/docs/disks/#pdspecs), which is protected from data loss and data corruption.
It also provides consistently high performance and [may be resized](https://cloud.google.com/compute/docs/disks/add-persistent-disk) without downtime.
HDD-based persistent disks should be enough for the majority of use cases. It is recommended using durable replicated persistent volumes in Kubernetes.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/Cluster-VictoriaMetrics.md: move here the `deduplication` docs related to cluster version
2022-05-02 12:53:34 +00:00
## Deduplication
docs: update dedup docs for cluster * remove repeating sentences * clarify why identical dedup config is important Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit d9982520a8d9ea78bb4be4c8fafa3bb0cff965d0)
2024-08-28 10:59:48 +00:00
Cluster version of VictoriaMetrics supports data deduplication in the same way as single-node version do.
See [these docs](https://docs.victoriametrics.com/#deduplication) for details. The only difference is that
deduplication can't be guaranteed when samples and sample duplicates for the same time series end up on different
`vmstorage` nodes. This could happen in the following scenarios:
docs/Cluster-VictoriaMetrics.md: move here the `deduplication` docs related to cluster version
2022-05-02 12:53:34 +00:00
docs: update dedup docs for cluster * remove repeating sentences * clarify why identical dedup config is important Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit d9982520a8d9ea78bb4be4c8fafa3bb0cff965d0)
2024-08-28 10:59:48 +00:00
* when adding/removing `vmstorage` nodes a new samples for time series will be re-routed to another `vmstorage` nodes;
docs/Cluster-VictoriaMetrics.md: move here the `deduplication` docs related to cluster version
2022-05-02 12:53:34 +00:00
* when `vmstorage` nodes are temporarily unavailable (for instance, during their restart). Then new samples are re-routed to the remaining available `vmstorage` nodes;
* when `vmstorage` node has no enough capacity for processing incoming data stream. Then `vminsert` re-routes new samples to other `vmstorage` nodes.
docs: update dedup docs for cluster * remove repeating sentences * clarify why identical dedup config is important Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit d9982520a8d9ea78bb4be4c8fafa3bb0cff965d0)
2024-08-28 10:59:48 +00:00
It is recommended to set **the same** `-dedup.minScrapeInterval` command-line flag value to both `vmselect` and `vmstorage` nodes
to ensure query results consistency, even if storage layer didn't complete deduplication yet.
docs/Cluster-VictoriaMetrics.md: move here the `deduplication` docs related to cluster version
2022-05-02 12:53:34 +00:00
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Backups
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
It is recommended performing periodical backups from [instant snapshots](https://medium.com/@valyala/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282)
for protecting from user errors such as accidental data deletion.
The following steps must be performed for each `vmstorage` node for creating a backup:
1. Create an instant snapshot by navigating to `/snapshot/create` HTTP handler. It will create snapshot and return its name.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
1. Archive the created snapshot from `<-storageDataPath>/snapshots/<snapshot_name>` folder using [vmbackup](https://docs.victoriametrics.com/vmbackup/).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
The archival process doesn't interfere with `vmstorage` work, so it may be performed at any suitable time.
docs/Cluster-VictoriaMetrics.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:11:28 +00:00
1. Delete unused snapshots via `/snapshot/delete?snapshot=<snapshot_name>` or `/snapshot/delete_all` in order to free up occupied storage space.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
There is no need in synchronizing backups among all the `vmstorage` nodes.
Restoring from backup:
1. Stop `vmstorage` node with `kill -INT`.
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
1. Restore data from backup using [vmrestore](https://docs.victoriametrics.com/vmrestore/) into `-storageDataPath` directory.
docs/Cluster-VictoriaMetrics.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:11:28 +00:00
1. Start `vmstorage` node.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
lib/storage: add support for retention filters (aka multiple retentions for distinct sets of time series) Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/143 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/289
2022-10-24 00:02:14 +00:00
## Retention filters
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
[VictoriaMetrics enterprise](https://docs.victoriametrics.com/enterprise/) supports configuring multiple retentions for distinct sets of time series
by passing `-retentionFilter` command-line flag to `vmstorage` nodes. See [these docs](https://docs.victoriametrics.com/#retention-filters) for details on this feature.
lib/storage: add support for retention filters (aka multiple retentions for distinct sets of time series) Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/143 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/289
2022-10-24 00:02:14 +00:00
Additionally, enterprise version of VictoriaMetrics cluster supports multiple retentions for distinct sets of [tenants](#multitenancy)
by specifying filters on `vm_account_id` and/or `vm_project_id` pseudo-labels in `-retentionFilter` command-line flag.
If the tenant doesn't match specified `-retentionFilter` options, then the global `-retentionPeriod` is used for it.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
For example, the following config sets retention to 1 day for [tenants](#multitenancy) with `accountID` starting from `42`,
lib/storage: add support for retention filters (aka multiple retentions for distinct sets of time series) Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/143 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/289
2022-10-24 00:02:14 +00:00
then sets retention to 3 days for time series with label `env="dev"` or `env="prod"` from any tenant,
while the rest of tenants will have 4 weeks retention:
```
-retentionFilter='{vm_account_id=~"42.*"}:1d' -retentionFilter='{env=~"dev|staging"}:3d' -retentionPeriod=4w
```
It is OK to mix filters on real labels with filters on `vm_account_id` and `vm_project_id` pseudo-labels.
For example, the following config sets retention to 5 days for time series with `env="dev"` label from [tenant](#multitenancy) `accountID=5`:
```
-retentionFilter='{vm_account_id="5",env="dev"}:5d'
```
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
See also [these docs](https://docs.victoriametrics.com/#retention-filters) for additional details on retention filters.
lib/storage: add ability to use downsampling for the given series filter (#733) * lib/storage: add ability to use downsampling for the given series filter Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: add information about downsampling filters Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix MetricsQL filter Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: treat missing downsampling filter as a bug Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/part_header: verify correctness of downsampling filters when opening partition Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: save only appliable rules in part metadata Filter and save only rules which are appliable to partition based on MinTimestamp of stored data. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: update log messages for final dedup Properly specify a reason of re-running deduplication for partition. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage: consistently use MaxTimestamp to determine deduplication/downsampling rules Using MinTimestamp leads to applying downsampling to parts which are only partially covered by downsampling rule. For example, partition covers range [1000-2000]. At t=2100 and rule offset 500 data with t=2100-500 => 1600 must be downsampled. The range check against MinTimestamp evaluates to true even though partition contains range which must not be downsampled - [1600:2000]. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * Follow-up - Apply the first matching downsampling period if multiple filters match the given time series. This allows fine-tuning the downsampling config for the specific needs. - Take into account downsampling filters during search queries. - Reduce the difference between community and enterprise branches. This should simplify further maintenance of these branches. - Properly parse series filters with colons inside them. - Document the feature at docs/CHANGELOG.md. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4960 --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2024-03-30 01:54:54 +00:00
See also [downsampling](#downsampling).
lib/storage: add support for retention filters (aka multiple retentions for distinct sets of time series) Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/143 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/289
2022-10-24 00:02:14 +00:00
docs: use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest instead of https://github.com/VictoriaMetrics/VictoriaMetrics/releases link where needed The https://github.com/VictoriaMetrics/VictoriaMetrics/releases link may show non-latest releases at the top, such as LTS releases or VictoriaLogs releases. So it is better to use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest link, which always redirect to the latest available release of VictoriaMetrics.
2023-10-18 18:06:23 +00:00
Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest).
docs: mention the free trial for enterprise Signed-off-by: Artem Navoiev <tenmozes@gmail.com> (cherry picked from commit 636d4ea1966fff070a365ed3735f06da0d38d9bf)
2023-10-08 18:11:55 +00:00
See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/).
lib/storage: add support for retention filters (aka multiple retentions for distinct sets of time series) Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/143 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/289
2022-10-24 00:02:14 +00:00
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
## Downsampling
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Downsampling is available in [enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise/).
It is configured with `-downsampling.period` command-line flag according to [these docs](https://docs.victoriametrics.com/#downsampling).
docs/Cluster-VictoriaMetrics.md: clarify the description on why -dosnwampling.period must be set at both vmstorage and vmselect This is a follow-up for ca7457d906cf20aa885e330afa67059a39d96e77
2023-10-31 15:53:44 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
It is possible to downsample series, which belong to a particular [tenant](#multitenancy) by using [filters](https://docs.victoriametrics.com/keyconcepts/#filtering)
lib/storage: add ability to use downsampling for the given series filter (#733) * lib/storage: add ability to use downsampling for the given series filter Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: add information about downsampling filters Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix MetricsQL filter Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: treat missing downsampling filter as a bug Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/part_header: verify correctness of downsampling filters when opening partition Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: save only appliable rules in part metadata Filter and save only rules which are appliable to partition based on MinTimestamp of stored data. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: update log messages for final dedup Properly specify a reason of re-running deduplication for partition. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage: consistently use MaxTimestamp to determine deduplication/downsampling rules Using MinTimestamp leads to applying downsampling to parts which are only partially covered by downsampling rule. For example, partition covers range [1000-2000]. At t=2100 and rule offset 500 data with t=2100-500 => 1600 must be downsampled. The range check against MinTimestamp evaluates to true even though partition contains range which must not be downsampled - [1600:2000]. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * Follow-up - Apply the first matching downsampling period if multiple filters match the given time series. This allows fine-tuning the downsampling config for the specific needs. - Take into account downsampling filters during search queries. - Reduce the difference between community and enterprise branches. This should simplify further maintenance of these branches. - Properly parse series filters with colons inside them. - Document the feature at docs/CHANGELOG.md. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4960 --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2024-03-30 01:54:54 +00:00
on `vm_account_id` or `vm_project_id` pseudo-labels in `-downsampling.period` command-line flag. For example, the following config leaves the last sample per each minute for samples
docs: clarify that downsampling drops all the samples except the last one on every downsampling interval
2024-04-04 11:48:28 +00:00
older than one hour only for [tenants](#multitenancy) with accountID equal to 12 and 42, while series for other tenants are dropped:
lib/storage: add ability to use downsampling for the given series filter (#733) * lib/storage: add ability to use downsampling for the given series filter Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: add information about downsampling filters Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix MetricsQL filter Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: treat missing downsampling filter as a bug Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/part_header: verify correctness of downsampling filters when opening partition Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: save only appliable rules in part metadata Filter and save only rules which are appliable to partition based on MinTimestamp of stored data. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: update log messages for final dedup Properly specify a reason of re-running deduplication for partition. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage: consistently use MaxTimestamp to determine deduplication/downsampling rules Using MinTimestamp leads to applying downsampling to parts which are only partially covered by downsampling rule. For example, partition covers range [1000-2000]. At t=2100 and rule offset 500 data with t=2100-500 => 1600 must be downsampled. The range check against MinTimestamp evaluates to true even though partition contains range which must not be downsampled - [1600:2000]. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * Follow-up - Apply the first matching downsampling period if multiple filters match the given time series. This allows fine-tuning the downsampling config for the specific needs. - Take into account downsampling filters during search queries. - Reduce the difference between community and enterprise branches. This should simplify further maintenance of these branches. - Properly parse series filters with colons inside them. - Document the feature at docs/CHANGELOG.md. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4960 --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2024-03-30 01:54:54 +00:00
```
-downsampling.period='{vm_account_id=~"12|42"}:1h:1m'
```
It is OK to mix filters on real labels with filters on `vm_account_id` and `vm_project_id` pseudo-labels.
For example, the following config instructs leaving the last sample per hour after 30 days for time series with `env="dev"` label from [tenant](#multitenancy) `accountID=5`:
```
-downsampling.period='{vm_account_id="5",env="dev"}:30d:1h'
```
docs/Cluster-VictoriaMetrics.md: clarify the description on why -dosnwampling.period must be set at both vmstorage and vmselect This is a follow-up for ca7457d906cf20aa885e330afa67059a39d96e77
2023-10-31 15:53:44 +00:00
The same flag value must be passed to both `vmstorage` and `vmselect` nodes. Configuring `vmselect` node with `-downsampling.period`
command-line flag makes query results more consistent, because `vmselect` uses the maximum configured downsampling interval
on the requested time range if this time range covers multiple downsampling levels.
For example, if `-downsampling.period=30d:5m` and the query requests the last 60 days of data, then `vmselect`
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
downsamples all the [raw samples](https://docs.victoriametrics.com/keyconcepts/#raw-samples) on the requested time range
docs/Cluster-VictoriaMetrics.md: clarify the description on why -dosnwampling.period must be set at both vmstorage and vmselect This is a follow-up for ca7457d906cf20aa885e330afa67059a39d96e77
2023-10-31 15:53:44 +00:00
using 5 minute interval. If `-downsampling.period` command-line flag isn't set at `vmselect`,
docs: explain motivation behind having `-downsampling.period` on vmselect (#5205) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-10-30 14:29:35 +00:00
then query results can be less consistent because of mixing raw and downsampled data.
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
lib/storage: add ability to use downsampling for the given series filter (#733) * lib/storage: add ability to use downsampling for the given series filter Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: add information about downsampling filters Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix MetricsQL filter Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: treat missing downsampling filter as a bug Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/part_header: verify correctness of downsampling filters when opening partition Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: save only appliable rules in part metadata Filter and save only rules which are appliable to partition based on MinTimestamp of stored data. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage/downsampling: update log messages for final dedup Properly specify a reason of re-running deduplication for partition. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * lib/storage: consistently use MaxTimestamp to determine deduplication/downsampling rules Using MinTimestamp leads to applying downsampling to parts which are only partially covered by downsampling rule. For example, partition covers range [1000-2000]. At t=2100 and rule offset 500 data with t=2100-500 => 1600 must be downsampled. The range check against MinTimestamp evaluates to true even though partition contains range which must not be downsampled - [1600:2000]. Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * Follow-up - Apply the first matching downsampling period if multiple filters match the given time series. This allows fine-tuning the downsampling config for the specific needs. - Take into account downsampling filters during search queries. - Reduce the difference between community and enterprise branches. This should simplify further maintenance of these branches. - Properly parse series filters with colons inside them. - Document the feature at docs/CHANGELOG.md. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4960 --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2024-03-30 01:54:54 +00:00
See also [retention filters](#retention-filters).
docs: use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest instead of https://github.com/VictoriaMetrics/VictoriaMetrics/releases link where needed The https://github.com/VictoriaMetrics/VictoriaMetrics/releases link may show non-latest releases at the top, such as LTS releases or VictoriaLogs releases. So it is better to use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest link, which always redirect to the latest available release of VictoriaMetrics.
2023-10-18 18:06:23 +00:00
Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest).
docs: mention the free trial for enterprise Signed-off-by: Artem Navoiev <tenmozes@gmail.com> (cherry picked from commit 636d4ea1966fff070a365ed3735f06da0d38d9bf)
2023-10-08 18:11:55 +00:00
See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/).
docs/Cluster-VictoriaMetrics.md: mention that enterprise binaries are available for evaluation
2022-04-21 12:57:13 +00:00
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
## Profiling
All the cluster components provide the following handlers for [profiling](https://blog.golang.org/profiling-go-programs):
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- `http://vminsert:8480/debug/pprof/heap` for memory profile and `http://vminsert:8480/debug/pprof/profile` for CPU profile
- `http://vmselect:8481/debug/pprof/heap` for memory profile and `http://vmselect:8481/debug/pprof/profile` for CPU profile
- `http://vmstorage:8482/debug/pprof/heap` for memory profile and `http://vmstorage:8482/debug/pprof/profile` for CPU profile
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
docs: make profiling commands more copy-friendly (#2213) * docs: make profiling commands more copy-friendly The change adds `copy text` snippet to code examples and replaces hostname placeholders with `0.0.0.0`. Signed-off-by: hagen1778 <roman@victoriametrics.com> * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-18 10:23:36 +00:00
Example command for collecting cpu profile from `vmstorage` (replace `0.0.0.0` with `vmstorage` hostname if needed):
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
docs: follow-up after 491287ed1552798161c6e197fbf391770602d2b9 * port un-synced changed from docs/readme to readme * consistently use `sh` instead of `console` highlight, as it looks like a more appropriate syntax highlight * consistently use `sh` instead of `bash`, as it is shorter * consistently use `yaml` instead of `yml` See syntax codes here https://gohugo.io/content-management/syntax-highlighting/ Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-01-27 18:29:11 +00:00
```sh
docs: make profiling commands more copy-friendly (#2213) * docs: make profiling commands more copy-friendly The change adds `copy text` snippet to code examples and replaces hostname placeholders with `0.0.0.0`. Signed-off-by: hagen1778 <roman@victoriametrics.com> * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-18 10:23:36 +00:00
curl http://0.0.0.0:8482/debug/pprof/profile > cpu.pprof
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
```
docs: make profiling commands more copy-friendly (#2213) * docs: make profiling commands more copy-friendly The change adds `copy text` snippet to code examples and replaces hostname placeholders with `0.0.0.0`. Signed-off-by: hagen1778 <roman@victoriametrics.com> * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-18 10:23:36 +00:00
Example command for collecting memory profile from `vminsert` (replace `0.0.0.0` with `vminsert` hostname if needed):
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
docs: follow-up after 491287ed1552798161c6e197fbf391770602d2b9 * port un-synced changed from docs/readme to readme * consistently use `sh` instead of `console` highlight, as it looks like a more appropriate syntax highlight * consistently use `sh` instead of `bash`, as it is shorter * consistently use `yaml` instead of `yml` See syntax codes here https://gohugo.io/content-management/syntax-highlighting/ Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-01-27 18:29:11 +00:00
```sh
docs: make profiling commands more copy-friendly (#2213) * docs: make profiling commands more copy-friendly The change adds `copy text` snippet to code examples and replaces hostname placeholders with `0.0.0.0`. Signed-off-by: hagen1778 <roman@victoriametrics.com> * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-18 10:23:36 +00:00
curl http://0.0.0.0:8480/debug/pprof/heap > mem.pprof
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
```
docs: mention that it is safe sharing the collected profiles from security PoV The collected profiles do not contain sensitive information
2022-08-24 11:07:33 +00:00
It is safe sharing the collected profiles from security point of view, since they do not contain sensitive information.
docs/Cluster-VictoriaMetrics.md: add `Profiling` section
2020-12-15 22:59:44 +00:00
vmselect: allow proxying requests to vmalert (#2833) The change allows to proxy requests with prefix `/vmalert` to the vmalert component if `-vmalert.proxyURL` is set. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2825 and https://github.com/VictoriaMetrics/VictoriaMetrics/pull/2831 Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-07-06 08:47:51 +00:00
## vmalert
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
vmselect is capable of proxying requests to [vmalert](https://docs.victoriametrics.com/vmalert/)
vmselect: allow proxying requests to vmalert (#2833) The change allows to proxy requests with prefix `/vmalert` to the vmalert component if `-vmalert.proxyURL` is set. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2825 and https://github.com/VictoriaMetrics/VictoriaMetrics/pull/2831 Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-07-06 08:47:51 +00:00
when `-vmalert.proxyURL` flag is set. Use this feature for the following cases:
* for proxying requests from [Grafana Alerting UI](https://grafana.com/docs/grafana/latest/alerting/);
docs: fixes misspelled typos Also tried to make it catch "Authorisation" in the future, fixed a lot of other misspells along the way, but didn't make it catch "Authorisation" anyway. - Fix misspelled "Authorization" header name - Fix misspelled "organization" - Fix more misspells
2024-09-13 10:14:24 +00:00
* for accessing vmalert UI through vmselect Web interface.
vmselect: allow proxying requests to vmalert (#2833) The change allows to proxy requests with prefix `/vmalert` to the vmalert component if `-vmalert.proxyURL` is set. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2825 and https://github.com/VictoriaMetrics/VictoriaMetrics/pull/2831 Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-07-06 08:47:51 +00:00
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
For accessing vmalerts UI through vmselect configure `-vmalert.proxyURL` flag and visit
docs: fix the recommended url for -vmalert.proxyURL accroding to 8667307d7349a245608992eea513ee55dbfd45a5
2022-08-04 14:56:07 +00:00
`http://<vmselect>:8481/select/<accountID>/prometheus/vmalert/` link.
vmselect: allow proxying requests to vmalert (#2833) The change allows to proxy requests with prefix `/vmalert` to the vmalert component if `-vmalert.proxyURL` is set. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2825 and https://github.com/VictoriaMetrics/VictoriaMetrics/pull/2831 Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-07-06 08:47:51 +00:00
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
## Community and contributions
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Feel free asking any questions regarding VictoriaMetrics:
docs: mention slack inviter and slack channel (#5817) Signed-off-by: Artem Navoiev <tenmozes@gmail.com> (cherry picked from commit 5b652bccadda84212fb6686f55c128901ba36fd5)
2024-02-19 16:18:31 +00:00
* [Slack Inviter](https://slack.victoriametrics.com/) and [Slack channel](https://victoriametrics.slack.com/)
docs: consistently update twitter.com to x.com See https://github.com/VictoriaMetrics/VictoriaMetrics/pull/7383 Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit cfba770c8ed413b167576d4e4c89df732d146f07)
2024-10-30 11:44:50 +00:00
* [X (Twitter)](https://x.com/VictoriaMetrics/)
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
* [Linkedin](https://www.linkedin.com/company/victoriametrics/)
* [Reddit](https://www.reddit.com/r/VictoriaMetrics/)
docs: update -help output after recent changes to VictoriaMetrics components
2023-11-02 19:23:32 +00:00
* [Telegram-en](https://t.me/VictoriaMetrics_en)
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
* [Telegram-ru](https://t.me/VictoriaMetrics_ru1)
* [Mastodon](https://mastodon.social/@victoriametrics/)
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
If you like VictoriaMetrics and want contributing, then please read [these docs](https://docs.victoriametrics.com/contributing/).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
## Reporting bugs
Report bugs and propose new features [here](https://github.com/VictoriaMetrics/VictoriaMetrics/issues).
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
## List of command-line flags
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
- [List of command-line flags for vminsert](#list-of-command-line-flags-for-vminsert)
- [List of command-line flags for vmselect](#list-of-command-line-flags-for-vmselect)
- [List of command-line flags for vmstorage](#list-of-command-line-flags-for-vmstorage)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
### List of command-line flags for vminsert
Below is the output for `/path/to/vminsert -help`:
docs: updated cmd flags highlight style (#7312) ### Describe Your Changes Changed highlight style for cmd flags ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/).
2024-10-22 10:00:07 +00:00
```shellhelp
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
-blockcache.missesBeforeCaching int
The number of cache misses before putting the block into cache. Higher values may reduce indexdb/dataBlocks cache size at the cost of higher CPU and disk read usage (default 2)
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
-cacheExpireDuration duration
Items are removed from in-memory caches after they aren't accessed for this duration. Lower values may reduce memory usage at the cost of higher CPU usage. See also -prevCacheRemovalPercent (default 30m0s)
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tls
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to use TLS for connections to -storageNode. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsCAFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to TLS CA file to use for verifying certificates provided by -storageNode if -cluster.tls flag is set. By default system CA is used. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsCertFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to client-side TLS certificate file to use when connecting to -storageNode if -cluster.tls flag is set. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
all: add -cluster.tlsInsecureSkipVerify command-line option to vminsert, vmselect and vmstorage components in order to be able to disable TLS certificate verification in mTLS mode See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2490
2022-05-03 10:08:01 +00:00
-cluster.tlsInsecureSkipVerify
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to skip verification of TLS certificates provided by -storageNode nodes if -cluster.tls flag is set. Note that disabled TLS certificate verification breaks security. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsKeyFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to client-side TLS key file to use when connecting to -storageNode if -cluster.tls flag is set. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
vmcluster: re-routing enhancement (#5293) * app/vmstorage: close vminsert connections gradually before stopping storage Implements graceful shutdown approach suggested here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1768146878 Test results for this can be found here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1790640274 Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * app/vmstorage: update graceful shutdown logic - close connections from vminsert in determenistic order - update flag description - lower default timeout to 25 seconds. 25 seconds value was chosen because the lowest default value used in default configuration deployments is 30s(default value in Kubernetes and ansible-playbooks). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add information about re-routing enhancement during restart Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/changelog: add entry for new command-line flag Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * {app/vmstorage,lib/ingestserver}: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add note to update workload scheduler timeout Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * wip --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-14 00:00:42 +00:00
-clusternative.vminsertConnsShutdownDuration duration
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The time needed for gradual closing of upstream vminsert connections during graceful shutdown. Bigger duration reduces spikes in CPU, RAM and disk IO load on the remaining lower-level clusters during rolling restart. Smaller duration reduces the time needed to close all the upstream vminsert connections, thus reducing the time for graceful shutdown. See https://docs.victoriametrics.com/cluster-victoriametrics/#improving-re-routing-performance-during-restart (default 25s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-clusternativeListenAddr string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
TCP address to listen for data from other vminsert nodes in multi-level cluster setup. See https://docs.victoriametrics.com/cluster-victoriametrics/#multi-level-cluster-setup . Usually :8400 should be set to match default vmstorage port for vminsert. Disabled work if empty
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-csvTrimTimestamp duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Trim timestamps when importing csv data to this duration. Minimum practical duration is 1ms. Higher duration (i.e. 1s) may be used for reducing disk space usage for timestamp data (default 1ms)
app/vminsert: document that -relabelConfig is reloaded on SIGHUP signal
2021-09-29 18:17:25 +00:00
-datadog.maxInsertRequestSize size
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
The maximum size in bytes of a single DataDog POST request to /datadog/api/v2/series
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864)
lib/protoparser/datadog: sanitize metric names by default in the same way as DataDog does This commit is based on the pull request https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3105 Thanks to @PerGon for the idea and initial implementation.
2022-09-26 10:57:20 +00:00
-datadog.sanitizeMetricName
Sanitize metric names for the ingested DataDog data to comply with DataDog behaviour described at https://docs.datadoghq.com/metrics/custom_metrics/#naming-custom-metrics (default true)
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
-denyQueryTracing
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to disable the ability to trace queries. See https://docs.victoriametrics.com/#query-tracing
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-disableRerouting
docs/Cluster-VictoriaMetrics.md: document -disableReroutingOnUnavailable command-line flag This is a follow-up for 88f0d1572e1f801f551485559e22753916b77416 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5713
2024-02-05 13:17:03 +00:00
Whether to disable re-routing when some of vmstorage nodes accept incoming data at slower speed compared to other storage nodes. Disabled re-routing limits the ingestion rate by the slowest vmstorage node. On the other side, disabled re-routing minimizes the number of active time series in the cluster during rolling restarts and during spikes in series churn rate. See also -disableReroutingOnUnavailable and -dropSamplesOnOverload (default true)
-disableReroutingOnUnavailable
Whether to disable re-routing when some of vmstorage nodes are unavailable. Disabled re-routing stops ingestion when some storage nodes are unavailable. On the other side, disabled re-routing minimizes the number of active time series in the cluster during rolling restarts and during spikes in series churn rate. See also -disableRerouting
app/vminsert: add `-dropSamplesOnOverload` command-line flag Drop incoming samples if the destination vmstorage node is unavailable and/or accepts data at slower rate than other vmstorage nodes
2022-02-06 18:21:40 +00:00
-dropSamplesOnOverload
app/vminsert: adds note for dropSamplesOnOverload flag (#4797) Adds note for dropSamplesOnOverload flag that are samples dropped before replication
2023-08-10 10:18:29 +00:00
Whether to drop incoming samples if the destination vmstorage node is overloaded and/or unavailable. This prioritizes cluster availability over consistency, e.g. the cluster continues accepting all the ingested samples, but some of them may be dropped if vmstorage nodes are temporarily unavailable and/or overloaded. The drop of samples happens before the replication, so it's not recommended to use this flag with -replicationFactor enabled.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-enableTCP6
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP are used
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-envflag.enable
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to enable reading flags from environment variables in addition to the command line. Command line flag values have priority over values from environment vars. Flags are read only from the command line if this flag isn't set. See https://docs.victoriametrics.com/#environment-variables for more details
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-envflag.prefix string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Prefix for environment variables if -envflag.enable is set
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
-eula
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Deprecated, please use -license or -licenseFile flags instead. By specifying this flag, you confirm that you have an enterprise license and accept the ESA https://victoriametrics.com/legal/esa/ . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
-filestream.disableFadvise
Whether to disable fadvise() syscall when reading large data files. The fadvise() syscall prevents from eviction of recently accessed data from OS page cache during background merges and backups. In some rare cases it is better to disable the syscall if it uses too much CPU
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-flagsAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -flagsAuthKey=file:///abs/path/to/file or -flagsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -flagsAuthKey=http://host/path or -flagsAuthKey=https://host/path
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-fs.disableMmap
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
Whether to use pread() instead of mmap() for reading data files. By default, mmap() is used for 64-bit arches and pread() is used for 32-bit arches, since they cannot read data files bigger than 2^32 bytes in memory. mmap() is usually faster for reading small data chunks than pread()
docs: mention `graphite.sanitizeMetricName` in cluster docs Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit ffb49c677b6f49e470e057468d4be8d304888f3b)
2024-07-02 15:17:54 +00:00
-graphite.sanitizeMetricName
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Sanitize metric names for the ingested Graphite data. See https://docs.victoriametrics.com/#how-to-send-data-from-graphite-compatible-agents-such-as-statsd
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-graphiteListenAddr string
docs/Cluster-VictoriaMetrics.md: update command-line descriptions after ebebaecd94dc763a0c163c398a4b999624098d3d
2023-01-27 08:04:14 +00:00
TCP and UDP address to listen for Graphite plaintext data. Usually :2003 must be set. Doesn't work if empty. See also -graphiteListenAddr.useProxyProtocol
-graphiteListenAddr.useProxyProtocol
Whether to use proxy protocol for connections accepted at -graphiteListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-graphiteTrimTimestamp duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Trim timestamps for Graphite data to this duration. Minimum practical duration is 1s. Higher duration (i.e. 1m) may be used for reducing disk space usage for timestamp data (default 1s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.connTimeout duration
lib/httpserver: return back the default value for -http.connTimeout to 2 minutes It has been appeared that there are VictoriaMetrics users, who rely on the fact that VictoriaMetrics components were closing incoming connections to -httpListenAddr every 2 minutes by default. So let's return back this value by default in order to fix the breaking change made at d8c1db7953d2265c9cd3a2913f12aac07a99a45c . See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1304#issuecomment-1961891450 .
2024-02-23 20:00:55 +00:00
Incoming connections to -httpListenAddr are closed after the configured timeout. This may help evenly spreading load among a cluster of services behind TCP-level load balancer. Zero value disables closing of incoming connections (default 2m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.disableResponseCompression
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
Disable compression of HTTP responses to save CPU resources. By default, compression is enabled to save network bandwidth
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
-http.header.csp string
Value for 'Content-Security-Policy' header, recommended: "default-src 'self'"
lib/httpserver: add flags to specify HSTS / Frame-Options / CSP headers for httpserver (#5111) support `Strict-Transport-Security`, `Content-Security-Policy` and `X-Frame-Options` HTTP headers in all VictoriaMetrics components. The values for headers can be specified by users via the following flags: `-http.header.hsts`, `-http.header.csp` and `-http.header.frameOptions`. Co-authored-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit ad839aa492704dda3a9f8e5fe9de58c4074bd39a) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-10-30 10:33:38 +00:00
-http.header.frameOptions string
Value for 'X-Frame-Options' header
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
-http.header.hsts string
Value for 'Strict-Transport-Security' header, recommended: 'max-age=31536000; includeSubDomains'
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.idleConnTimeout duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Timeout for incoming idle http connections (default 1m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.maxGracefulShutdownDuration duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum duration for a graceful shutdown of the HTTP server. A highly loaded server may require increased value for a graceful shutdown (default 7s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.pathPrefix string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
An optional prefix to add to all the paths handled by http server. For example, if '-http.pathPrefix=/foo/bar' is set, then all the http requests will be handled on '/foo/bar/*' paths. This may be useful for proxied requests. See https://www.robustperception.io/using-external-urls-and-proxies-with-prometheus
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.shutdownDelay duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Optional delay before http server shutdown. During this delay, the server returns non-OK responses from /health page, so load balancers can route new requests to other servers
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-httpAuth.password value
docs: make `httpAuth.*` flags description less ambiguous (#4588) * docs: make `httpAuth.*` flags description less ambiguous Currently, it may confuse users whether `httpAuth.*` flags are used by HTTP client or server configuration(see https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4586 for example). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix a typo Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-07 11:50:13 +00:00
Password for HTTP server's Basic Auth. The authentication is disabled if -httpAuth.username is empty
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -httpAuth.password=file:///abs/path/to/file or -httpAuth.password=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -httpAuth.password=http://host/path or -httpAuth.password=https://host/path
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
-httpAuth.username string
docs: make `httpAuth.*` flags description less ambiguous (#4588) * docs: make `httpAuth.*` flags description less ambiguous Currently, it may confuse users whether `httpAuth.*` flags are used by HTTP client or server configuration(see https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4586 for example). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix a typo Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-07 11:50:13 +00:00
Username for HTTP server's Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-httpListenAddr array
Address to listen for incoming http requests. See also -httpListenAddr.useProxyProtocol
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
-httpListenAddr.useProxyProtocol array
Whether to use proxy protocol for connections accepted at the given -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt . With enabled proxy protocol http server cannot serve regular /metrics endpoint. Use -pushmetrics.url for metrics pushing
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-import.maxLineLen size
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum length in bytes of a single line accepted by /api/v1/import; the line length can be limited with 'max_rows_per_line' query arg passed to /api/v1/export
lib/protoparser: decrease `import.maxLineLen` from 100MB to 10MB (#5364) Tests showed that importing a single line with 70MB size takes 5.3GiB RSS memory for VictoriaMetrics single-node. In the scenario when user exports and imports data from one VM to another, it could possibly lead to OOM exception for destination VM. Importing a single line with 16MB size taks 1.3GiB RSS memory. Hence, the limit for `import.maxLineLen` was decreased from 100MB to 10MB to improve reliability of VictoriaMetrics during imports. Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-24 10:53:04 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 10485760)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-influx.databaseNames array
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Comma-separated list of database names to return from /query and /influx/query API. This can be needed for accepting data from Telegraf plugins such as https://github.com/fangli/fluent-plugin-influxdb
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-influx.maxLineSize size
lib/protoparser/influx: enable batch processing by default (#7165) ### Describe Your Changes Fixes https://github.com/VictoriaMetrics/VictoriaMetrics/issues/7090 ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit daa7183749f6ec4d386f652d2fcb224d83989963) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-15 09:48:40 +00:00
The maximum size in bytes for a single InfluxDB line during parsing. Applicable for stream mode only. See https://docs.victoriametrics.com/#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 262144)
lib/protoparser/influx: enable batch processing by default (#7165) ### Describe Your Changes Fixes https://github.com/VictoriaMetrics/VictoriaMetrics/issues/7090 ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit daa7183749f6ec4d386f652d2fcb224d83989963) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-15 09:48:40 +00:00
-influx.maxRequestSize size
The maximum size in bytes of a single InfluxDB request. Applicable for batch mode only. See https://docs.victoriametrics.com/#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864)
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-influxDBLabel string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Default label for the DB name sent over '?db={db_name}' query parameter (default "db")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-influxListenAddr string
docs/Cluster-VictoriaMetrics.md: update command-line descriptions after ebebaecd94dc763a0c163c398a4b999624098d3d
2023-01-27 08:04:14 +00:00
TCP and UDP address to listen for InfluxDB line protocol data. Usually :8089 must be set. Doesn't work if empty. This flag isn't needed when ingesting data over HTTP - just send it to http://<victoriametrics>:8428/write . See also -influxListenAddr.useProxyProtocol
-influxListenAddr.useProxyProtocol
Whether to use proxy protocol for connections accepted at -influxListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-influxMeasurementFieldSeparator string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Separator for '{measurement}{separator}{field_name}' metric name when inserted via InfluxDB line protocol (default "_")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-influxSkipMeasurement
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Uses '{field_name}' as a metric name while ignoring '{measurement}' and '-influxMeasurementFieldSeparator'
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-influxSkipSingleField
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
Uses '{measurement}' instead of '{measurement}{separator}{field_name}' for metric name if InfluxDB line contains only a single field
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-influxTrimTimestamp duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Trim timestamps for InfluxDB line protocol data to this duration. Minimum practical duration is 1ms. Higher duration (i.e. 1s) may be used for reducing disk space usage for timestamp data (default 1ms)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-insert.maxQueueDuration duration
all: small improvements in error messages and command-line flag descriptions related to concurrency limiters
2023-01-07 08:11:44 +00:00
The maximum duration to wait in the queue when -maxConcurrentInserts concurrent insert requests are executed (default 1m0s)
lib/bytesutil: add `-internStringDisableCache` and `-internStringCacheExpireDuration` command-line flags This commit is based on https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3872
2023-02-27 22:15:49 +00:00
-internStringCacheExpireDuration duration
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
The expiry duration for caches for interned strings. See https://en.wikipedia.org/wiki/String_interning . See also -internStringMaxLen and -internStringDisableCache (default 6m0s)
lib/bytesutil: add `-internStringDisableCache` and `-internStringCacheExpireDuration` command-line flags This commit is based on https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3872
2023-02-27 22:15:49 +00:00
-internStringDisableCache
Whether to disable caches for interned strings. This may reduce memory usage at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringCacheExpireDuration and -internStringMaxLen
docs/Cluster-VictoriaMetrics.md: update command-line descriptions after ebebaecd94dc763a0c163c398a4b999624098d3d
2023-01-27 08:04:14 +00:00
-internStringMaxLen int
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
The maximum length for strings to intern. A lower limit may save memory at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringDisableCache and -internStringCacheExpireDuration (default 500)
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-license string
docs: fix docs/ and README.md spelling errors (#6362) Fixes `docs/` and `README.md` typos and errors. Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com> (cherry picked from commit c740a8042efeacc75b1ca967ed52df5e1a4dbbaa) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-03 08:04:13 +00:00
License key for VictoriaMetrics Enterprise. See https://victoriametrics.com/products/enterprise/ . Trial Enterprise license can be obtained from https://victoriametrics.com/products/enterprise/trial/ . This flag is available only in Enterprise binaries. The license key can be also passed via file specified by -licenseFile command-line flag
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-license.forceOffline
docs: fix docs/ and README.md spelling errors (#6362) Fixes `docs/` and `README.md` typos and errors. Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com> (cherry picked from commit c740a8042efeacc75b1ca967ed52df5e1a4dbbaa) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-03 08:04:13 +00:00
Whether to enable offline verification for VictoriaMetrics Enterprise license key, which has been passed either via -license or via -licenseFile command-line flag. The issued license key must support offline verification feature. Contact info@victoriametrics.com if you need offline license verification. This flag is available only in Enterprise binaries
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-licenseFile string
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Path to file with license key for VictoriaMetrics Enterprise. See https://victoriametrics.com/products/enterprise/ . Trial Enterprise license can be obtained from https://victoriametrics.com/products/enterprise/trial/ . This flag is available only in Enterprise binaries. The license key can be also passed inline via -license command-line flag
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerDisableTimestamps
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Whether to disable writing timestamps in logs
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerErrorsPerSecondLimit int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerFormat string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Format for logs. Possible values: default, json (default "default")
docs: update `-help` outputs for vm* tools
2023-01-04 06:40:00 +00:00
-loggerJSONFields string
Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerLevel string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO")
vmcluster: re-routing enhancement (#5293) * app/vmstorage: close vminsert connections gradually before stopping storage Implements graceful shutdown approach suggested here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1768146878 Test results for this can be found here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1790640274 Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * app/vmstorage: update graceful shutdown logic - close connections from vminsert in determenistic order - update flag description - lower default timeout to 25 seconds. 25 seconds value was chosen because the lowest default value used in default configuration deployments is 30s(default value in Kubernetes and ansible-playbooks). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add information about re-routing enhancement during restart Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/changelog: add entry for new command-line flag Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * {app/vmstorage,lib/ingestserver}: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add note to update workload scheduler timeout Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * wip --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-14 00:00:42 +00:00
-loggerMaxArgLen int
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
The maximum length of a single logged argument. Longer arguments are replaced with 'arg_start..arg_end', where 'arg_start' and 'arg_end' is prefix and suffix of the arg with the length not exceeding -loggerMaxArgLen / 2 (default 1000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerOutput string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Output for the logs. Supported values: stderr, stdout (default "stderr")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerTimezone string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Timezone to use for timestamps in logs. Timezone must be a valid IANA Time Zone. For example: America/New_York, Europe/Berlin, Etc/GMT+3 or Local (default "UTC")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerWarnsPerSecondLimit int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Per-second limit on the number of WARN messages. If more than the given number of warns are emitted per second, then the remaining warns are suppressed. Zero values disable the rate limit
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-maxConcurrentInserts int
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
The maximum number of concurrent insert requests. Set higher value when clients send data over slow networks. Default value depends on the number of available CPU cores. It should work fine in most cases since it minimizes resource usage. See also -insert.maxQueueDuration (default 32)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-maxInsertRequestSize size
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum size in bytes of a single Prometheus remote_write API request
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 33554432)
app/vminsert: add `-maxLabelValueLen` command-line flag See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1908
2021-12-06 09:39:19 +00:00
-maxLabelValueLen int
app/vminsert: increase default value for -maxLabelValueLen command-line flag from 1KiB to 4KiB It has been appeared that the standard Kubernetes monitoring can generate labels with sizes up to 4KiB This is a follow-up for a5d101304207590fe1669f73dd11f388a6f25153 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6176
2024-07-15 21:22:54 +00:00
The maximum length of label values in the accepted time series. Longer label values are truncated. In this case the vm_too_long_label_values_total metric at /metrics page is incremented (default 4096)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-maxLabelsPerTimeseries int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum number of labels accepted per time series. Superfluous labels are dropped. In this case the vm_metrics_with_dropped_labels_total metric at /metrics page is incremented (default 30)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-memory.allowedBytes size
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Allowed size of system memory VictoriaMetrics caches may occupy. This option overrides -memory.allowedPercent if set to a non-zero value. Too low a value may increase the cache miss rate usually resulting in higher CPU and disk IO usage. Too high a value may evict too much data from the OS page cache resulting in higher disk IO usage
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-memory.allowedPercent float
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Allowed percent of system memory VictoriaMetrics caches may occupy. See also -memory.allowedBytes. Too low a value may increase cache miss rate usually resulting in higher CPU and disk IO usage. Too high a value may evict too much data from the OS page cache which will result in higher disk IO usage (default 60)
all: add -metrics.exposeMetadata command-line flag, which can be used for adding TYPE and HELP metadata for metrics exposed at /metrics page This may be needed for systems, which require this metadata such as Google Cloud Managed Prometheus. See https://cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting#missing-metric-type
2023-12-19 01:19:42 +00:00
-metrics.exposeMetadata
Whether to expose TYPE and HELP metadata at the /metrics page, which is exposed at -httpListenAddr . The metadata may be needed when the /metrics page is consumed by systems, which require this information. For example, Managed Prometheus in Google Cloud - https://cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting#missing-metric-type
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-metricsAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -metricsAuthKey=file:///abs/path/to/file or -metricsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -metricsAuthKey=http://host/path or -metricsAuthKey=https://host/path
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-mtls array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to require valid client certificate for https requests to the corresponding -httpListenAddr . This flag works only if -tls flag is set. See also -mtlsCAFile . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
-mtlsCAFile array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional path to TLS Root CA for verifying client certificates at the corresponding -httpListenAddr when -mtls is enabled. By default the host system TLS Root CA is used for client certificate verification. This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
-newrelic.maxInsertRequestSize size
docs: update -help output after recent changes to VictoriaMetrics components
2023-11-02 19:23:32 +00:00
The maximum size in bytes of a single NewRelic request to /newrelic/infra/v2/metrics/events/bulk
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864)
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-opentelemetry.usePrometheusNaming
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to convert metric names and labels into Prometheus-compatible format for the metrics ingested via OpenTelemetry protocol; see https://docs.victoriametrics.com/#sending-data-via-opentelemetry
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-opentsdbHTTPListenAddr string
docs: fix typo OpentTSDB -> OpenTSDB (#3854) Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-02-22 10:24:26 +00:00
TCP address to listen for OpenTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty. See also -opentsdbHTTPListenAddr.useProxyProtocol
docs/Cluster-VictoriaMetrics.md: update command-line descriptions after ebebaecd94dc763a0c163c398a4b999624098d3d
2023-01-27 08:04:14 +00:00
-opentsdbHTTPListenAddr.useProxyProtocol
Whether to use proxy protocol for connections accepted at -opentsdbHTTPListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-opentsdbListenAddr string
docs: fix typo OpentTSDB -> OpenTSDB (#3854) Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-02-22 10:24:26 +00:00
TCP and UDP address to listen for OpenTSDB metrics. Telnet put messages and HTTP /api/put messages are simultaneously served on TCP port. Usually :4242 must be set. Doesn't work if empty. See also -opentsdbListenAddr.useProxyProtocol
docs/Cluster-VictoriaMetrics.md: update command-line descriptions after ebebaecd94dc763a0c163c398a4b999624098d3d
2023-01-27 08:04:14 +00:00
-opentsdbListenAddr.useProxyProtocol
Whether to use proxy protocol for connections accepted at -opentsdbListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-opentsdbTrimTimestamp duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Trim timestamps for OpenTSDB 'telnet put' data to this duration. Minimum practical duration is 1s. Higher duration (i.e. 1m) may be used for reducing disk space usage for timestamp data (default 1s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-opentsdbhttp.maxInsertRequestSize size
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum size of OpenTSDB HTTP put request
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 33554432)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-opentsdbhttpTrimTimestamp duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Trim timestamps for OpenTSDB HTTP data to this duration. Minimum practical duration is 1ms. Higher duration (i.e. 1s) may be used for reducing disk space usage for timestamp data (default 1ms)
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-pprofAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -pprofAuthKey=file:///abs/path/to/file or -pprofAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -pprofAuthKey=http://host/path or -pprofAuthKey=https://host/path
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
-prevCacheRemovalPercent float
Items in the previous caches are removed when the percent of requests it serves becomes lower than this value. Higher values reduce memory usage at the cost of higher CPU usage. See also -cacheExpireDuration (default 0.1)
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
-pushmetrics.disableCompression
Whether to disable request body compression when pushing metrics to every -pushmetrics.url
all: rename -pushmetrics.extraLabels to -pushmetrics.extraLabel for the sake of consistency
2022-07-26 16:24:24 +00:00
-pushmetrics.extraLabel array
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
Optional labels to add to metrics pushed to every -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to every -pushmetrics.url
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
-pushmetrics.header array
Optional HTTP request header to send to every -pushmetrics.url . For example, -pushmetrics.header='Authorization: Basic foobar' adds 'Authorization: Basic foobar' header to every request to every -pushmetrics.url
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
-pushmetrics.interval duration
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
Interval for pushing metrics to every -pushmetrics.url (default 10s)
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
-pushmetrics.url array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional URL to push metrics exposed at /metrics page. See https://docs.victoriametrics.com/#push-metrics . By default, metrics exposed at /metrics page aren't pushed to any remote storage
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-relabelConfig string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional path to a file with relabeling rules, which are applied to all the ingested metrics. The path can point either to local file or to http url. See https://docs.victoriametrics.com/#relabeling for details. The config is reloaded on SIGHUP signal
follow-up docs update after 77f22fdb8d31d30dab76ec00afa06d2823d462c4 (#6454) Signed-off-by: f41gh7 <nik@victoriametrics.com> (cherry picked from commit 33d07e915fcf2e4073f9a3805976fbb184195e86)
2024-06-11 09:27:53 +00:00
-relabelConfigCheckInterval duration
Interval for checking for changes in '-relabelConfig' file. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-replicationFactor int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Replication factor for the ingested data, i.e. how many copies to make among distinct -storageNode instances. Note that vmselect must run with -dedup.minScrapeInterval=1ms for data de-duplication when replicationFactor is greater than 1. Higher values for -dedup.minScrapeInterval at vmselect is OK (default 1)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-rpc.disableCompression
docs/Cluster-VictoriaMetrics.md: make the description for `-rpc.disableCompression` command-line flag more clear
2022-05-06 13:24:45 +00:00
Whether to disable compression for the data sent from vminsert to vmstorage. This reduces CPU usage at the cost of higher network bandwidth usage
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-sortLabels
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Whether to sort labels for incoming samples before writing them to storage. This may be needed for reducing memory usage at storage when the order of labels in incoming samples is random. For example, if m{k1="v1",k2="v2"} may be sent as m{k2="v2",k1="v1"}. Enabled sorting for labels can slow down ingestion performance a bit
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-storageNode array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Comma-separated addresses of vmstorage nodes; usage: -storageNode=vmstorage-host1,...,vmstorage-hostN . Enterprise version of VictoriaMetrics supports automatic discovery of vmstorage addresses via DNS SRV records. For example, -storageNode=srv+vmstorage.addrs . See https://docs.victoriametrics.com/cluster-victoriametrics/#automatic-vmstorage-discovery
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: document the addition of `-storageNode.discoveryInterval` command-line flag
2022-12-07 03:57:46 +00:00
-storageNode.discoveryInterval duration
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Interval for refreshing -storageNode list behind DNS SRV records. The minimum supported interval is 1s. See https://docs.victoriametrics.com/cluster-victoriametrics/#automatic-vmstorage-discovery . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/ (default 2s)
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
-storageNode.filter string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
An optional regexp filter for discovered -storageNode addresses according to https://docs.victoriametrics.com/cluster-victoriametrics/#automatic-vmstorage-discovery. Discovered addresses matching the filter are retained, while other addresses are ignored. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tls array
Whether to enable TLS for incoming HTTP requests at the given -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set. See also -mtls
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertCacheDir string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Directory to store TLS certificates issued via Let's Encrypt. Certificates are lost on restarts if this flag isn't set. This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertEmail string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Contact email for the issued Let's Encrypt TLS certificates. See also -tlsAutocertHosts and -tlsAutocertCacheDir .This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertHosts array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional hostnames for automatic issuing of Let's Encrypt TLS certificates. These hostnames must be reachable at -httpListenAddr . The -httpListenAddr must listen tcp port 443 . The -tlsAutocertHosts overrides -tlsCertFile and -tlsKeyFile . See also -tlsAutocertEmail and -tlsAutocertCacheDir . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tlsCertFile array
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Path to file with TLS certificate for the corresponding -httpListenAddr if -tls is set. Prefer ECDSA certs instead of RSA certs as RSA certs are slower. The provided certificate file is automatically re-read every second, so it can be dynamically updated. See also -tlsAutocertHosts
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: update docs after 26ae50ec26f692f39836028d88d2495b98753fe6
2022-04-16 13:04:21 +00:00
-tlsCipherSuites array
docs/Cluster-VictoriaMetrics.md: sync docs
2022-04-16 13:58:34 +00:00
Optional list of TLS cipher suites for incoming requests over HTTPS if -tls is set. See the list of supported cipher suites at https://pkg.go.dev/crypto/tls#pkg-constants
docs/Cluster-VictoriaMetrics.md: update docs after 26ae50ec26f692f39836028d88d2495b98753fe6
2022-04-16 13:04:21 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tlsKeyFile array
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Path to file with TLS key for the corresponding -httpListenAddr if -tls is set. The provided key file is automatically re-read every second, so it can be dynamically updated. See also -tlsAutocertHosts
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
-tlsMinVersion array
Optional minimum TLS version to use for the corresponding -httpListenAddr if -tls is set. Supported values: TLS10, TLS11, TLS12, TLS13
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
app/{vmagent,vminsert}: add `-usePromCompatibleNaming` command-line flag for normalizing metric names and label names in the ingested samples Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3113 Thanks to @erkexzcx for the idea and the initial pull request at https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3146
2022-09-26 10:11:37 +00:00
-usePromCompatibleNaming
Whether to replace characters unsupported by Prometheus with underscores in the ingested metric names and label names. For example, foo.bar{a.b='c'} is transformed into foo_bar{a_b='c'} during data ingestion if this flag is set. See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-version
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Show VictoriaMetrics version
docs: update docs after e4d6b750f6967386425738d1fd754047c2ec617e Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2753
2022-06-21 10:58:04 +00:00
-vmstorageDialTimeout duration
app/{vminsert,vmselect}: follow-up after 2b7b3293c1119cc993143c34f0945504cdb35575 - Document the change at docs/CHANGELOG.md - Set the default value for -vmstorageUserTimeout to 3 seconds. This is much better than the 0 value, which means that TCP connection to unreachable vmstorage could block for up to 16 minutes. - Document -vmstorageUserTimeout at docs/Cluster-VictoriaMetrics.md
2023-08-29 10:09:24 +00:00
Timeout for establishing RPC connections from vminsert to vmstorage. See also -vmstorageUserTimeout (default 3s)
-vmstorageUserTimeout duration
Network timeout for RPC connections from vminsert to vmstorage (Linux only). Lower values speed up re-rerouting recovery when some of vmstorage nodes become unavailable because of networking issues. Read more about TCP_USER_TIMEOUT at https://blog.cloudflare.com/when-tcp-sockets-refuse-to-die/ . See also -vmstorageDialTimeout (default 3s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
```
### List of command-line flags for vmselect
Below is the output for `/path/to/vmselect -help`:
```
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
-blockcache.missesBeforeCaching int
The number of cache misses before putting the block into cache. Higher values may reduce indexdb/dataBlocks cache size at the cost of higher CPU and disk read usage (default 2)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-cacheDataPath string
docs: add more details to -cacheDataPath vmselect flag (#6708) vmselect will create `./tmp` dir under `cacheDataPath`. If `cacheDataPath` is set to `/`, vmselect will use `/tmp`. content under `/tmp` dir might be auto removed based on the OS behaviour. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5770 - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: hagen1778 <roman@victoriametrics.com>
2024-08-13 13:17:43 +00:00
Path to directory for cache files and temporary query results. By default, the cache won't be persisted, and temporary query results will be placed under /tmp/searchResults. If set, the cache will be persisted under cacheDataPath/rollupResult, and temporary query results will be placed under cacheDataPath/tmp/searchResults.
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
-cacheExpireDuration duration
Items are removed from in-memory caches after they aren't accessed for this duration. Lower values may reduce memory usage at the cost of higher CPU usage. See also -prevCacheRemovalPercent (default 30m0s)
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tls
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to use TLS for connections to -storageNode. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsCAFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to TLS CA file to use for verifying certificates provided by -storageNode if -cluster.tls flag is set. By default system CA is used. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsCertFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to client-side TLS certificate file to use when connecting to -storageNode if -cluster.tls flag is set. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
all: add -cluster.tlsInsecureSkipVerify command-line option to vminsert, vmselect and vmstorage components in order to be able to disable TLS certificate verification in mTLS mode See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2490
2022-05-03 10:08:01 +00:00
-cluster.tlsInsecureSkipVerify
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to skip verification of TLS certificates provided by -storageNode nodes if -cluster.tls flag is set. Note that disabled TLS certificate verification breaks security. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsKeyFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to client-side TLS key file to use when connecting to -storageNode if -cluster.tls flag is set. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-clusternative.disableCompression
app/{vmselect,vmstorage}: return compression of the data passed from vmstorage to vmselect This reverts cd4f641d323cf0977c2e22915eb75edb765ad090 , since it has been appeared that the disabled compression for vmstorage->vmselect data increase network bandwidth usage by more than 10x on typical production workloads, while it decreases CPU usage at vmstorage by up to 10% and improves query latency by up to 10%. The 10x increase in network usage is too high price for 10% improvements on query latency and vmstorage CPU usage. This may result in network bandwidth bottlenecks, which can reduce the overall performance and stability of VictoriaMetrics cluster. That's why return back the vmstorage->vmselect data compression by default. The vmstorage->vmselect compression can be disabled by passing -rpc.disableCompression command-line flag to vmstorage. The vmselect->vmselect compression in multi-level cluster setup can be disabled by passing -clusternative.disableCompression command-line flag.
2024-01-24 11:32:13 +00:00
Whether to disable compression of the data sent to vmselect via -clusternativeListenAddr. This reduces CPU usage at the cost of higher network bandwidth usage
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
-clusternative.maxConcurrentRequests int
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
The maximum number of concurrent vmselect requests the server can process at -clusternativeListenAddr. It shouldn't be high, since a single request usually saturates a CPU core at the underlying vmstorage nodes, and many concurrently executed requests may require high amounts of memory. See also -clusternative.maxQueueDuration (default 32)
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
-clusternative.maxQueueDuration duration
The maximum time the incoming query to -clusternativeListenAddr waits for execution when -clusternative.maxConcurrentRequests limit is reached (default 10s)
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-clusternative.maxTagKeys int
The maximum number of tag keys returned per search at -clusternativeListenAddr (default 100000)
-clusternative.maxTagValueSuffixesPerSearch int
The maximum number of tag value suffixes returned from /metrics/find at -clusternativeListenAddr (default 100000)
-clusternative.maxTagValues int
The maximum number of tag values returned per search at -clusternativeListenAddr (default 100000)
-clusternative.tls
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to use TLS when accepting connections at -clusternativeListenAddr. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-clusternative.tlsCAFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to TLS CA file to use for verifying certificates provided by vmselect, which connects at -clusternativeListenAddr if -clusternative.tls flag is set. By default system CA is used. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-clusternative.tlsCertFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to server-side TLS certificate file to use when accepting connections at -clusternativeListenAddr if -clusternative.tls flag is set. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-clusternative.tlsCipherSuites array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional list of TLS cipher suites used for connections at -clusternativeListenAddr if -clusternative.tls flag is set. See the list of supported cipher suites at https://pkg.go.dev/crypto/tls#pkg-constants . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-clusternative.tlsInsecureSkipVerify
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to skip verification of TLS certificates provided by vmselect, which connects to -clusternativeListenAddr if -clusternative.tls flag is set. Note that disabled TLS certificate verification breaks security. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-clusternative.tlsKeyFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to server-side TLS key file to use when accepting connections at -clusternativeListenAddr if -clusternative.tls flag is set. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-clusternativeListenAddr string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
TCP address to listen for requests from other vmselect nodes in multi-level cluster setup. See https://docs.victoriametrics.com/cluster-victoriametrics/#multi-level-cluster-setup . Usually :8401 should be set to match default vmstorage port for vmselect. Disabled work if empty
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-dedup.minScrapeInterval duration
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Leave only the last sample in every time series per each discrete interval equal to -dedup.minScrapeInterval > 0. See https://docs.victoriametrics.com/#deduplication for details
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
-deleteAuthKey value
authKey for metrics' deletion via /prometheus/api/v1/admin/tsdb/delete_series and /graphite/tags/delSeries
Flag value can be read from the given file when using -deleteAuthKey=file:///abs/path/to/file or -deleteAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -deleteAuthKey=http://host/path or -deleteAuthKey=https://host/path
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
-denyQueryTracing
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to disable the ability to trace queries. See https://docs.victoriametrics.com/#query-tracing
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
-downsampling.period array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Comma-separated downsampling periods in the format 'offset:period'. For example, '30d:10m' instructs to leave a single sample per 10 minutes for samples older than 30 days. When setting multiple downsampling periods, it is necessary for the periods to be multiples of each other. See https://docs.victoriametrics.com/#downsampling for details. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-enableTCP6
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP are used
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-envflag.enable
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to enable reading flags from environment variables in addition to the command line. Command line flag values have priority over values from environment vars. Flags are read only from the command line if this flag isn't set. See https://docs.victoriametrics.com/#environment-variables for more details
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-envflag.prefix string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Prefix for environment variables if -envflag.enable is set
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
-eula
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Deprecated, please use -license or -licenseFile flags instead. By specifying this flag, you confirm that you have an enterprise license and accept the ESA https://victoriametrics.com/legal/esa/ . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
-filestream.disableFadvise
Whether to disable fadvise() syscall when reading large data files. The fadvise() syscall prevents from eviction of recently accessed data from OS page cache during background merges and backups. In some rare cases it is better to disable the syscall if it uses too much CPU
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-flagsAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -flagsAuthKey=file:///abs/path/to/file or -flagsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -flagsAuthKey=http://host/path or -flagsAuthKey=https://host/path
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-fs.disableMmap
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
Whether to use pread() instead of mmap() for reading data files. By default, mmap() is used for 64-bit arches and pread() is used for 32-bit arches, since they cannot read data files bigger than 2^32 bytes in memory. mmap() is usually faster for reading small data chunks than pread()
app/vmselect/netstorage: add support for the ability to set cross-group replication factor at vmselect The cross-group replication factor can be set via `-globalReplicationFactor` command-line flag at vmselect. In this case vmselect continues returning full responses if up to globalReplicationFactor-1 groups are unavailable. See https://docs.victoriametrics.com/cluster-victoriametrics/#vmstorage-groups-at-vmselect for details. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6054
2024-04-18 22:09:15 +00:00
-globalReplicationFactor int
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
How many copies of every ingested sample is available across vmstorage groups. vmselect continues returning full responses when up to globalReplicationFactor-1 vmstorage groups are temporarily unavailable. See https://docs.victoriametrics.com/cluster-victoriametrics/#vmstorage-groups-at-vmselect . See also -replicationFactor (default 1)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.connTimeout duration
lib/httpserver: return back the default value for -http.connTimeout to 2 minutes It has been appeared that there are VictoriaMetrics users, who rely on the fact that VictoriaMetrics components were closing incoming connections to -httpListenAddr every 2 minutes by default. So let's return back this value by default in order to fix the breaking change made at d8c1db7953d2265c9cd3a2913f12aac07a99a45c . See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1304#issuecomment-1961891450 .
2024-02-23 20:00:55 +00:00
Incoming connections to -httpListenAddr are closed after the configured timeout. This may help evenly spreading load among a cluster of services behind TCP-level load balancer. Zero value disables closing of incoming connections (default 2m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.disableResponseCompression
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
Disable compression of HTTP responses to save CPU resources. By default, compression is enabled to save network bandwidth
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
-http.header.csp string
Value for 'Content-Security-Policy' header, recommended: "default-src 'self'"
lib/httpserver: add flags to specify HSTS / Frame-Options / CSP headers for httpserver (#5111) support `Strict-Transport-Security`, `Content-Security-Policy` and `X-Frame-Options` HTTP headers in all VictoriaMetrics components. The values for headers can be specified by users via the following flags: `-http.header.hsts`, `-http.header.csp` and `-http.header.frameOptions`. Co-authored-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit ad839aa492704dda3a9f8e5fe9de58c4074bd39a) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-10-30 10:33:38 +00:00
-http.header.frameOptions string
Value for 'X-Frame-Options' header
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
-http.header.hsts string
Value for 'Strict-Transport-Security' header, recommended: 'max-age=31536000; includeSubDomains'
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.idleConnTimeout duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Timeout for incoming idle http connections (default 1m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.maxGracefulShutdownDuration duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum duration for a graceful shutdown of the HTTP server. A highly loaded server may require increased value for a graceful shutdown (default 7s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.pathPrefix string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
An optional prefix to add to all the paths handled by http server. For example, if '-http.pathPrefix=/foo/bar' is set, then all the http requests will be handled on '/foo/bar/*' paths. This may be useful for proxied requests. See https://www.robustperception.io/using-external-urls-and-proxies-with-prometheus
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.shutdownDelay duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Optional delay before http server shutdown. During this delay, the server returns non-OK responses from /health page, so load balancers can route new requests to other servers
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-httpAuth.password value
docs: make `httpAuth.*` flags description less ambiguous (#4588) * docs: make `httpAuth.*` flags description less ambiguous Currently, it may confuse users whether `httpAuth.*` flags are used by HTTP client or server configuration(see https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4586 for example). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix a typo Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-07 11:50:13 +00:00
Password for HTTP server's Basic Auth. The authentication is disabled if -httpAuth.username is empty
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -httpAuth.password=file:///abs/path/to/file or -httpAuth.password=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -httpAuth.password=http://host/path or -httpAuth.password=https://host/path
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
-httpAuth.username string
docs: make `httpAuth.*` flags description less ambiguous (#4588) * docs: make `httpAuth.*` flags description less ambiguous Currently, it may confuse users whether `httpAuth.*` flags are used by HTTP client or server configuration(see https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4586 for example). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix a typo Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-07 11:50:13 +00:00
Username for HTTP server's Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-httpListenAddr array
Address to listen for incoming http requests. See also -httpListenAddr.useProxyProtocol
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
-httpListenAddr.useProxyProtocol array
Whether to use proxy protocol for connections accepted at the given -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt . With enabled proxy protocol http server cannot serve regular /metrics endpoint. Use -pushmetrics.url for metrics pushing
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
lib/bytesutil: add `-internStringDisableCache` and `-internStringCacheExpireDuration` command-line flags This commit is based on https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3872
2023-02-27 22:15:49 +00:00
-internStringCacheExpireDuration duration
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
The expiry duration for caches for interned strings. See https://en.wikipedia.org/wiki/String_interning . See also -internStringMaxLen and -internStringDisableCache (default 6m0s)
lib/bytesutil: add `-internStringDisableCache` and `-internStringCacheExpireDuration` command-line flags This commit is based on https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3872
2023-02-27 22:15:49 +00:00
-internStringDisableCache
Whether to disable caches for interned strings. This may reduce memory usage at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringCacheExpireDuration and -internStringMaxLen
docs/Cluster-VictoriaMetrics.md: update command-line descriptions after ebebaecd94dc763a0c163c398a4b999624098d3d
2023-01-27 08:04:14 +00:00
-internStringMaxLen int
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
The maximum length for strings to intern. A lower limit may save memory at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringDisableCache and -internStringCacheExpireDuration (default 500)
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-license string
docs: fix docs/ and README.md spelling errors (#6362) Fixes `docs/` and `README.md` typos and errors. Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com> (cherry picked from commit c740a8042efeacc75b1ca967ed52df5e1a4dbbaa) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-03 08:04:13 +00:00
License key for VictoriaMetrics Enterprise. See https://victoriametrics.com/products/enterprise/ . Trial Enterprise license can be obtained from https://victoriametrics.com/products/enterprise/trial/ . This flag is available only in Enterprise binaries. The license key can be also passed via file specified by -licenseFile command-line flag
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-license.forceOffline
docs: fix docs/ and README.md spelling errors (#6362) Fixes `docs/` and `README.md` typos and errors. Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com> (cherry picked from commit c740a8042efeacc75b1ca967ed52df5e1a4dbbaa) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-03 08:04:13 +00:00
Whether to enable offline verification for VictoriaMetrics Enterprise license key, which has been passed either via -license or via -licenseFile command-line flag. The issued license key must support offline verification feature. Contact info@victoriametrics.com if you need offline license verification. This flag is available only in Enterprise binaries
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-licenseFile string
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Path to file with license key for VictoriaMetrics Enterprise. See https://victoriametrics.com/products/enterprise/ . Trial Enterprise license can be obtained from https://victoriametrics.com/products/enterprise/trial/ . This flag is available only in Enterprise binaries. The license key can be also passed inline via -license command-line flag
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerDisableTimestamps
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Whether to disable writing timestamps in logs
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerErrorsPerSecondLimit int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerFormat string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Format for logs. Possible values: default, json (default "default")
docs: update `-help` outputs for vm* tools
2023-01-04 06:40:00 +00:00
-loggerJSONFields string
Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerLevel string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO")
vmcluster: re-routing enhancement (#5293) * app/vmstorage: close vminsert connections gradually before stopping storage Implements graceful shutdown approach suggested here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1768146878 Test results for this can be found here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1790640274 Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * app/vmstorage: update graceful shutdown logic - close connections from vminsert in determenistic order - update flag description - lower default timeout to 25 seconds. 25 seconds value was chosen because the lowest default value used in default configuration deployments is 30s(default value in Kubernetes and ansible-playbooks). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add information about re-routing enhancement during restart Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/changelog: add entry for new command-line flag Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * {app/vmstorage,lib/ingestserver}: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add note to update workload scheduler timeout Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * wip --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-14 00:00:42 +00:00
-loggerMaxArgLen int
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
The maximum length of a single logged argument. Longer arguments are replaced with 'arg_start..arg_end', where 'arg_start' and 'arg_end' is prefix and suffix of the arg with the length not exceeding -loggerMaxArgLen / 2 (default 1000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerOutput string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Output for the logs. Supported values: stderr, stdout (default "stderr")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerTimezone string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Timezone to use for timestamps in logs. Timezone must be a valid IANA Time Zone. For example: America/New_York, Europe/Berlin, Etc/GMT+3 or Local (default "UTC")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerWarnsPerSecondLimit int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Per-second limit on the number of WARN messages. If more than the given number of warns are emitted per second, then the remaining warns are suppressed. Zero values disable the rate limit
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-memory.allowedBytes size
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Allowed size of system memory VictoriaMetrics caches may occupy. This option overrides -memory.allowedPercent if set to a non-zero value. Too low a value may increase the cache miss rate usually resulting in higher CPU and disk IO usage. Too high a value may evict too much data from the OS page cache resulting in higher disk IO usage
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-memory.allowedPercent float
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Allowed percent of system memory VictoriaMetrics caches may occupy. See also -memory.allowedBytes. Too low a value may increase cache miss rate usually resulting in higher CPU and disk IO usage. Too high a value may evict too much data from the OS page cache which will result in higher disk IO usage (default 60)
all: add -metrics.exposeMetadata command-line flag, which can be used for adding TYPE and HELP metadata for metrics exposed at /metrics page This may be needed for systems, which require this metadata such as Google Cloud Managed Prometheus. See https://cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting#missing-metric-type
2023-12-19 01:19:42 +00:00
-metrics.exposeMetadata
Whether to expose TYPE and HELP metadata at the /metrics page, which is exposed at -httpListenAddr . The metadata may be needed when the /metrics page is consumed by systems, which require this information. For example, Managed Prometheus in Google Cloud - https://cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting#missing-metric-type
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-metricsAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -metricsAuthKey=file:///abs/path/to/file or -metricsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -metricsAuthKey=http://host/path or -metricsAuthKey=https://host/path
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-mtls array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to require valid client certificate for https requests to the corresponding -httpListenAddr . This flag works only if -tls flag is set. See also -mtlsCAFile . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
-mtlsCAFile array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional path to TLS Root CA for verifying client certificates at the corresponding -httpListenAddr when -mtls is enabled. By default the host system TLS Root CA is used for client certificate verification. This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-pprofAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -pprofAuthKey=file:///abs/path/to/file or -pprofAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -pprofAuthKey=http://host/path or -pprofAuthKey=https://host/path
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
-prevCacheRemovalPercent float
Items in the previous caches are removed when the percent of requests it serves becomes lower than this value. Higher values reduce memory usage at the cost of higher CPU usage. See also -cacheExpireDuration (default 0.1)
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
-pushmetrics.disableCompression
Whether to disable request body compression when pushing metrics to every -pushmetrics.url
all: rename -pushmetrics.extraLabels to -pushmetrics.extraLabel for the sake of consistency
2022-07-26 16:24:24 +00:00
-pushmetrics.extraLabel array
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
Optional labels to add to metrics pushed to every -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to every -pushmetrics.url
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
-pushmetrics.header array
Optional HTTP request header to send to every -pushmetrics.url . For example, -pushmetrics.header='Authorization: Basic foobar' adds 'Authorization: Basic foobar' header to every request to every -pushmetrics.url
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
-pushmetrics.interval duration
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
Interval for pushing metrics to every -pushmetrics.url (default 10s)
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
-pushmetrics.url array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional URL to push metrics exposed at /metrics page. See https://docs.victoriametrics.com/#push-metrics . By default, metrics exposed at /metrics page aren't pushed to any remote storage
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
-replicationFactor array
app/vmselect/netstorage: add support for the ability to set cross-group replication factor at vmselect The cross-group replication factor can be set via `-globalReplicationFactor` command-line flag at vmselect. In this case vmselect continues returning full responses if up to globalReplicationFactor-1 groups are unavailable. See https://docs.victoriametrics.com/cluster-victoriametrics/#vmstorage-groups-at-vmselect for details. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6054
2024-04-18 22:09:15 +00:00
How many copies of every ingested sample is available across -storageNode nodes. vmselect continues returning full responses when up to replicationFactor-1 vmstorage nodes are temporarily unavailable. See also -globalReplicationFactor and -search.skipSlowReplicas (default 1)
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Supports an array of `key:value` entries separated by comma or specified via multiple flags.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.cacheTimestampOffset duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum duration since the current time for response data, which is always queried from the original raw data, without using the response cache. Increase this value if you see gaps in responses due to time synchronization issues between VictoriaMetrics and data sources (default 5m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.denyPartialResponse
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Whether to deny partial responses if a part of -storageNode instances fail to perform queries; this trades availability over consistency; see also -search.maxQueryDuration
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.disableCache
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to disable response caching. This may be useful when ingesting historical data. See https://docs.victoriametrics.com/#backfilling . See also -search.resetRollupResultCacheOnStartup
doc: add missing cmd flag description (#6504) (cherry picked from commit 2259e3cac7259b840beb5814810881649ea76906) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-18 13:24:38 +00:00
-search.disableImplicitConversion
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to return an error for queries that rely on implicit subquery conversions, see https://docs.victoriametrics.com/metricsql/#subqueries for details. See also -search.logImplicitConversion
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
-search.graphiteMaxPointsPerSeries int
app/vmselect/graphite: open source Graphite Render API
2023-04-01 06:35:26 +00:00
The maximum number of points per series Graphite render API can return (default 1000000)
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
-search.graphiteStorageStep duration
app/vmselect/graphite: open source Graphite Render API
2023-04-01 06:35:26 +00:00
The interval between datapoints stored in the database. It is used at Graphite Render API handler for normalizing the interval between datapoints in case it isn't normalized. It can be overridden by sending 'storage_step' query arg to /render API or by sending the desired interval via 'Storage-Step' http header during querying /render API (default 10s)
docs: update docs after 0b7a23a91d5f29535c3c485f0c1d92f87ae91fef
2024-02-29 22:17:42 +00:00
-search.ignoreExtraFiltersAtLabelsAPI
docs: fix docs/ and README.md spelling errors (#6362) Fixes `docs/` and `README.md` typos and errors. Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com> (cherry picked from commit c740a8042efeacc75b1ca967ed52df5e1a4dbbaa) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-03 08:04:13 +00:00
Whether to ignore match[], extra_filters[] and extra_label query args at /api/v1/labels and /api/v1/label/.../values . This may be useful for decreasing load on VictoriaMetrics when extra filters match too many time series. The downside is that superfluous labels or series could be returned, which do not match the extra filters. See also -search.maxLabelsAPISeries and -search.maxLabelsAPIDuration
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.latencyOffset duration
vmselect: support overriding of `-search.latencyOffset` (#3489) support overriding of `-search.latencyOffset` value via URL param `latency_offset`. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3481 Signed-off-by: hagen1778 <roman@victoriametrics.com> Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-12-17 00:54:57 +00:00
The time when data points become visible in query results after the collection. It can be overridden on per-query basis via latency_offset arg. Too small value can result in incomplete last points for query results (default 30s)
doc: add missing cmd flag description (#6504) (cherry picked from commit 2259e3cac7259b840beb5814810881649ea76906) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-18 13:24:38 +00:00
-search.logImplicitConversion
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to log queries with implicit subquery conversions, see https://docs.victoriametrics.com/metricsql/#subqueries for details. Such conversion can be disabled using -search.disableImplicitConversion
docs: update --help descriptions after recent changes
2023-02-24 02:57:16 +00:00
-search.logQueryMemoryUsage size
docs: update -help output after recent changes to VictoriaMetrics components
2023-11-02 19:23:32 +00:00
Log query and increment vm_memory_intensive_queries_total metric each time the query requires more memory than specified by this flag. This may help detecting and optimizing heavy queries. Query logging is disabled by default. See also -search.logSlowQueryDuration and -search.maxMemoryPerQuery
docs: update --help descriptions after recent changes
2023-02-24 02:57:16 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.logSlowQueryDuration duration
docs: update --help descriptions after recent changes
2023-02-24 02:57:16 +00:00
Log queries with execution time exceeding this value. Zero disables slow query logging. See also -search.logQueryMemoryUsage (default 5s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxConcurrentRequests int
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
The maximum number of concurrent search requests. It shouldn't be high, since a single request can saturate all the CPU cores, while many concurrently executed requests may require high amounts of memory. See also -search.maxQueueDuration and -search.maxMemoryPerQuery (default 16)
docs: add missing `-search.maxDeleteSeries` to vmselect flags Signed-off-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit 7f47713821f088d0dcdda70564b312c9a9b0083c)
2024-10-03 12:11:04 +00:00
-search.maxDeleteSeries int
The maximum number of time series, which can be deleted using /api/v1/admin/tsdb/delete_series. This option allows limiting memory usage (default 1000000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxExportDuration duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum duration for /api/v1/export call (default 720h0m0s)
docs/Cluster-VictoriaMetrics.md: update docs after b843f0e229d4099faabaaa59befeec2c82512cd0
2022-04-10 13:17:36 +00:00
-search.maxExportSeries int
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
The maximum number of time series, which can be returned from /api/v1/export* APIs. This option allows limiting memory usage (default 10000000)
docs/Cluster-VictoriaMetrics.md: update docs after b843f0e229d4099faabaaa59befeec2c82512cd0
2022-04-10 13:17:36 +00:00
-search.maxFederateSeries int
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
The maximum number of time series, which can be returned from /federate. This option allows limiting memory usage (default 1000000)
docs/Cluster-VictoriaMetrics.md: update docs after b843f0e229d4099faabaaa59befeec2c82512cd0
2022-04-10 13:17:36 +00:00
-search.maxGraphiteSeries int
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The maximum number of time series, which can be scanned during queries to Graphite Render API. See https://docs.victoriametrics.com/#graphite-render-api-usage (default 300000)
app/{graphite,netstorage,prometheus}: fix graphite search tags api limits, remove redudant limit from SeriesHandler handler (#4352) * app/{graphite,netstorage,prometheus}: fix graphite search tags api limits, remove unused limit from SeriesHandler handler, * app/{graphite,netstorage,prometheus}: use search.maxTagValues for Graphite * app/{graphite,netstorage,prometheus}: update CHANGELOG.md * app/{graphite,netstorage,prometheus}: use own flags for Graphite API * app/{graphite,netstorage,prometheus}: cleanup * app/{graphite,netstorage,prometheus}: cleanup * app/{graphite,netstorage,prometheus}: update docs --------- Co-authored-by: Nikolay <nik@victoriametrics.com> (cherry picked from commit c7884f8686dc25a08d1bc6145f3c84ea6d30b10f) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-06-02 12:34:04 +00:00
-search.maxGraphiteTagKeys int
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The maximum number of tag keys returned from Graphite API, which returns tags. See https://docs.victoriametrics.com/#graphite-tags-api-usage (default 100000)
app/{graphite,netstorage,prometheus}: fix graphite search tags api limits, remove redudant limit from SeriesHandler handler (#4352) * app/{graphite,netstorage,prometheus}: fix graphite search tags api limits, remove unused limit from SeriesHandler handler, * app/{graphite,netstorage,prometheus}: use search.maxTagValues for Graphite * app/{graphite,netstorage,prometheus}: update CHANGELOG.md * app/{graphite,netstorage,prometheus}: use own flags for Graphite API * app/{graphite,netstorage,prometheus}: cleanup * app/{graphite,netstorage,prometheus}: cleanup * app/{graphite,netstorage,prometheus}: update docs --------- Co-authored-by: Nikolay <nik@victoriametrics.com> (cherry picked from commit c7884f8686dc25a08d1bc6145f3c84ea6d30b10f) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-06-02 12:34:04 +00:00
-search.maxGraphiteTagValues int
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The maximum number of tag values returned from Graphite API, which returns tag values. See https://docs.victoriametrics.com/#graphite-tags-api-usage (default 100000)
app/vmselect: add -search.maxLabelsAPIDuration and -search.maxLabelsAPISeries options for fine-tuning CPU and RAM usage for /api/v1/series , /api/v1/labels and /api/v1/label/.../values This commit returns back limits for these endpoints, which have been removed at 5d66ee88bdb2bbab6419a2854a130c8838998923 , since it has been appeared that missing limits result in high CPU usage, while the introduced concurrency limiter results in failed lightweight requests to these endpoints because of timeout when heavyweight requests are executed. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5055
2024-02-23 00:44:07 +00:00
-search.maxLabelsAPIDuration duration
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
The maximum duration for /api/v1/labels, /api/v1/label/.../values and /api/v1/series requests. See also -search.maxLabelsAPISeries and -search.ignoreExtraFiltersAtLabelsAPI (default 5s)
app/vmselect: add -search.maxLabelsAPIDuration and -search.maxLabelsAPISeries options for fine-tuning CPU and RAM usage for /api/v1/series , /api/v1/labels and /api/v1/label/.../values This commit returns back limits for these endpoints, which have been removed at 5d66ee88bdb2bbab6419a2854a130c8838998923 , since it has been appeared that missing limits result in high CPU usage, while the introduced concurrency limiter results in failed lightweight requests to these endpoints because of timeout when heavyweight requests are executed. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5055
2024-02-23 00:44:07 +00:00
-search.maxLabelsAPISeries int
docs: fix typos (#6600) ### Describe Your Changes docs: fix typos ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). (cherry picked from commit 8786a08d27ace9f98da744597a2f4c285414c670) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-07-06 16:28:23 +00:00
The maximum number of time series, which could be scanned when searching for the matching time series at /api/v1/labels and /api/v1/label/.../values. This option allows limiting memory usage and CPU usage. See also -search.maxLabelsAPIDuration, -search.maxTagKeys, -search.maxTagValues and -search.ignoreExtraFiltersAtLabelsAPI (default 1000000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxLookback duration
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
Synonym to -search.lookback-delta from Prometheus. The value is dynamically detected from interval between time series datapoints if not set. It can be overridden on per-query basis via max_lookback arg. See also '-search.maxStalenessInterval' flag, which has the same meaning due to historical reasons
app/vmselect: allow limiting per-query memory usage via -search.maxMemoryPerQuery command-line flag Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3203
2022-10-07 22:07:42 +00:00
-search.maxMemoryPerQuery size
docs: update --help descriptions after recent changes
2023-02-24 02:57:16 +00:00
The maximum amounts of memory a single query may consume. Queries requiring more memory are rejected. The total memory limit for concurrently executed queries can be estimated as -search.maxMemoryPerQuery multiplied by -search.maxConcurrentRequests . See also -search.logQueryMemoryUsage
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxPointsPerTimeseries int
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
The maximum points per a single timeseries returned from /api/v1/query_range. This option doesn't limit the number of scanned raw samples in the database. The main purpose of this option is to limit the number of per-series points returned to graphing UI such as VMUI or Grafana. There is no sense in setting this limit to values bigger than the horizontal resolution of the graph. See also -search.maxResponseSeries (default 30000)
vmselect/promql: enable search.maxPointsSubqueryPerTimeseries for sub-queries (#2963) * vmselect/promql: enable search.maxPointsPerTimeSeriesSubquery for sub-queries * vmselect/promql: cleanup * vmselect/promql: rename config flag * vmselect/promql: add tests * vmselect/promql: use test object instead of log * vmselect/promql: fix posible panic is subquery has more points. add description * vmselect/promql: update tests descriptions * vmselect/promql: update doInternal validation * vmselect/promql: fix linter * vmselect/promql: fix linter * vmselect/promql: update documentation and release notes * wip - Properly apply -search.maxPointsSubqueryPerTimeseries limit to subqueries. Previously the -search.maxPointsPerTimeseries limit was unexpectedly applied to subqueries if it was smaller than the -search.maxPointsSubqueryPerTimeseries . - Clarify docs for -search.maxPointsSubqueryPerTimeseries command-line flag . - Document -search.maxPointsPerTimeseries and -search.maxPointsSubqueryPerTimeseries flags at https://docs.victoriametrics.com/#resource-usage-limits . - Update docs/CHANGELOG.md . Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2922 Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-08-24 12:25:18 +00:00
-search.maxPointsSubqueryPerTimeseries int
The maximum number of points per series, which can be generated by subquery. See https://valyala.medium.com/prometheus-subqueries-in-victoriametrics-9b1492b720b3 (default 100000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxQueryDuration duration
docs: clarify flags `-search.maxxxDuration` can only be overridden to… (#7227) … a smaller value with `timeout` arg
2024-10-25 09:11:09 +00:00
The maximum duration for query execution. It can be overridden to a smaller value on a per-query basis via 'timeout' query arg (default 30s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxQueryLen size
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum search query length in bytes
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 16384)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxQueueDuration duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum time the request waits for execution when -search.maxConcurrentRequests limit is reached; see also -search.maxQueryDuration (default 10s)
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
-search.maxResponseSeries int
The maximum number of time series which can be returned from /api/v1/query and /api/v1/query_range . The limit is disabled if it equals to 0. See also -search.maxPointsPerTimeseries and -search.maxUniqueTimeseries
app/vmselect: follow-up for 626073bca8098bea06d78ffa464339d4e36a86a6 * Rename -search.maxMetricsPointSearch to -search.maxSamplesPerQuery, so it is more consistent with the existing -search.maxSamplesPerSeries * Move the -search.maxSamplesPerQuery from vmstorage to vmselect, so it could effectively limit the number of raw samples obtained from all the vmstorage nodes * Document the -search.maxSamplesPerQuery in docs/CHANGELOG.md
2021-07-28 14:40:09 +00:00
-search.maxSamplesPerQuery int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum number of raw samples a single query can process across all time series. This protects from heavy queries, which select unexpectedly high number of raw samples. See also -search.maxSamplesPerSeries (default 1000000000)
app/vmselect/netstorage: add `-search.maxSamplesPerSeries` command-line option for limiting the number of samples a query can process per each series This should prevent from out of memory crashes like in https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1067
2021-07-15 13:03:26 +00:00
-search.maxSamplesPerSeries int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum number of raw samples a single query can scan per each time series. See also -search.maxSamplesPerQuery (default 30000000)
docs/Cluster-VictoriaMetrics.md: update docs after b843f0e229d4099faabaaa59befeec2c82512cd0
2022-04-10 13:17:36 +00:00
-search.maxSeries int
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
The maximum number of time series, which can be returned from /api/v1/series. This option allows limiting memory usage (default 30000)
docs: update -help output after e1c3267e34e6ef4b7694c6fef718adb8483cca6b
2023-02-25 01:13:01 +00:00
-search.maxSeriesPerAggrFunc int
The maximum number of time series an aggregate MetricsQL function can generate (default 1000000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxStalenessInterval duration
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
The maximum interval for staleness calculations. By default, it is automatically calculated from the median interval between samples. This flag could be useful for tuning Prometheus data model closer to Influx-style data model. See https://prometheus.io/docs/prometheus/latest/querying/basics/#staleness for details. See also '-search.setLookbackToStep' flag
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxStatusRequestDuration duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum duration for /api/v1/status/* requests (default 5m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxStepForPointsAdjustment duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum step when /api/v1/query_range handler adjusts points with timestamps closer than -search.latencyOffset to the current time. The adjustment is needed because such points may contain incomplete data (default 1m0s)
docs/Cluster-VictoriaMetrics.md: update docs after b843f0e229d4099faabaaa59befeec2c82512cd0
2022-04-10 13:17:36 +00:00
-search.maxTSDBStatusSeries int
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
The maximum number of time series, which can be processed during the call to /api/v1/status/tsdb. This option allows limiting memory usage (default 10000000)
docs: sync after recent changes
2022-07-06 23:42:45 +00:00
-search.maxTagValueSuffixesPerSearch int
The maximum number of tag value suffixes returned from /metrics/find (default 100000)
docs/Cluster-VictoriaMetrics.md: update docs after b843f0e229d4099faabaaa59befeec2c82512cd0
2022-04-10 13:17:36 +00:00
-search.maxUniqueTimeseries int
vmstorage: auto calculate maxUniqueTimeseries based on resources (#6961) ### Describe Your Changes Add support for https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6930 Calculate `-search.maxUniqueTimeseries` by `-search.maxConcurrentRequests` and remaining memory if it's **not set** or **less equal than 0**. The remaining memory is affected by `-memory.allowedPercent`, `-memory.allowedBytes` and cgroup memory limit. ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2024-10-18 11:41:43 +00:00
The maximum number of unique time series, which can be selected during /api/v1/query and /api/v1/query_range queries. This option allows limiting memory usage. The limit can't exceed the corresponding -search.maxUniqueTimeseries limit on vmstorage, it can be only set to lower values. (default 0)
app/vmselect: limit the number of parallel workers by 32 (#5195) * app/vmselect: limit the number of parallel workers by 32 The change should improve performance and memory usage during query processing on machines with big number of CPU cores. The number of parallel workers for query processing is controlled via `-search.maxWorkersPerQuery` command-line flag. By default, the number of workers is limited by the number of available CPU cores, but not more than 32. The limit can be increased via `-search.maxWorkersPerQuery`. Signed-off-by: hagen1778 <roman@victoriametrics.com> * wip - The `-search.maxWorkersPerQuery` command-line flag doesn't limit resource usage, so move it from the `resource usage limits` to `troubleshooting` chapter at docs/Single-server-VictoriaMetrics.md - Make more clear the description for the `-search.maxWorkersPerQuery` command-line flag - Add the description of `-search.maxWorkersPerQuery` to docs/Cluster-VictoriaMetrics.md - Limit the maximum value, which can be passed to `-search.maxWorkersPerQuery`, to GOMAXPROCS, because bigger values may worsen query performance and increase CPU usage - Improve the the description of the change at docs/CHANGELOG.md. Mark it as FEATURE instead of BUGFIX, since it is closer to a feature than to a bugfix. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5087 --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-10-18 17:51:37 +00:00
-search.maxWorkersPerQuery int
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
The maximum number of CPU cores a single query can use. The default value should work good for most cases. The flag can be set to lower values for improving performance of big number of concurrently executed queries. The flag can be set to bigger values for improving performance of heavy queries, which scan big number of time series (>10K) and/or big number of samples (>100M). There is no sense in setting this flag to values bigger than the number of CPU cores available on the system (default 16)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.minStalenessInterval duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The minimum interval for staleness calculations. This flag could be useful for removing gaps on graphs generated from time series with irregular intervals between samples. See also '-search.maxStalenessInterval'
docs/CHANGELOG.md: update the description of the optimization for SLO/SLI-like queries according to latest changes See commits 4497a08e3d5b4bc094c1d96ae93c99a1593885b3 and 92826b0b4a414e84410068d47639362f54f4fe87
2023-11-02 18:47:36 +00:00
-search.minWindowForInstantRollupOptimization value
Enable cache-based optimization for repeated queries to /api/v1/query (aka instant queries), which contain rollup functions with lookbehind window exceeding the given value
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/commit/f0d1db81dcce8124f1e5f87d5327532d1631739d Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-17 11:49:51 +00:00
The following optional suffixes are supported: s (second), h (hour), d (day), w (week), y (year). If suffix isn't set, then the duration is counted in months (default 3h)
app/vmselect: add `-search.noStaleMarkers` command-line flag for disabling stale markers handling in queries This option allows reducing CPU usage a bit when VictoriaMetrics is used for collecting and processing non-Prometheus data. For example, InfluxDB line protocol, Graphite, OpenTSDB, CSV, etc.
2021-08-18 10:54:12 +00:00
-search.noStaleMarkers
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Set this flag to true if the database doesn't contain Prometheus stale markers, so there is no need in spending additional CPU time on its handling. Staleness markers may exist only in data obtained from Prometheus scrape targets
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.queryStats.lastQueriesCount int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Query stats for /api/v1/status/top_queries is tracked on this number of last queries. Zero value disables query stats tracking (default 20000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.queryStats.minQueryDuration duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The minimum duration for queries to track in query stats at /api/v1/status/top_queries. Queries with lower duration are ignored in query stats (default 1ms)
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-search.resetCacheAuthKey value
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Optional authKey for resetting rollup cache via /internal/resetRollupResultCache call
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -search.resetCacheAuthKey=file:///abs/path/to/file or -search.resetCacheAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -search.resetCacheAuthKey=http://host/path or -search.resetCacheAuthKey=https://host/path
docs: update -help output after 61d9df4c36dfea7e0fe873d2e220bb39efd58a81 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/834
2024-02-08 12:47:21 +00:00
-search.resetRollupResultCacheOnStartup
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to reset rollup result cache on startup. See https://docs.victoriametrics.com/#rollup-result-cache . See also -search.disableCache
app/vmselect: add `-search.setLookbackToStep` command-line flag for making the gap filling algorithm similar to InfluxDB data model This option should override `-search.maxStalenessInterval` for most cases when users migrate from InfluxDB to VictoriaMetrics
2022-06-22 11:17:02 +00:00
-search.setLookbackToStep
Whether to fix lookback interval to 'step' query arg value. If set to true, the query model becomes closer to InfluxDB data model. If set to true, then -search.maxLookback and -search.maxStalenessInterval are ignored
vmselect: introduce `search.skipSlowReplicas` cmd-line flag (#4538) * vmselect: introduce `search.skipSlowReplicas` cmd-line flag vmselect has two logical conditions during request processing when `-replicationFactor` cmd-line flag is set: 1. If at least `len(storageNodes) - replicationFactor` responded, it could skip waiting for the rest of nodes to respond. This could lead to problems described here https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1207. 2. Mark response as partial if less than `len(storageNodes) - replicationFactor` responded without an error. The P1 showed itself error-prone and became the main reason why `-replicationFactor` wasn't recommended to use at vmselect level. However, this optimization could be still very useful in situations when there are slow and fast replicas in cluster. But P2 remains viable and important conditionless. Hiding P1 behind the feature-flag `search.skipSlowReplicas` should make `-replicationFactor` flag usable again. And let users choose whether they want P1 to be respected. Related issues https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1207 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/711 Signed-off-by: hagen1778 <roman@victoriametrics.com> * docs: update changelog Signed-off-by: hagen1778 <roman@victoriametrics.com> --------- Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-07 09:50:26 +00:00
-search.skipSlowReplicas
app/vmselect/netstorage: follow-up after 173ccf4333ff7f5967268ef7bc6ce12512ac7f3b - Clarify docs about -replicationFactor command-line flag at vmselect - Clarify description for -replicationFactor and -search.skipSlowReplicas command-line flags - Fix the logic for returning responses if -search.skipSlowReplicas command-line flag is enabled. The logic was broken in the 173ccf4333ff7f5967268ef7bc6ce12512ac7f3b, so it could return responses only if some of vmstorage nodes return error, while it should return when query results are successfully collected from more than (len(storageNodes) - replicationFactor) vmstorage nodes. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1207 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/711
2023-07-09 18:58:12 +00:00
Whether to skip -replicationFactor - 1 slowest vmstorage nodes during querying. Enabling this setting may improve query speed, but it could also lead to incomplete results if some queried data has less than -replicationFactor copies at vmstorage nodes. Consider enabling this setting only if all the queried data contains -replicationFactor copies in the cluster
app/vmselect:add command-line flag -search.inmemoryBufSizeBytes (#6869) add command-line flag `-search.inmemoryBufSizeBytes` for configuring size of in-memory buffers used by vmselect during processing of vmstorage responses. A new summary metric `vm_tmp_blocks_inmemory_file_size_bytes` is exposed to show the size of the buffer during requests processing. The new setting can be used by experienced users to adjust memory usage by vmselect when processing many small read requests. Instead of allocating 4MB buffers each time, vmselect can be instructed to lower the buffer size via `-search.inmemoryBufSizeBytes`. To make the decision whether this flag needs to be adjusted users can consult with `vm_tmp_blocks_inmemory_file_size_bytes` which shows the actual size of buffers used during query processing. ---------- The detailed information of this PR can be found in https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6851 ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Co-authored-by: hagen1778 <roman@victoriametrics.com>
2024-08-26 12:37:45 +00:00
-search.inmemoryBufSizeBytes size
Size for in-memory data blocks used during processing search requests. By default, the size is automatically calculated based on available memory. Adjust this flag value if you observe that vm_tmp_blocks_max_inmemory_file_size_bytes metric constantly shows much higher values than vm_tmp_blocks_inmemory_file_size_bytes. See https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6851
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
vmselect: add support of multi-tenant queries (#6346) ### Describe Your Changes Added an ability to query data across multiple tenants. See: https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1434 Currently, the following endpoints work with multi-tenancy: - /prometheus/api/v1/query - /prometheus/api/v1/query_range - /prometheus/api/v1/series - /prometheus/api/v1/labels - /prometheus/api/v1/label/<label_name>/values - /prometheus/api/v1/status/active_queries - /prometheus/api/v1/status/top_queries - /prometheus/api/v1/status/tsdb - /prometheus/api/v1/export - /prometheus/api/v1/export/csv - /vmui A note regarding VMUI: endpoints such as `active_queries` and `top_queries` have been updated to indicate whether query was a single-tenant or multi-tenant, but UI needs to be updated to display this info. cc: @Loori-R --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Signed-off-by: f41gh7 <nik@victoriametrics.com> Co-authored-by: f41gh7 <nik@victoriametrics.com>
2024-10-01 14:37:18 +00:00
-search.tenantCacheExpireDuration duration
The expiry duration for list of tenants for multi-tenant queries. (default 5m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.treatDotsAsIsInRegexps
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Whether to treat dots as is in regexp label filters used in queries. For example, foo{bar=~"a.b.c"} will be automatically converted to foo{bar=~"a\\.b\\.c"}, i.e. all the dots in regexp filters will be automatically escaped in order to match only dot char instead of matching any char. Dots in ".+", ".*" and ".{n}" regexps aren't escaped. This option is DEPRECATED in favor of {__graphite__="a.*.c"} syntax for selecting metrics matching the given Graphite metrics filter
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-selectNode array
docs/Cluster-VictoriaMetrics.md: typo fix: serparated -> separated
2022-05-03 12:19:15 +00:00
Comma-separated addresses of vmselect nodes; usage: -selectNode=vmselect-host1,...,vmselect-hostN
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-storageNode array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Comma-separated addresses of vmstorage nodes; usage: -storageNode=vmstorage-host1,...,vmstorage-hostN . Enterprise version of VictoriaMetrics supports automatic discovery of vmstorage addresses via DNS SRV records. For example, -storageNode=srv+vmstorage.addrs . See https://docs.victoriametrics.com/cluster-victoriametrics/#automatic-vmstorage-discovery
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: document the addition of `-storageNode.discoveryInterval` command-line flag
2022-12-07 03:57:46 +00:00
-storageNode.discoveryInterval duration
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Interval for refreshing -storageNode list behind DNS SRV records. The minimum supported interval is 1s. See https://docs.victoriametrics.com/cluster-victoriametrics/#automatic-vmstorage-discovery . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/ (default 2s)
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
-storageNode.filter string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
An optional regexp filter for discovered -storageNode addresses according to https://docs.victoriametrics.com/cluster-victoriametrics/#automatic-vmstorage-discovery. Discovered addresses matching the filter are retained, while other addresses are ignored. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tls array
Whether to enable TLS for incoming HTTP requests at the given -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set. See also -mtls
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertCacheDir string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Directory to store TLS certificates issued via Let's Encrypt. Certificates are lost on restarts if this flag isn't set. This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertEmail string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Contact email for the issued Let's Encrypt TLS certificates. See also -tlsAutocertHosts and -tlsAutocertCacheDir .This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertHosts array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional hostnames for automatic issuing of Let's Encrypt TLS certificates. These hostnames must be reachable at -httpListenAddr . The -httpListenAddr must listen tcp port 443 . The -tlsAutocertHosts overrides -tlsCertFile and -tlsKeyFile . See also -tlsAutocertEmail and -tlsAutocertCacheDir . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tlsCertFile array
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Path to file with TLS certificate for the corresponding -httpListenAddr if -tls is set. Prefer ECDSA certs instead of RSA certs as RSA certs are slower. The provided certificate file is automatically re-read every second, so it can be dynamically updated. See also -tlsAutocertHosts
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: update docs after 26ae50ec26f692f39836028d88d2495b98753fe6
2022-04-16 13:04:21 +00:00
-tlsCipherSuites array
docs/Cluster-VictoriaMetrics.md: sync docs
2022-04-16 13:58:34 +00:00
Optional list of TLS cipher suites for incoming requests over HTTPS if -tls is set. See the list of supported cipher suites at https://pkg.go.dev/crypto/tls#pkg-constants
docs/Cluster-VictoriaMetrics.md: update docs after 26ae50ec26f692f39836028d88d2495b98753fe6
2022-04-16 13:04:21 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tlsKeyFile array
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Path to file with TLS key for the corresponding -httpListenAddr if -tls is set. The provided key file is automatically re-read every second, so it can be dynamically updated. See also -tlsAutocertHosts
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
-tlsMinVersion array
Optional minimum TLS version to use for the corresponding -httpListenAddr if -tls is set. Supported values: TLS10, TLS11, TLS12, TLS13
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-version
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Show VictoriaMetrics version
docs/CHANGELOG.md: document 8639e79d384da3b0f2ccc00249f3e9ef25dd398c
2022-05-04 07:21:13 +00:00
-vmalert.proxyURL string
vmselect: allow proxying requests to vmalert (#2833) The change allows to proxy requests with prefix `/vmalert` to the vmalert component if `-vmalert.proxyURL` is set. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2825 and https://github.com/VictoriaMetrics/VictoriaMetrics/pull/2831 Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-07-06 08:47:51 +00:00
Optional URL for proxying requests to vmalert. For example, if -vmalert.proxyURL=http://vmalert:8880 , then alerting API requests such as /api/v1/rules from Grafana will be proxied to http://vmalert:8880/api/v1/rules
docs: update docs after e4d6b750f6967386425738d1fd754047c2ec617e Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2753
2022-06-21 10:58:04 +00:00
-vmstorageDialTimeout duration
app/{vminsert,vmselect}: follow-up after 2b7b3293c1119cc993143c34f0945504cdb35575 - Document the change at docs/CHANGELOG.md - Set the default value for -vmstorageUserTimeout to 3 seconds. This is much better than the 0 value, which means that TCP connection to unreachable vmstorage could block for up to 16 minutes. - Document -vmstorageUserTimeout at docs/Cluster-VictoriaMetrics.md
2023-08-29 10:09:24 +00:00
Timeout for establishing RPC connections from vmselect to vmstorage. See also -vmstorageUserTimeout (default 3s)
-vmstorageUserTimeout duration
Network timeout for RPC connections from vmselect to vmstorage (Linux only). Lower values reduce the maximum query durations when some vmstorage nodes become unavailable because of networking issues. Read more about TCP_USER_TIMEOUT at https://blog.cloudflare.com/when-tcp-sockets-refuse-to-die/ . See also -vmstorageDialTimeout (default 3s)
docs/Cluster-VictoriaMetrics.md: update command-line descriptions after ebebaecd94dc763a0c163c398a4b999624098d3d
2023-01-27 08:04:14 +00:00
-vmui.customDashboardsPath string
Optional path to vmui dashboards. See https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmui/packages/vmui/public/dashboards
vmui: add flag for default timezone setting (#5611) * vmui: add flag for default timezone setting #5375 * vmui: validate timezone before client return * Update app/vmselect/vmui.go --------- Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2024-01-23 02:11:19 +00:00
-vmui.defaultTimezone string
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
The default timezone to be used in vmui. Timezone must be a valid IANA Time Zone. For example: America/New_York, Europe/Berlin, Etc/GMT+3 or Local
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
```
### List of command-line flags for vmstorage
Below is the output for `/path/to/vmstorage -help`:
```
-bigMergeConcurrency int
docs: update -help output after bb7a419cc30afed0a42c431d48cb5f4d1ac29e7b
2024-01-26 21:28:40 +00:00
Deprecated: this flag does nothing
lib/blockcache: do not cache entries, which were attempted to be accessed 1 or 2 times Previously entries which were accessed only 1 time weren't cached. It has been appeared that some rarely executed heavy queries may read indexdb block twice in a row instead of once. There is no need in caching such a block then. This change should eliminate cache size spikes for indexdb/dataBlocks when such heavy queries are executed. Expose -blockcache.missesBeforeCaching command-line flag, which can be used for fine-tuning the number of cache misses needed before storing the block in the caching.
2023-11-10 20:54:25 +00:00
-blockcache.missesBeforeCaching int
The number of cache misses before putting the block into cache. Higher values may reduce indexdb/dataBlocks cache size at the cost of higher CPU and disk read usage (default 2)
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
-cacheExpireDuration duration
Items are removed from in-memory caches after they aren't accessed for this duration. Lower values may reduce memory usage at the cost of higher CPU usage. See also -prevCacheRemovalPercent (default 30m0s)
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tls
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to use TLS when accepting connections from vminsert and vmselect. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsCAFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to TLS CA file to use for verifying certificates provided by vminsert and vmselect if -cluster.tls flag is set. By default system CA is used. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsCertFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to server-side TLS certificate file to use when accepting connections from vminsert and vmselect if -cluster.tls flag is set. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
app/vmstorage: add support for mTLS cipher suites via `-cluster.tlsCipherSuites` command-line flag Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2404
2022-04-16 13:32:17 +00:00
-cluster.tlsCipherSuites array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional list of TLS cipher suites used for connections from vminsert and vmselect if -cluster.tls flag is set. See the list of supported cipher suites at https://pkg.go.dev/crypto/tls#pkg-constants . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
app/vmstorage: add support for mTLS cipher suites via `-cluster.tlsCipherSuites` command-line flag Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2404
2022-04-16 13:32:17 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
all: add -cluster.tlsInsecureSkipVerify command-line option to vminsert, vmselect and vmstorage components in order to be able to disable TLS certificate verification in mTLS mode See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2490
2022-05-03 10:08:01 +00:00
-cluster.tlsInsecureSkipVerify
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to skip verification of TLS certificates provided by vminsert and vmselect if -cluster.tls flag is set. Note that disabled TLS certificate verification breaks security. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-cluster.tlsKeyFile string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Path to server-side TLS key file to use when accepting connections from vminsert and vmselect if -cluster.tls flag is set. See https://docs.victoriametrics.com/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-dedup.minScrapeInterval duration
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Leave only the last sample in every time series per each discrete interval equal to -dedup.minScrapeInterval > 0. See https://docs.victoriametrics.com/#deduplication for details
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-denyQueriesOutsideRetention
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Whether to deny queries outside of the configured -retentionPeriod. When set, then /api/v1/query_range would return '503 Service Unavailable' error for queries with 'from' value outside -retentionPeriod. This may be useful when multiple data sources with distinct retentions are hidden behind query-tee
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
-denyQueryTracing
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to disable the ability to trace queries. See https://docs.victoriametrics.com/#query-tracing
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
-downsampling.period array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Comma-separated downsampling periods in the format 'offset:period'. For example, '30d:10m' instructs to leave a single sample per 10 minutes for samples older than 30 days. When setting multiple downsampling periods, it is necessary for the periods to be multiples of each other. See https://docs.victoriametrics.com/#downsampling for details. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-enableTCP6
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP are used
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-envflag.enable
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to enable reading flags from environment variables in addition to the command line. Command line flag values have priority over values from environment vars. Flags are read only from the command line if this flag isn't set. See https://docs.victoriametrics.com/#environment-variables for more details
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-envflag.prefix string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Prefix for environment variables if -envflag.enable is set
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 14:39:27 +00:00
-eula
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Deprecated, please use -license or -licenseFile flags instead. By specifying this flag, you confirm that you have an enterprise license and accept the ESA https://victoriametrics.com/legal/esa/ . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/filestream: add `-filestream.disableFadvise` syscall for unconditional disabling of `fadvise` syscall This may be needed in rare cases when performing backups on systems with big number of CPU cores and big value passed to -concurrency command-line flag. See https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5120
2023-10-04 14:18:40 +00:00
-filestream.disableFadvise
Whether to disable fadvise() syscall when reading large data files. The fadvise() syscall prevents from eviction of recently accessed data from OS page cache during background merges and backups. In some rare cases it is better to disable the syscall if it uses too much CPU
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-finalMergeDelay duration
docs: update -help output after bb7a419cc30afed0a42c431d48cb5f4d1ac29e7b
2024-01-26 21:28:40 +00:00
Deprecated: this flag does nothing
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-flagsAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -flagsAuthKey=file:///abs/path/to/file or -flagsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -flagsAuthKey=http://host/path or -flagsAuthKey=https://host/path
-forceFlushAuthKey value
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
authKey, which must be passed in query string to /internal/force_flush pages
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -forceFlushAuthKey=file:///abs/path/to/file or -forceFlushAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -forceFlushAuthKey=http://host/path or -forceFlushAuthKey=https://host/path
-forceMergeAuthKey value
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
authKey, which must be passed in query string to /internal/force_merge pages
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -forceMergeAuthKey=file:///abs/path/to/file or -forceMergeAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -forceMergeAuthKey=http://host/path or -forceMergeAuthKey=https://host/path
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-fs.disableMmap
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
Whether to use pread() instead of mmap() for reading data files. By default, mmap() is used for 64-bit arches and pread() is used for 32-bit arches, since they cannot read data files bigger than 2^32 bytes in memory. mmap() is usually faster for reading small data chunks than pread()
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.connTimeout duration
lib/httpserver: return back the default value for -http.connTimeout to 2 minutes It has been appeared that there are VictoriaMetrics users, who rely on the fact that VictoriaMetrics components were closing incoming connections to -httpListenAddr every 2 minutes by default. So let's return back this value by default in order to fix the breaking change made at d8c1db7953d2265c9cd3a2913f12aac07a99a45c . See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1304#issuecomment-1961891450 .
2024-02-23 20:00:55 +00:00
Incoming connections to -httpListenAddr are closed after the configured timeout. This may help evenly spreading load among a cluster of services behind TCP-level load balancer. Zero value disables closing of incoming connections (default 2m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.disableResponseCompression
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
Disable compression of HTTP responses to save CPU resources. By default, compression is enabled to save network bandwidth
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
-http.header.csp string
Value for 'Content-Security-Policy' header, recommended: "default-src 'self'"
lib/httpserver: add flags to specify HSTS / Frame-Options / CSP headers for httpserver (#5111) support `Strict-Transport-Security`, `Content-Security-Policy` and `X-Frame-Options` HTTP headers in all VictoriaMetrics components. The values for headers can be specified by users via the following flags: `-http.header.hsts`, `-http.header.csp` and `-http.header.frameOptions`. Co-authored-by: hagen1778 <roman@victoriametrics.com> (cherry picked from commit ad839aa492704dda3a9f8e5fe9de58c4074bd39a) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-10-30 10:33:38 +00:00
-http.header.frameOptions string
Value for 'X-Frame-Options' header
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
-http.header.hsts string
Value for 'Strict-Transport-Security' header, recommended: 'max-age=31536000; includeSubDomains'
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.idleConnTimeout duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Timeout for incoming idle http connections (default 1m0s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.maxGracefulShutdownDuration duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum duration for a graceful shutdown of the HTTP server. A highly loaded server may require increased value for a graceful shutdown (default 7s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.pathPrefix string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
An optional prefix to add to all the paths handled by http server. For example, if '-http.pathPrefix=/foo/bar' is set, then all the http requests will be handled on '/foo/bar/*' paths. This may be useful for proxied requests. See https://www.robustperception.io/using-external-urls-and-proxies-with-prometheus
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-http.shutdownDelay duration
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Optional delay before http server shutdown. During this delay, the server returns non-OK responses from /health page, so load balancers can route new requests to other servers
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-httpAuth.password value
docs: make `httpAuth.*` flags description less ambiguous (#4588) * docs: make `httpAuth.*` flags description less ambiguous Currently, it may confuse users whether `httpAuth.*` flags are used by HTTP client or server configuration(see https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4586 for example). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix a typo Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-07 11:50:13 +00:00
Password for HTTP server's Basic Auth. The authentication is disabled if -httpAuth.username is empty
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -httpAuth.password=file:///abs/path/to/file or -httpAuth.password=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -httpAuth.password=http://host/path or -httpAuth.password=https://host/path
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
-httpAuth.username string
docs: make `httpAuth.*` flags description less ambiguous (#4588) * docs: make `httpAuth.*` flags description less ambiguous Currently, it may confuse users whether `httpAuth.*` flags are used by HTTP client or server configuration(see https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4586 for example). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs: fix a typo Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-07 11:50:13 +00:00
Username for HTTP server's Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-httpListenAddr array
Address to listen for incoming http requests. See also -httpListenAddr.useProxyProtocol
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
-httpListenAddr.useProxyProtocol array
Whether to use proxy protocol for connections accepted at the given -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt . With enabled proxy protocol http server cannot serve regular /metrics endpoint. Use -pushmetrics.url for metrics pushing
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
app/vmstorage: addd missing -inmemoryDataFlushInterval command-line flag Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3337
2023-12-14 18:47:45 +00:00
-inmemoryDataFlushInterval duration
The interval for guaranteed saving of in-memory data to disk. The saved data survives unclean shutdowns such as OOM crash, hardware reset, SIGKILL, etc. Bigger intervals may help increase the lifetime of flash storage with limited write cycles (e.g. Raspberry PI). Smaller intervals increase disk IO load. Minimum supported value is 1s (default 5s)
lib/writeconcurrencylimiter: improve the logic behind -maxConcurrentInserts limit Previously the -maxConcurrentInserts was limiting the number of established client connections, which write data to VictoriaMetrics. Some of these connections could be idle. Such connections do not consume big amounts of CPU and RAM, so there is a little sense in limiting the number of such connections. So now the -maxConcurrentInserts command-line option limits the number of concurrently executed insert requests, not including idle connections. It is recommended removing -maxConcurrentInserts command-line option, since the default value for this option should work good for most cases.
2023-01-07 02:59:39 +00:00
-insert.maxQueueDuration duration
all: small improvements in error messages and command-line flag descriptions related to concurrency limiters
2023-01-07 08:11:44 +00:00
The maximum duration to wait in the queue when -maxConcurrentInserts concurrent insert requests are executed (default 1m0s)
lib/bytesutil: add `-internStringDisableCache` and `-internStringCacheExpireDuration` command-line flags This commit is based on https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3872
2023-02-27 22:15:49 +00:00
-internStringCacheExpireDuration duration
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
The expiry duration for caches for interned strings. See https://en.wikipedia.org/wiki/String_interning . See also -internStringMaxLen and -internStringDisableCache (default 6m0s)
lib/bytesutil: add `-internStringDisableCache` and `-internStringCacheExpireDuration` command-line flags This commit is based on https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3872
2023-02-27 22:15:49 +00:00
-internStringDisableCache
Whether to disable caches for interned strings. This may reduce memory usage at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringCacheExpireDuration and -internStringMaxLen
docs/Cluster-VictoriaMetrics.md: update command-line descriptions after ebebaecd94dc763a0c163c398a4b999624098d3d
2023-01-27 08:04:14 +00:00
-internStringMaxLen int
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
The maximum length for strings to intern. A lower limit may save memory at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringDisableCache and -internStringCacheExpireDuration (default 500)
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-license string
docs: fix docs/ and README.md spelling errors (#6362) Fixes `docs/` and `README.md` typos and errors. Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com> (cherry picked from commit c740a8042efeacc75b1ca967ed52df5e1a4dbbaa) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-03 08:04:13 +00:00
License key for VictoriaMetrics Enterprise. See https://victoriametrics.com/products/enterprise/ . Trial Enterprise license can be obtained from https://victoriametrics.com/products/enterprise/trial/ . This flag is available only in Enterprise binaries. The license key can be also passed via file specified by -licenseFile command-line flag
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-license.forceOffline
docs: fix docs/ and README.md spelling errors (#6362) Fixes `docs/` and `README.md` typos and errors. Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com> (cherry picked from commit c740a8042efeacc75b1ca967ed52df5e1a4dbbaa) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-06-03 08:04:13 +00:00
Whether to enable offline verification for VictoriaMetrics Enterprise license key, which has been passed either via -license or via -licenseFile command-line flag. The issued license key must support offline verification feature. Contact info@victoriametrics.com if you need offline license verification. This flag is available only in Enterprise binaries
docs: sync description for license flags (#4977) - update eula flag to add deprecation notice - add new license flags description Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-09-08 13:09:34 +00:00
-licenseFile string
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Path to file with license key for VictoriaMetrics Enterprise. See https://victoriametrics.com/products/enterprise/ . Trial Enterprise license can be obtained from https://victoriametrics.com/products/enterprise/trial/ . This flag is available only in Enterprise binaries. The license key can be also passed inline via -license command-line flag
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-logNewSeries
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Whether to log new series. This option is for debug purposes only. It can lead to performance issues when big number of new series are ingested into VictoriaMetrics
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerDisableTimestamps
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Whether to disable writing timestamps in logs
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerErrorsPerSecondLimit int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerFormat string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Format for logs. Possible values: default, json (default "default")
docs: update `-help` outputs for vm* tools
2023-01-04 06:40:00 +00:00
-loggerJSONFields string
Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerLevel string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO")
vmcluster: re-routing enhancement (#5293) * app/vmstorage: close vminsert connections gradually before stopping storage Implements graceful shutdown approach suggested here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1768146878 Test results for this can be found here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1790640274 Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * app/vmstorage: update graceful shutdown logic - close connections from vminsert in determenistic order - update flag description - lower default timeout to 25 seconds. 25 seconds value was chosen because the lowest default value used in default configuration deployments is 30s(default value in Kubernetes and ansible-playbooks). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add information about re-routing enhancement during restart Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/changelog: add entry for new command-line flag Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * {app/vmstorage,lib/ingestserver}: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add note to update workload scheduler timeout Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * wip --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-14 00:00:42 +00:00
-loggerMaxArgLen int
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
The maximum length of a single logged argument. Longer arguments are replaced with 'arg_start..arg_end', where 'arg_start' and 'arg_end' is prefix and suffix of the arg with the length not exceeding -loggerMaxArgLen / 2 (default 1000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerOutput string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Output for the logs. Supported values: stderr, stdout (default "stderr")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerTimezone string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Timezone to use for timestamps in logs. Timezone must be a valid IANA Time Zone. For example: America/New_York, Europe/Berlin, Etc/GMT+3 or Local (default "UTC")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-loggerWarnsPerSecondLimit int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Per-second limit on the number of WARN messages. If more than the given number of warns are emitted per second, then the remaining warns are suppressed. Zero values disable the rate limit
lib/writeconcurrencylimiter: improve the logic behind -maxConcurrentInserts limit Previously the -maxConcurrentInserts was limiting the number of established client connections, which write data to VictoriaMetrics. Some of these connections could be idle. Such connections do not consume big amounts of CPU and RAM, so there is a little sense in limiting the number of such connections. So now the -maxConcurrentInserts command-line option limits the number of concurrently executed insert requests, not including idle connections. It is recommended removing -maxConcurrentInserts command-line option, since the default value for this option should work good for most cases.
2023-01-07 02:59:39 +00:00
-maxConcurrentInserts int
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
The maximum number of concurrent insert requests. Set higher value when clients send data over slow networks. Default value depends on the number of available CPU cores. It should work fine in most cases since it minimizes resource usage. See also -insert.maxQueueDuration (default 32)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-memory.allowedBytes size
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Allowed size of system memory VictoriaMetrics caches may occupy. This option overrides -memory.allowedPercent if set to a non-zero value. Too low a value may increase the cache miss rate usually resulting in higher CPU and disk IO usage. Too high a value may evict too much data from the OS page cache resulting in higher disk IO usage
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-memory.allowedPercent float
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4613/commits/aec4b5db81b3595aee4593c426e7ed6375882d55 (#4638) Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-19 08:10:51 +00:00
Allowed percent of system memory VictoriaMetrics caches may occupy. See also -memory.allowedBytes. Too low a value may increase cache miss rate usually resulting in higher CPU and disk IO usage. Too high a value may evict too much data from the OS page cache which will result in higher disk IO usage (default 60)
all: add -metrics.exposeMetadata command-line flag, which can be used for adding TYPE and HELP metadata for metrics exposed at /metrics page This may be needed for systems, which require this metadata such as Google Cloud Managed Prometheus. See https://cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting#missing-metric-type
2023-12-19 01:19:42 +00:00
-metrics.exposeMetadata
Whether to expose TYPE and HELP metadata at the /metrics page, which is exposed at -httpListenAddr . The metadata may be needed when the /metrics page is consumed by systems, which require this information. For example, Managed Prometheus in Google Cloud - https://cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting#missing-metric-type
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-metricsAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -metricsAuthKey=file:///abs/path/to/file or -metricsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -metricsAuthKey=http://host/path or -metricsAuthKey=https://host/path
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-mtls array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Whether to require valid client certificate for https requests to the corresponding -httpListenAddr . This flag works only if -tls flag is set. See also -mtlsCAFile . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
-mtlsCAFile array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional path to TLS Root CA for verifying client certificates at the corresponding -httpListenAddr when -mtls is enabled. By default the host system TLS Root CA is used for client certificate verification. This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-pprofAuthKey value
lib/httpserver: skip basic auth check for additional request paths, which should call httpserver.CheckAuthFlag() This is a follow-up for 61dce6f2a1114284ede2b4c3c1943fea809d7b10 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6338 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6329
2024-07-15 23:00:42 +00:00
Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides -httpAuth.*
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -pprofAuthKey=file:///abs/path/to/file or -pprofAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -pprofAuthKey=http://host/path or -pprofAuthKey=https://host/path
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-precisionBits int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The number of precision bits to store per each value. Lower precision bits improves data compression at the cost of precision loss (default 64)
lib/workingsetcache: add `-prevCacheRemovalPercent` command-line flag for tuning memory usage vs CPU usage ratio Reduce the default value of this flag from 1% to 0.2% after 71335e6024831408f79d3d086a7cbfb8ebd670e5 This flag should help determining the best ratio for https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3343
2022-11-16 10:37:55 +00:00
-prevCacheRemovalPercent float
app/{vminsert,vmselect}: add `-storageNode.filter` command-line flag for filtering the discovered storage nodes Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3353
2022-11-21 13:15:18 +00:00
Items in the previous caches are removed when the percent of requests it serves becomes lower than this value. Higher values reduce memory usage at the cost of higher CPU usage. See also -cacheExpireDuration (default 0.1)
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
-pushmetrics.disableCompression
Whether to disable request body compression when pushing metrics to every -pushmetrics.url
all: rename -pushmetrics.extraLabels to -pushmetrics.extraLabel for the sake of consistency
2022-07-26 16:24:24 +00:00
-pushmetrics.extraLabel array
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
Optional labels to add to metrics pushed to every -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to every -pushmetrics.url
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
-pushmetrics.header array
Optional HTTP request header to send to every -pushmetrics.url . For example, -pushmetrics.header='Authorization: Basic foobar' adds 'Authorization: Basic foobar' header to every request to every -pushmetrics.url
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
-pushmetrics.interval duration
lib/pushmetrics: add -pushmetrics.header and -pushmetrics.disableCompression command-line flags
2023-12-17 17:56:46 +00:00
Interval for pushing metrics to every -pushmetrics.url (default 10s)
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
-pushmetrics.url array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional URL to push metrics exposed at /metrics page. See https://docs.victoriametrics.com/#push-metrics . By default, metrics exposed at /metrics page aren't pushed to any remote storage
docs/Cluster-VictoriaMetrics.md: update after fe68bb3ba79851c1a8bac0e792a3fbc88b753e0f
2022-07-21 17:21:30 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
lib/storage: add support for retention filters (aka multiple retentions for distinct sets of time series) Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/143 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/289
2022-10-24 00:02:14 +00:00
-retentionFilter array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Retention filter in the format 'filter:retention'. For example, '{env="dev"}:3d' configures the retention for time series with env="dev" label to 3 days. See https://docs.victoriametrics.com/#retention-filters for details. This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/enterprise/
lib/storage: add support for retention filters (aka multiple retentions for distinct sets of time series) Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/143 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/289
2022-10-24 00:02:14 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-retentionPeriod value
docs/Cluster-VictoriaMetrics.md: update `-help` output
2023-07-07 06:04:25 +00:00
Data with timestamps outside the retentionPeriod is automatically deleted. The minimum retentionPeriod is 24h or 1d. See also -retentionFilter
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/commit/f0d1db81dcce8124f1e5f87d5327532d1631739d Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-17 11:49:51 +00:00
The following optional suffixes are supported: s (second), h (hour), d (day), w (week), y (year). If suffix isn't set, then the duration is counted in months (default 1)
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
-retentionTimezoneOffset duration
The offset for performing indexdb rotation. If set to 0, then the indexdb rotation is performed at 4am UTC time per each -retentionPeriod. If set to 2h, then the indexdb rotation is performed at 4am EET time (the timezone with +2h offset)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-rpc.disableCompression
app/{vmselect,vmstorage}: return compression of the data passed from vmstorage to vmselect This reverts cd4f641d323cf0977c2e22915eb75edb765ad090 , since it has been appeared that the disabled compression for vmstorage->vmselect data increase network bandwidth usage by more than 10x on typical production workloads, while it decreases CPU usage at vmstorage by up to 10% and improves query latency by up to 10%. The 10x increase in network usage is too high price for 10% improvements on query latency and vmstorage CPU usage. This may result in network bandwidth bottlenecks, which can reduce the overall performance and stability of VictoriaMetrics cluster. That's why return back the vmstorage->vmselect data compression by default. The vmstorage->vmselect compression can be disabled by passing -rpc.disableCompression command-line flag to vmstorage. The vmselect->vmselect compression in multi-level cluster setup can be disabled by passing -clusternative.disableCompression command-line flag.
2024-01-24 11:32:13 +00:00
Whether to disable compression of the data sent from vmstorage to vmselect. This reduces CPU usage at the cost of higher network bandwidth usage
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
-search.maxConcurrentRequests int
docs: sync -help output for VictoriaMetrics components after recent changes
2023-12-09 23:09:48 +00:00
The maximum number of concurrent vmselect requests the vmstorage can process at -vmselectAddr. It shouldn't be high, since a single request usually saturates a CPU core, and many concurrently executed requests may require high amounts of memory. See also -search.maxQueueDuration (default 32)
lib/vmselectapi: limit the number of concurrently executed requests This should prevent from out of memory errors when big number of vmselect nodes send many concurrent requests to vmstorage The limit can be controlled at vmstorage via the following command-line flags: - search.maxConcurrentRequests - search.maxQueueDuration See https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#resource-usage-limits
2023-01-07 02:38:02 +00:00
-search.maxQueueDuration duration
The maximum time the incoming vmselect request waits for execution when -search.maxConcurrentRequests limit is reached (default 10s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxTagKeys int
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
The maximum number of tag keys returned per search. See also -search.maxLabelsAPISeries and -search.maxLabelsAPIDuration (default 100000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxTagValueSuffixesPerSearch int
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The maximum number of tag value suffixes returned from /metrics/find (default 100000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxTagValues int
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
The maximum number of tag values returned per search. See also -search.maxLabelsAPISeries and -search.maxLabelsAPIDuration (default 100000)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-search.maxUniqueTimeseries int
vmstorage: auto calculate maxUniqueTimeseries based on resources (#6961) ### Describe Your Changes Add support for https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6930 Calculate `-search.maxUniqueTimeseries` by `-search.maxConcurrentRequests` and remaining memory if it's **not set** or **less equal than 0**. The remaining memory is affected by `-memory.allowedPercent`, `-memory.allowedBytes` and cgroup memory limit. ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2024-10-18 11:41:43 +00:00
The maximum number of unique time series, which can be scanned during every query. This allows protecting against heavy queries, which select unexpectedly high number of series. When set to zero, the limit is automatically calculated based on -search.maxConcurrentRequests (inversely proportional) and memory available to the process (proportional). See also -search.max* command-line flags at vmselect.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-smallMergeConcurrency int
docs: update -help output after bb7a419cc30afed0a42c431d48cb5f4d1ac29e7b
2024-01-26 21:28:40 +00:00
Deprecated: this flag does nothing
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
-snapshotAuthKey value
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
authKey, which must be passed in query string to /snapshot* pages
all: allow dynamically reading *AuthKey flag values from files and urls Examples: 1) -metricsAuthKey=file:///abs/path/to/file - reads flag value from the given absolute filepath 2) -metricsAuthKey=file://./relative/path/to/file - reads flag value from the given relative filepath 3) -metricsAuthKey=http://some-host/some/path?query_arg=abc - reads flag value from the given url The flag value is automatically updated when the file contents changes.
2024-01-21 19:58:26 +00:00
Flag value can be read from the given file when using -snapshotAuthKey=file:///abs/path/to/file or -snapshotAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -snapshotAuthKey=http://host/path or -snapshotAuthKey=https://host/path
lib/storage: follow-up for 39cdc546ddf794a56a306134ff814e2e3a0ea39a - Use flag.Duration instead of flagutil.Duration for -snapshotCreateTimeout, since the flagutil.Duration is intended mostly for big durations, e.g. days, months and years, while the -snapshotCreateTimeout is usually smaller than one hour. - Add links to https://docs.victoriametrics.com/#how-to-work-with-snapshots in docs/CHANGELOG.md, so readers could easily find the corresponding docs when reading the changelog. - Properly remove all the created directories on unsuccessful attempt to create snapshot in Storage.CreateSnapshot(). Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3551
2023-02-27 20:57:22 +00:00
-snapshotCreateTimeout duration
docs: update `-help` output after recent changes in VictoriaMetrics components
2024-03-01 03:27:41 +00:00
Deprecated: this flag does nothing
docs/Cluster-VictoriaMetrics.md: make the description for `-rpc.disableCompression` command-line flag more clear
2022-05-06 13:24:45 +00:00
-snapshotsMaxAge value
all: add -cluster.tlsInsecureSkipVerify command-line option to vminsert, vmselect and vmstorage components in order to be able to disable TLS certificate verification in mTLS mode See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2490
2022-05-03 10:08:01 +00:00
Automatically delete snapshots older than -snapshotsMaxAge if it is set to non-zero duration. Make sure that backup process has enough time to finish the backup before the corresponding snapshot is automatically deleted
docs: follow-up after https://github.com/VictoriaMetrics/VictoriaMetrics/commit/f0d1db81dcce8124f1e5f87d5327532d1631739d Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-17 11:49:51 +00:00
The following optional suffixes are supported: s (second), h (hour), d (day), w (week), y (year). If suffix isn't set, then the duration is counted in months (default 0)
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-storage.cacheSizeIndexDBDataBlocks size
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Overrides max size for indexdb/dataBlocks cache. See https://docs.victoriametrics.com/single-server-victoriametrics/#cache-tuning
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-storage.cacheSizeIndexDBIndexBlocks size
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Overrides max size for indexdb/indexBlocks cache. See https://docs.victoriametrics.com/single-server-victoriametrics/#cache-tuning
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs: update command-line flags' descriptions according to recent changes
2022-06-14 10:23:44 +00:00
-storage.cacheSizeIndexDBTagFilters size
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Overrides max size for indexdb/tagFiltersToMetricIDs cache. See https://docs.victoriametrics.com/single-server-victoriametrics/#cache-tuning
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs: document the addition of mTLS communication between cluster components
2022-03-17 17:59:05 +00:00
-storage.cacheSizeStorageTSID size
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Overrides max size for storage/tsid cache. See https://docs.victoriametrics.com/single-server-victoriametrics/#cache-tuning
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-storage.maxDailySeries int
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The maximum number of unique series can be added to the storage during the last 24 hours. Excess series are logged and dropped. This can be useful for limiting series churn rate. See https://docs.victoriametrics.com/#cardinality-limiter . See also -storage.maxHourlySeries
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-storage.maxHourlySeries int
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The maximum number of unique series can be added to the storage during the last hour. Excess series are logged and dropped. This can be useful for limiting series cardinality. See https://docs.victoriametrics.com/#cardinality-limiter . See also -storage.maxDailySeries
app/{vminsert,vmstorage}: follow-up after a171916ef5664690c9b596fe73b095aa75fa5d5c Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/269
2021-10-08 10:52:56 +00:00
-storage.minFreeDiskSpaceBytes size
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
The minimum free disk space at -storageDataPath after which the storage stops accepting new data
lib/flagutil: support for TB and TiB suffixes for command-line flags, which accept byte sizes
2022-12-15 01:52:32 +00:00
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 10000000)
vmcluster: re-routing enhancement (#5293) * app/vmstorage: close vminsert connections gradually before stopping storage Implements graceful shutdown approach suggested here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1768146878 Test results for this can be found here - https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4922#issuecomment-1790640274 Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * app/vmstorage: update graceful shutdown logic - close connections from vminsert in determenistic order - update flag description - lower default timeout to 25 seconds. 25 seconds value was chosen because the lowest default value used in default configuration deployments is 30s(default value in Kubernetes and ansible-playbooks). Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add information about re-routing enhancement during restart Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/changelog: add entry for new command-line flag Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * {app/vmstorage,lib/ingestserver}: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/cluster: add note to update workload scheduler timeout Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * wip --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-11-14 00:00:42 +00:00
-storage.vminsertConnsShutdownDuration duration
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
The time needed for gradual closing of vminsert connections during graceful shutdown. Bigger duration reduces spikes in CPU, RAM and disk IO load on the remaining vmstorage nodes during rolling restart. Smaller duration reduces the time needed to close all the vminsert connections, thus reducing the time for graceful shutdown. See https://docs.victoriametrics.com/cluster-victoriametrics/#improving-re-routing-performance-during-restart (default 25s)
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-storageDataPath string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Path to storage data (default "vmstorage-data")
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tls array
Whether to enable TLS for incoming HTTP requests at the given -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set. See also -mtls
Supports array of values separated by comma or specified via multiple flags.
Empty values are set to false.
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertCacheDir string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Directory to store TLS certificates issued via Let's Encrypt. Certificates are lost on restarts if this flag isn't set. This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertEmail string
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Contact email for the issued Let's Encrypt TLS certificates. See also -tlsAutocertHosts and -tlsAutocertCacheDir .This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
-tlsAutocertHosts array
Revert "removed unneeded ref shortcodes, updated VM changelog to use relative markdown links (#6691)" This reverts commit 2e9b1efeb9422c60a345c67ebbbcaa5f8d37469d. Reason for revert: relative links in docs are much harder to maintain in consistent state comparing to absolute links: - It is non-trivial to figure out the proper relative link path when creating and editing docs. - Relative links break after moving the doc files to another paths, and it is non-trivial to figure which links are broken after that. - The updated relative links do not work properly right now in the docs. For example, the https://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page. This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 10:47:35 +00:00
Optional hostnames for automatic issuing of Let's Encrypt TLS certificates. These hostnames must be reachable at -httpListenAddr . The -httpListenAddr must listen tcp port 443 . The -tlsAutocertHosts overrides -tlsCertFile and -tlsKeyFile . See also -tlsAutocertEmail and -tlsAutocertCacheDir . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tlsCertFile array
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Path to file with TLS certificate for the corresponding -httpListenAddr if -tls is set. Prefer ECDSA certs instead of RSA certs as RSA certs are slower. The provided certificate file is automatically re-read every second, so it can be dynamically updated. See also -tlsAutocertHosts
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: update docs after 26ae50ec26f692f39836028d88d2495b98753fe6
2022-04-16 13:04:21 +00:00
-tlsCipherSuites array
docs/Cluster-VictoriaMetrics.md: sync docs
2022-04-16 13:58:34 +00:00
Optional list of TLS cipher suites for incoming requests over HTTPS if -tls is set. See the list of supported cipher suites at https://pkg.go.dev/crypto/tls#pkg-constants
docs/Cluster-VictoriaMetrics.md: update docs after 26ae50ec26f692f39836028d88d2495b98753fe6
2022-04-16 13:04:21 +00:00
Supports an array of values separated by comma or specified via multiple flags.
docs: sync `-help` output after recent changes
2024-02-01 13:02:18 +00:00
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
-tlsKeyFile array
lib/httpserver: add support for automatic issuing of TLS certificates via Lets Encrypt service Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5949
2024-04-17 21:38:16 +00:00
Path to file with TLS key for the corresponding -httpListenAddr if -tls is set. The provided key file is automatically re-read every second, so it can be dynamically updated. See also -tlsAutocertHosts
docs: update docs after ae8a867924b4ee70c1f2cfb56425bd48300cfe86 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1470
2024-02-09 02:18:05 +00:00
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
-tlsMinVersion array
Optional minimum TLS version to use for the corresponding -httpListenAddr if -tls is set. Supported values: TLS10, TLS11, TLS12, TLS13
Supports an array of values separated by comma or specified via multiple flags.
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-version
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Show VictoriaMetrics version
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-vminsertAddr string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
TCP address to accept connections from vminsert services (default ":8400")
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 09:21:12 +00:00
-vmselectAddr string
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
TCP address to accept connections from vmselect services (default ":8401")
docs: updated guides structure, removed deprecated sort option (#6767) ### Describe Your Changes * `sort` param is unused by the current website engine, and was present only for compatibility with previous website engine. It is time to remove it as it makes no effect * re-structure guides content into folders to simplify assets management ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). (cherry picked from commit 35d77a3bedee6268680dbda60db18c4ba5ed21c5)
2024-08-07 14:48:08 +00:00
```
Reference in a new issue Copy permalink