From 0890adde676e4a4b015fb38acabe7ba58c4583f8 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Fri, 27 Jan 2023 00:00:30 -0800 Subject: [PATCH] docs: update command-line descriptions after 73256fe438ce63f5a44ee733678ba37d179bfada --- README.md | 20 +++++++++++++++----- app/vmagent/README.md | 20 +++++++++++++++----- app/vmalert/README.md | 4 +++- app/vmauth/README.md | 6 +++++- app/vmgateway/README.md | 6 +++++- docs/README.md | 20 +++++++++++++++----- docs/Single-server-VictoriaMetrics.md | 20 +++++++++++++++----- docs/vmagent.md | 20 +++++++++++++++----- docs/vmalert.md | 4 +++- docs/vmauth.md | 6 +++++- docs/vmgateway.md | 6 +++++- 11 files changed, 101 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index e51a7f5c8999..004ebc646b37 100644 --- a/README.md +++ b/README.md @@ -2172,7 +2172,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -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 - TCP and UDP address to listen for Graphite plaintext data. Usually :2003 must be set. Doesn't work if empty + 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 -graphiteTrimTimestamp duration 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) -http.connTimeout duration @@ -2192,7 +2194,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections (default ":8428") + TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8428") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -import.maxLineLen size 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 Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 104857600) @@ -2205,7 +2209,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -influxDBLabel string Default label for the DB name sent over '?db={db_name}' query parameter (default "db") -influxListenAddr string - 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://:8428/write + 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://: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 -influxMeasurementFieldSeparator string Separator for '{measurement}{separator}{field_name}' metric name when inserted via InfluxDB line protocol (default "_") -influxSkipMeasurement @@ -2255,9 +2261,13 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -metricsAuthKey string 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 + TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty. See also -opentsdbHTTPListenAddr.useProxyProtocol + -opentsdbHTTPListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbHTTPListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbListenAddr string - TCP and UDP address to listen for OpentTSDB 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 + TCP and UDP address to listen for OpentTSDB 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 + -opentsdbListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbTrimTimestamp duration 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) -opentsdbhttp.maxInsertRequestSize size diff --git a/app/vmagent/README.md b/app/vmagent/README.md index c123e85c5e5d..9349f7c286ce 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -1161,7 +1161,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -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 - TCP and UDP address to listen for Graphite plaintext data. Usually :2003 must be set. Doesn't work if empty + 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 -graphiteTrimTimestamp duration 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) -http.connTimeout duration @@ -1181,7 +1183,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections. Set this flag to empty value in order to disable listening on any port. This mode may be useful for running multiple vmagent instances on the same server. Note that /targets and /metrics pages aren't available if -httpListenAddr='' (default ":8429") + TCP address to listen for http connections. Set this flag to empty value in order to disable listening on any port. This mode may be useful for running multiple vmagent instances on the same server. Note that /targets and /metrics pages aren't available if -httpListenAddr=''. See also -httpListenAddr.useProxyProtocol (default ":8429") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -import.maxLineLen size 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 Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 104857600) @@ -1194,7 +1198,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -influxDBLabel string Default label for the DB name sent over '?db={db_name}' query parameter (default "db") -influxListenAddr string - 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://:8429/write + 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://:8429/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 -influxMeasurementFieldSeparator string Separator for '{measurement}{separator}{field_name}' metric name when inserted via InfluxDB line protocol (default "_") -influxSkipMeasurement @@ -1262,9 +1268,13 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -metricsAuthKey string 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 + TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty. See also -opentsdbHTTPListenAddr.useProxyProtocol + -opentsdbHTTPListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbHTTPListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbListenAddr string - TCP and UDP address to listen for OpentTSDB 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 + TCP and UDP address to listen for OpentTSDB 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 + -opentsdbListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbTrimTimestamp duration 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) -opentsdbhttp.maxInsertRequestSize size diff --git a/app/vmalert/README.md b/app/vmalert/README.md index c653abcbd876..cfd4bd156285 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -897,7 +897,9 @@ The shortlist of configuration flags is the following: -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - Address to listen for http connections (default ":8880") + Address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8880") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -insert.maxQueueDuration duration The maximum duration to wait in the queue when -maxConcurrentInserts concurrent insert requests are executed (default 1m0s) -internStringMaxLen int diff --git a/app/vmauth/README.md b/app/vmauth/README.md index 9740f98510b3..aa384cdbcf12 100644 --- a/app/vmauth/README.md +++ b/app/vmauth/README.md @@ -261,7 +261,11 @@ See the docs at https://docs.victoriametrics.com/vmauth.html . -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections (default ":8427") + TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8427") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt + -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 300) -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 -loggerDisableTimestamps diff --git a/app/vmgateway/README.md b/app/vmgateway/README.md index 70772090cc81..2003bc6a7b94 100644 --- a/app/vmgateway/README.md +++ b/app/vmgateway/README.md @@ -304,7 +304,11 @@ The shortlist of configuration flags include the following: -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections (default ":8431") + TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8431") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt + -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 300) -loggerDisableTimestamps Whether to disable writing timestamps in logs -loggerErrorsPerSecondLimit int diff --git a/docs/README.md b/docs/README.md index f488b5992594..f3d0f85864a9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2173,7 +2173,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -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 - TCP and UDP address to listen for Graphite plaintext data. Usually :2003 must be set. Doesn't work if empty + 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 -graphiteTrimTimestamp duration 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) -http.connTimeout duration @@ -2193,7 +2195,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections (default ":8428") + TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8428") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -import.maxLineLen size 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 Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 104857600) @@ -2206,7 +2210,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -influxDBLabel string Default label for the DB name sent over '?db={db_name}' query parameter (default "db") -influxListenAddr string - 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://:8428/write + 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://: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 -influxMeasurementFieldSeparator string Separator for '{measurement}{separator}{field_name}' metric name when inserted via InfluxDB line protocol (default "_") -influxSkipMeasurement @@ -2256,9 +2262,13 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -metricsAuthKey string 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 + TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty. See also -opentsdbHTTPListenAddr.useProxyProtocol + -opentsdbHTTPListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbHTTPListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbListenAddr string - TCP and UDP address to listen for OpentTSDB 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 + TCP and UDP address to listen for OpentTSDB 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 + -opentsdbListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbTrimTimestamp duration 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) -opentsdbhttp.maxInsertRequestSize size diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 5da7b547583b..a1d2a6429f3b 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -2176,7 +2176,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -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 - TCP and UDP address to listen for Graphite plaintext data. Usually :2003 must be set. Doesn't work if empty + 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 -graphiteTrimTimestamp duration 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) -http.connTimeout duration @@ -2196,7 +2198,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections (default ":8428") + TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8428") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -import.maxLineLen size 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 Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 104857600) @@ -2209,7 +2213,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -influxDBLabel string Default label for the DB name sent over '?db={db_name}' query parameter (default "db") -influxListenAddr string - 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://:8428/write + 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://: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 -influxMeasurementFieldSeparator string Separator for '{measurement}{separator}{field_name}' metric name when inserted via InfluxDB line protocol (default "_") -influxSkipMeasurement @@ -2259,9 +2265,13 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li -metricsAuthKey string 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 + TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty. See also -opentsdbHTTPListenAddr.useProxyProtocol + -opentsdbHTTPListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbHTTPListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbListenAddr string - TCP and UDP address to listen for OpentTSDB 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 + TCP and UDP address to listen for OpentTSDB 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 + -opentsdbListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbTrimTimestamp duration 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) -opentsdbhttp.maxInsertRequestSize size diff --git a/docs/vmagent.md b/docs/vmagent.md index ffd6ffabee20..115907a05b52 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -1165,7 +1165,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -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 - TCP and UDP address to listen for Graphite plaintext data. Usually :2003 must be set. Doesn't work if empty + 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 -graphiteTrimTimestamp duration 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) -http.connTimeout duration @@ -1185,7 +1187,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections. Set this flag to empty value in order to disable listening on any port. This mode may be useful for running multiple vmagent instances on the same server. Note that /targets and /metrics pages aren't available if -httpListenAddr='' (default ":8429") + TCP address to listen for http connections. Set this flag to empty value in order to disable listening on any port. This mode may be useful for running multiple vmagent instances on the same server. Note that /targets and /metrics pages aren't available if -httpListenAddr=''. See also -httpListenAddr.useProxyProtocol (default ":8429") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -import.maxLineLen size 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 Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 104857600) @@ -1198,7 +1202,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -influxDBLabel string Default label for the DB name sent over '?db={db_name}' query parameter (default "db") -influxListenAddr string - 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://:8429/write + 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://:8429/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 -influxMeasurementFieldSeparator string Separator for '{measurement}{separator}{field_name}' metric name when inserted via InfluxDB line protocol (default "_") -influxSkipMeasurement @@ -1266,9 +1272,13 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -metricsAuthKey string 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 + TCP address to listen for OpentTSDB HTTP put requests. Usually :4242 must be set. Doesn't work if empty. See also -opentsdbHTTPListenAddr.useProxyProtocol + -opentsdbHTTPListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbHTTPListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbListenAddr string - TCP and UDP address to listen for OpentTSDB 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 + TCP and UDP address to listen for OpentTSDB 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 + -opentsdbListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -opentsdbListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -opentsdbTrimTimestamp duration 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) -opentsdbhttp.maxInsertRequestSize size diff --git a/docs/vmalert.md b/docs/vmalert.md index 0e9ffaaf47a5..b47b30d5f57e 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -901,7 +901,9 @@ The shortlist of configuration flags is the following: -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - Address to listen for http connections (default ":8880") + Address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8880") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt -insert.maxQueueDuration duration The maximum duration to wait in the queue when -maxConcurrentInserts concurrent insert requests are executed (default 1m0s) -internStringMaxLen int diff --git a/docs/vmauth.md b/docs/vmauth.md index 563a6ac65be8..d905f06f4589 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -265,7 +265,11 @@ See the docs at https://docs.victoriametrics.com/vmauth.html . -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections (default ":8427") + TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8427") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt + -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 300) -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 -loggerDisableTimestamps diff --git a/docs/vmgateway.md b/docs/vmgateway.md index 06c96331663a..f4ea98af854a 100644 --- a/docs/vmgateway.md +++ b/docs/vmgateway.md @@ -308,7 +308,11 @@ The shortlist of configuration flags include the following: -httpAuth.username string Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string - TCP address to listen for http connections (default ":8431") + TCP address to listen for http connections. See also -httpListenAddr.useProxyProtocol (default ":8431") + -httpListenAddr.useProxyProtocol + Whether to use proxy protocol for connections accepted at -httpListenAddr . See https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt + -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 300) -loggerDisableTimestamps Whether to disable writing timestamps in logs -loggerErrorsPerSecondLimit int