From cfc99e12da27f88613021b21d66a3e2857fc2f6d Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Tue, 21 Jun 2022 13:58:04 +0300 Subject: [PATCH] docs: update docs after e4d6b750f6967386425738d1fd754047c2ec617e Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2753 --- README.md | 6 ++++-- app/vmagent/README.md | 6 ++++-- app/vmalert/README.md | 6 ++++-- app/vmauth/README.md | 6 ++++-- docs/Cluster-VictoriaMetrics.md | 22 ++++++++++++++++------ docs/README.md | 6 ++++-- docs/Single-server-VictoriaMetrics.md | 6 ++++-- docs/vmagent.md | 6 ++++-- docs/vmalert.md | 6 ++++-- docs/vmauth.md | 6 ++++-- 10 files changed, 52 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 835319a1c..3e8735138 100644 --- a/README.md +++ b/README.md @@ -1880,6 +1880,8 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf -finalMergeDelay duration The delay before starting final merge for per-month partition after no new data is ingested into it. Final merge may require additional disk IO and CPU resources. Final merge may increase query speed and reduce disk space usage in some cases. Zero value disables final merge + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -forceFlushAuthKey string authKey, which must be passed in query string to /internal/force_flush pages -forceMergeAuthKey string @@ -1962,7 +1964,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -opentsdbHTTPListenAddr string TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty -opentsdbListenAddr string @@ -1975,7 +1977,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -opentsdbhttpTrimTimestamp duration 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) -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -precisionBits int The number of precision bits to store per each value. Lower precision bits improves data compression at the cost of precision loss (default 64) -promscrape.cluster.memberNum string diff --git a/app/vmagent/README.md b/app/vmagent/README.md index fc958b62e..da787f5cc 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -768,6 +768,8 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . Prefix for environment variables if -envflag.enable is set -eula By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -fs.disableMmap 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() -graphiteListenAddr string @@ -866,7 +868,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -opentsdbHTTPListenAddr string TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty -opentsdbListenAddr string @@ -879,7 +881,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -opentsdbhttpTrimTimestamp duration 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) -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -promscrape.cluster.memberNum string The number of number in the cluster of scrapers. It must be an unique value in the range 0 ... promscrape.cluster.membersCount-1 across scrapers in the cluster. Can be specified as pod name of Kubernetes StatefulSet - pod-name-Num, where Num is a numeric part of pod name (default "0") -promscrape.cluster.membersCount int diff --git a/app/vmalert/README.md b/app/vmalert/README.md index 898a998e5..d6ab0de9f 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -653,6 +653,8 @@ The shortlist of configuration flags is the following: Supports an array of values separated by comma or specified via multiple flags. -external.url string External URL is used as alert's source for sent alerts to the notifier + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -fs.disableMmap 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() -http.connTimeout duration @@ -693,7 +695,7 @@ The shortlist of configuration flags is the following: -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -notifier.basicAuth.password array Optional basic auth password for -notifier.url Supports an array of values separated by comma or specified via multiple flags. @@ -747,7 +749,7 @@ The shortlist of configuration flags is the following: Prometheus alertmanager URL, e.g. http://127.0.0.1:9093 Supports an array of values separated by comma or specified via multiple flags. -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -promscrape.consul.waitTime duration Wait time used by Consul service discovery. Default value is used if not set -promscrape.consulSDCheckInterval duration diff --git a/app/vmauth/README.md b/app/vmauth/README.md index ef9298c51..e0128ae43 100644 --- a/app/vmauth/README.md +++ b/app/vmauth/README.md @@ -238,6 +238,8 @@ See the docs at https://docs.victoriametrics.com/vmauth.html . Prefix for environment variables if -envflag.enable is set -eula By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -fs.disableMmap 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() -http.connTimeout duration @@ -282,9 +284,9 @@ See the docs at https://docs.victoriametrics.com/vmauth.html . -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -reloadAuthKey string Auth key for /-/reload http endpoint. It must be passed as authKey=... -tls diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index 15ed5efba..950ab50e3 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -533,6 +533,8 @@ Below is the output for `/path/to/vminsert -help`: Prefix for environment variables if -envflag.enable is set -eula By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -fs.disableMmap 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() -graphiteListenAddr string @@ -609,7 +611,7 @@ Below is the output for `/path/to/vminsert -help`: -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -opentsdbHTTPListenAddr string TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty -opentsdbListenAddr string @@ -622,7 +624,7 @@ Below is the output for `/path/to/vminsert -help`: -opentsdbhttpTrimTimestamp duration 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) -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -relabelConfig string 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 -relabelDebug @@ -647,6 +649,8 @@ Below is the output for `/path/to/vminsert -help`: Path to file with TLS key if -tls is set. The provided key file is automatically re-read every second, so it can be dynamically updated -version Show VictoriaMetrics version + -vmstorageDialTimeout duration + Timeout for establishing RPC connections from vminsert to vmstorage (default 5s) ``` ### List of command-line flags for vmselect @@ -681,6 +685,8 @@ Below is the output for `/path/to/vmselect -help`: Prefix for environment variables if -envflag.enable is set -eula By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -fs.disableMmap 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() -graphiteTrimTimestamp duration @@ -723,9 +729,9 @@ Below is the output for `/path/to/vmselect -help`: -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -replicationFactor int How many copies of every time series is available on vmstorage nodes. See -replicationFactor command-line flag for vminsert nodes (default 1) -search.cacheTimestampOffset duration @@ -810,6 +816,8 @@ Below is the output for `/path/to/vmselect -help`: Show VictoriaMetrics version -vmalert.proxyURL string Optional URL for proxying alerting API requests from Grafana. For example, if -vmalert.proxyURL is set to http://vmalert:8880 , then requests to /api/v1/rules are proxied to http://vmalert:8880/api/v1/rules + -vmstorageDialTimeout duration + Timeout for establishing RPC connections from vmselect to vmstorage (default 5s) ``` ### List of command-line flags for vmstorage @@ -851,6 +859,8 @@ Below is the output for `/path/to/vmstorage -help`: By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf -finalMergeDelay duration The delay before starting final merge for per-month partition after no new data is ingested into it. Final merge may require additional disk IO and CPU resources. Final merge may increase query speed and reduce disk space usage in some cases. Zero value disables final merge + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -forceFlushAuthKey string authKey, which must be passed in query string to /internal/force_flush pages -forceMergeAuthKey string @@ -897,9 +907,9 @@ Below is the output for `/path/to/vmstorage -help`: -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -precisionBits int The number of precision bits to store per each value. Lower precision bits improves data compression at the cost of precision loss (default 64) -retentionPeriod value diff --git a/docs/README.md b/docs/README.md index 835319a1c..3e8735138 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1880,6 +1880,8 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf -finalMergeDelay duration The delay before starting final merge for per-month partition after no new data is ingested into it. Final merge may require additional disk IO and CPU resources. Final merge may increase query speed and reduce disk space usage in some cases. Zero value disables final merge + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -forceFlushAuthKey string authKey, which must be passed in query string to /internal/force_flush pages -forceMergeAuthKey string @@ -1962,7 +1964,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -opentsdbHTTPListenAddr string TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty -opentsdbListenAddr string @@ -1975,7 +1977,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -opentsdbhttpTrimTimestamp duration 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) -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -precisionBits int The number of precision bits to store per each value. Lower precision bits improves data compression at the cost of precision loss (default 64) -promscrape.cluster.memberNum string diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index bb2b63432..882bf2029 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -1884,6 +1884,8 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf -finalMergeDelay duration The delay before starting final merge for per-month partition after no new data is ingested into it. Final merge may require additional disk IO and CPU resources. Final merge may increase query speed and reduce disk space usage in some cases. Zero value disables final merge + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -forceFlushAuthKey string authKey, which must be passed in query string to /internal/force_flush pages -forceMergeAuthKey string @@ -1966,7 +1968,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -opentsdbHTTPListenAddr string TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty -opentsdbListenAddr string @@ -1979,7 +1981,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -opentsdbhttpTrimTimestamp duration 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) -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -precisionBits int The number of precision bits to store per each value. Lower precision bits improves data compression at the cost of precision loss (default 64) -promscrape.cluster.memberNum string diff --git a/docs/vmagent.md b/docs/vmagent.md index 03e10b396..9ad84df6e 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -772,6 +772,8 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . Prefix for environment variables if -envflag.enable is set -eula By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -fs.disableMmap 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() -graphiteListenAddr string @@ -870,7 +872,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -opentsdbHTTPListenAddr string TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty -opentsdbListenAddr string @@ -883,7 +885,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -opentsdbhttpTrimTimestamp duration 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) -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -promscrape.cluster.memberNum string The number of number in the cluster of scrapers. It must be an unique value in the range 0 ... promscrape.cluster.membersCount-1 across scrapers in the cluster. Can be specified as pod name of Kubernetes StatefulSet - pod-name-Num, where Num is a numeric part of pod name (default "0") -promscrape.cluster.membersCount int diff --git a/docs/vmalert.md b/docs/vmalert.md index 12e0afc8a..7a562e27c 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -657,6 +657,8 @@ The shortlist of configuration flags is the following: Supports an array of values separated by comma or specified via multiple flags. -external.url string External URL is used as alert's source for sent alerts to the notifier + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -fs.disableMmap 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() -http.connTimeout duration @@ -697,7 +699,7 @@ The shortlist of configuration flags is the following: -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -notifier.basicAuth.password array Optional basic auth password for -notifier.url Supports an array of values separated by comma or specified via multiple flags. @@ -751,7 +753,7 @@ The shortlist of configuration flags is the following: Prometheus alertmanager URL, e.g. http://127.0.0.1:9093 Supports an array of values separated by comma or specified via multiple flags. -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -promscrape.consul.waitTime duration Wait time used by Consul service discovery. Default value is used if not set -promscrape.consulSDCheckInterval duration diff --git a/docs/vmauth.md b/docs/vmauth.md index 43dfef8be..86bf68b69 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -242,6 +242,8 @@ See the docs at https://docs.victoriametrics.com/vmauth.html . Prefix for environment variables if -envflag.enable is set -eula By specifying this flag, you confirm that you have an enterprise license and accept the EULA https://victoriametrics.com/assets/VM_EULA.pdf + -flagsAuthKey string + Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -fs.disableMmap 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() -http.connTimeout duration @@ -286,9 +288,9 @@ See the docs at https://docs.victoriametrics.com/vmauth.html . -memory.allowedPercent float 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 OS page cache which will result in higher disk IO usage (default 60) -metricsAuthKey string - Auth key for /metrics. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings -pprofAuthKey string - Auth key for /debug/pprof. It must be passed via authKey query arg. It overrides httpAuth.* settings + Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings -reloadAuthKey string Auth key for /-/reload http endpoint. It must be passed as authKey=... -tls