mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2025-01-20 07:19:17 +01:00
docs/vmauth.md: update -help
output
This commit is contained in:
parent
316abe550d
commit
e35abdd2e4
@ -342,7 +342,7 @@ See the docs at https://docs.victoriametrics.com/vmauth.html .
|
|||||||
-auth.config string
|
-auth.config string
|
||||||
Path to auth config. It can point either to local file or to http url. See https://docs.victoriametrics.com/vmauth.html for details on the format of this auth config
|
Path to auth config. It can point either to local file or to http url. See https://docs.victoriametrics.com/vmauth.html for details on the format of this auth config
|
||||||
-configCheckInterval duration
|
-configCheckInterval duration
|
||||||
Interval for config file re-read. Zero value disables config re-reading. By default, refreshing is disabled, send SIGHUP for config refresh.
|
interval for config file re-read. Zero value disables config re-reading. By default, refreshing is disabled, send SIGHUP for config refresh.
|
||||||
-enableTCP6
|
-enableTCP6
|
||||||
Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP is used
|
Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP is used
|
||||||
-envflag.enable
|
-envflag.enable
|
||||||
@ -374,9 +374,13 @@ See the docs at https://docs.victoriametrics.com/vmauth.html .
|
|||||||
-httpListenAddr string
|
-httpListenAddr string
|
||||||
TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8427")
|
TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8427")
|
||||||
-httpListenAddr.useProxyProtocol
|
-httpListenAddr.useProxyProtocol
|
||||||
Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
|
Whether to use proxy protocol for connections accepted at -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
|
||||||
|
-internStringCacheExpireDuration duration
|
||||||
|
The expiry duration for caches for interned strings. See https://en.wikipedia.org/wiki/String_interning . See also -internStringMaxLen and -internStringDisableCache (default 6m0s)
|
||||||
|
-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
|
||||||
-internStringMaxLen int
|
-internStringMaxLen int
|
||||||
The maximum length for strings to intern. Lower limit may save memory at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning (default 500)
|
The maximum length for strings to intern. 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)
|
||||||
-logInvalidAuthTokens
|
-logInvalidAuthTokens
|
||||||
Whether to log requests with invalid auth tokens. Such requests are always counted at vmauth_http_request_errors_total{reason="invalid_auth_token"} metric, which is exposed at /metrics page
|
Whether to log requests with invalid auth tokens. Such requests are always counted at vmauth_http_request_errors_total{reason="invalid_auth_token"} metric, which is exposed at /metrics page
|
||||||
-loggerDisableTimestamps
|
-loggerDisableTimestamps
|
||||||
@ -416,7 +420,7 @@ See the docs at https://docs.victoriametrics.com/vmauth.html .
|
|||||||
-pushmetrics.interval duration
|
-pushmetrics.interval duration
|
||||||
Interval for pushing metrics to -pushmetrics.url (default 10s)
|
Interval for pushing metrics to -pushmetrics.url (default 10s)
|
||||||
-pushmetrics.url array
|
-pushmetrics.url array
|
||||||
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
|
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
|
||||||
Supports an array of values separated by comma or specified via multiple flags.
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-reloadAuthKey string
|
-reloadAuthKey string
|
||||||
Auth key for /-/reload http endpoint. It must be passed as authKey=...
|
Auth key for /-/reload http endpoint. It must be passed as authKey=...
|
||||||
|
@ -353,7 +353,7 @@ See the docs at https://docs.victoriametrics.com/vmauth.html .
|
|||||||
-auth.config string
|
-auth.config string
|
||||||
Path to auth config. It can point either to local file or to http url. See https://docs.victoriametrics.com/vmauth.html for details on the format of this auth config
|
Path to auth config. It can point either to local file or to http url. See https://docs.victoriametrics.com/vmauth.html for details on the format of this auth config
|
||||||
-configCheckInterval duration
|
-configCheckInterval duration
|
||||||
Interval for config file re-read. Zero value disables config re-reading. By default, refreshing is disabled, send SIGHUP for config refresh.
|
interval for config file re-read. Zero value disables config re-reading. By default, refreshing is disabled, send SIGHUP for config refresh.
|
||||||
-enableTCP6
|
-enableTCP6
|
||||||
Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP is used
|
Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP is used
|
||||||
-envflag.enable
|
-envflag.enable
|
||||||
@ -385,9 +385,13 @@ See the docs at https://docs.victoriametrics.com/vmauth.html .
|
|||||||
-httpListenAddr string
|
-httpListenAddr string
|
||||||
TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8427")
|
TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8427")
|
||||||
-httpListenAddr.useProxyProtocol
|
-httpListenAddr.useProxyProtocol
|
||||||
Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
|
Whether to use proxy protocol for connections accepted at -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
|
||||||
|
-internStringCacheExpireDuration duration
|
||||||
|
The expiry duration for caches for interned strings. See https://en.wikipedia.org/wiki/String_interning . See also -internStringMaxLen and -internStringDisableCache (default 6m0s)
|
||||||
|
-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
|
||||||
-internStringMaxLen int
|
-internStringMaxLen int
|
||||||
The maximum length for strings to intern. Lower limit may save memory at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning (default 500)
|
The maximum length for strings to intern. 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)
|
||||||
-logInvalidAuthTokens
|
-logInvalidAuthTokens
|
||||||
Whether to log requests with invalid auth tokens. Such requests are always counted at vmauth_http_request_errors_total{reason="invalid_auth_token"} metric, which is exposed at /metrics page
|
Whether to log requests with invalid auth tokens. Such requests are always counted at vmauth_http_request_errors_total{reason="invalid_auth_token"} metric, which is exposed at /metrics page
|
||||||
-loggerDisableTimestamps
|
-loggerDisableTimestamps
|
||||||
@ -427,7 +431,7 @@ See the docs at https://docs.victoriametrics.com/vmauth.html .
|
|||||||
-pushmetrics.interval duration
|
-pushmetrics.interval duration
|
||||||
Interval for pushing metrics to -pushmetrics.url (default 10s)
|
Interval for pushing metrics to -pushmetrics.url (default 10s)
|
||||||
-pushmetrics.url array
|
-pushmetrics.url array
|
||||||
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
|
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
|
||||||
Supports an array of values separated by comma or specified via multiple flags.
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-reloadAuthKey string
|
-reloadAuthKey string
|
||||||
Auth key for /-/reload http endpoint. It must be passed as authKey=...
|
Auth key for /-/reload http endpoint. It must be passed as authKey=...
|
||||||
|
Loading…
Reference in New Issue
Block a user