Last active
August 26, 2025 16:02
-
-
Save makasim/f2582e956b2c9499be2a90194c5e474f to your computer and use it in GitHub Desktop.
Syncronize flags in docs from binaries
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### List of command-line flags for vminsert | |
Below is the output for `/path/to/vminsert -help`: | |
{{% content "vminsert_flags.md" %}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
update-flags: | |
git fetch enterprise | |
git worktree remove /tmp/vm-enterprise-cluster || true | |
git worktree add /tmp/vm-enterprise-cluster enterprise/enterprise-cluster | |
(cd /tmp/vm-enterprise-cluster && make vminsert vmselect vmstorage) | |
printf -- '---\nbuild:\n list: never\n publishResources: false\n render: never\n---\n```\n' > docs/victoriametrics/vminsert_flags.md | |
(cd /tmp/vm-enterprise-cluster && ./bin/vminsert -help 2>&1) >> docs/victoriametrics/vminsert_flags.md | |
printf -- '\n```\n' >> docs/victoriametrics/vminsert_flags.md | |
# replace tabs in output with one space | |
sed -i 's/\t/ /g' docs/victoriametrics/vminsert_flags.md | |
# vminsert uses some code from lib/promscrape but not flags, but they are still registered. removing | |
awk -i inplace '\ | |
/^ -promscrape./ {skip=1; next}\ | |
skip && /^ / {next}\ | |
skip {skip=0}\ | |
{print}\ | |
' docs/victoriametrics/vminsert_flags.md | |
# adjust flags with dynamic default values | |
sed -i '/The maximum number of concurrent insert requests/ s/(default [0-9]\+)/(default 2*cgroup.AvailableCPUs())/' docs/victoriametrics/vminsert_flags.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
--- | |
build: | |
list: never | |
publishResources: false | |
render: never | |
--- | |
``` | |
vminsert accepts data via popular data ingestion protocols and routes it to vmstorage nodes configured via -storageNode. | |
See the docs at https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/ . | |
-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) | |
-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) | |
-cluster.tls | |
Whether to use TLS for connections to -storageNode. See https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/victoriametrics/enterprise/ | |
-cluster.tlsCAFile string | |
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/victoriametrics/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/victoriametrics/enterprise/ | |
-cluster.tlsCertFile string | |
Path to client-side TLS certificate file to use when connecting to -storageNode if -cluster.tls flag is set. See https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/victoriametrics/enterprise/ | |
-cluster.tlsInsecureSkipVerify | |
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/victoriametrics/enterprise/ | |
-cluster.tlsKeyFile string | |
Path to client-side TLS key file to use when connecting to -storageNode if -cluster.tls flag is set. See https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/#mtls-protection . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/victoriametrics/enterprise/ | |
-clusternative.vminsertConnsShutdownDuration duration | |
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/victoriametrics/cluster-victoriametrics/#improving-re-routing-performance-during-restart (default 25s) | |
-clusternativeListenAddr string | |
TCP address to listen for data from other vminsert nodes in multi-level cluster setup. See https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/#multi-level-cluster-setup . Usually :8400 should be set to match default vmstorage port for vminsert. Disabled work if empty | |
-csvTrimTimestamp duration | |
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) | |
-datadog.maxInsertRequestSize size | |
The maximum size in bytes of a single DataDog POST request to /datadog/api/v2/series | |
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864) | |
-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) | |
-denyQueryTracing | |
Whether to disable the ability to trace queries. See https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#query-tracing | |
-disableRerouting | |
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 | |
-dropSamplesOnOverload | |
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. | |
-enableMetadata | |
Whether to enable metadata processing for metrics scraped from targets, received via VictoriaMetrics remote write, Prometheus remote write v1 or OpenTelemetry protocol. See also remoteWrite.maxMetadataPerBlock | |
-enableTCP6 | |
Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP are used | |
-envflag.enable | |
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/victoriametrics/single-server-victoriametrics/#environment-variables for more details | |
-envflag.prefix string | |
Prefix for environment variables if -envflag.enable is set | |
-eula | |
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/victoriametrics/enterprise/ | |
-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 | |
-flagsAuthKey value | |
Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides -httpAuth.* | |
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 | |
-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() | |
-graphite.sanitizeMetricName | |
Sanitize metric names for the ingested Graphite data. See https://docs.victoriametrics.com/victoriametrics/integrations/graphite/#ingesting | |
-graphiteListenAddr string | |
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 | |
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) | |
-http.disableCORS | |
Disable CORS for all origins (*) | |
-http.disableKeepAlive | |
Whether to disable HTTP keep-alive for incoming connections at -httpListenAddr | |
-http.disableResponseCompression | |
Disable compression of HTTP responses to save CPU resources. By default, compression is enabled to save network bandwidth | |
-http.header.csp string | |
Value for 'Content-Security-Policy' header, recommended: "default-src 'self'" | |
-http.header.frameOptions string | |
Value for 'X-Frame-Options' header | |
-http.header.hsts string | |
Value for 'Strict-Transport-Security' header, recommended: 'max-age=31536000; includeSubDomains' | |
-http.idleConnTimeout duration | |
Timeout for incoming idle http connections (default 1m0s) | |
-http.maxGracefulShutdownDuration duration | |
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) | |
-http.pathPrefix string | |
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 | |
-http.shutdownDelay duration | |
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 | |
-httpAuth.password value | |
Password for HTTP server's Basic Auth. The authentication is disabled if -httpAuth.username is empty | |
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 | |
-httpAuth.username string | |
Username for HTTP server's Basic Auth. The authentication is disabled if empty. See also -httpAuth.password | |
-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. | |
-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 10485760) | |
-influx.databaseNames array | |
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. | |
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces. | |
-influx.forceStreamMode | |
Force stream mode parsing for ingested data. See https://docs.victoriametrics.com/victoriametrics/integrations/influxdb/ | |
-influx.maxLineSize size | |
The maximum size in bytes for a single InfluxDB line during parsing. Applicable for stream mode only. See https://docs.victoriametrics.com/victoriametrics/integrations/influxdb/ | |
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 262144) | |
-influx.maxRequestSize size | |
The maximum size in bytes of a single InfluxDB request. Applicable for batch mode only. See https://docs.victoriametrics.com/victoriametrics/integrations/influxdb/ | |
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864) | |
-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://<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 | |
-influxMeasurementFieldSeparator string | |
Separator for '{measurement}{separator}{field_name}' metric name when inserted via InfluxDB line protocol (default "_") | |
-influxSkipMeasurement | |
Uses '{field_name}' as a metric name while ignoring '{measurement}' and '-influxMeasurementFieldSeparator' | |
-influxSkipSingleField | |
Uses '{measurement}' instead of '{measurement}{separator}{field_name}' for metric name if InfluxDB line contains only a single field | |
-influxTrimTimestamp duration | |
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) | |
-insert.maxQueueDuration duration | |
The maximum duration to wait in the queue when -maxConcurrentInserts concurrent insert requests are executed (default 1m0s) | |
-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 | |
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) | |
-license string | |
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 | |
-license.forceOffline | |
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 [email protected] if you need offline license verification. This flag is available only in Enterprise binaries | |
-licenseFile string | |
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 | |
-licenseFile.reloadInterval duration | |
Interval for reloading the license file specified via -licenseFile. See https://victoriametrics.com/products/enterprise/ . This flag is available only in Enterprise binaries (default 1h0m0s) | |
-loggerDisableTimestamps | |
Whether to disable writing timestamps in logs | |
-loggerErrorsPerSecondLimit int | |
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 | |
-loggerFormat string | |
Format for logs. Possible values: default, json (default "default") | |
-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 | |
-loggerLevel string | |
Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") | |
-loggerMaxArgLen int | |
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 5000) | |
-loggerOutput string | |
Output for the logs. Supported values: stderr, stdout (default "stderr") | |
-loggerTimezone string | |
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") | |
-loggerWarnsPerSecondLimit int | |
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 | |
-maxConcurrentInserts int | |
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 2*cgroup.AvailableCPUs()) | |
-maxInsertRequestSize size | |
The maximum size in bytes of a single Prometheus remote_write API request | |
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 33554432) | |
-maxLabelNameLen int | |
The maximum length of label name in the accepted time series. Series with longer label name are ignored. In this case the vm_rows_ignored_total{reason="too_long_label_name"} metric at /metrics page is incremented (default 256) | |
-maxLabelValueLen int | |
The maximum length of label values in the accepted time series. Series with longer label value are ignored. In this case the vm_rows_ignored_total{reason="too_long_label_value"} metric at /metrics page is incremented (default 4096) | |
-maxLabelsPerTimeseries int | |
The maximum number of labels per time series to be accepted. Series with superfluous labels are ignored. In this case the vm_rows_ignored_total{reason="too_many_labels"} metric at /metrics page is incremented (default 40) | |
-memory.allowedBytes size | |
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 | |
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0) | |
-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 the OS page cache which will result in higher disk IO usage (default 60) | |
-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 | |
-metricsAuthKey value | |
Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides -httpAuth.* | |
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 | |
-mtls array | |
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/victoriametrics/enterprise/ | |
Supports array of values separated by comma or specified via multiple flags. | |
Empty values are set to false. | |
-mtlsCAFile array | |
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/victoriametrics/enterprise/ | |
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. | |
-newrelic.maxInsertRequestSize size | |
The maximum size in bytes of a single NewRelic request to /newrelic/infra/v2/metrics/events/bulk | |
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864) | |
-opentelemetry.maxRequestSize size | |
The maximum size in bytes of a single OpenTelemetry request | |
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864) | |
-opentelemetry.usePrometheusNaming | |
Whether to convert metric names and labels into Prometheus-compatible format for the metrics ingested via OpenTelemetry protocol; see https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#sending-data-via-opentelemetry | |
-opentsdbHTTPListenAddr string | |
TCP address to listen for OpenTSDB 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 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 | |
-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 | |
The maximum size of OpenTSDB HTTP put request | |
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 33554432) | |
-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 value | |
Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides -httpAuth.* | |
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 | |
-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) | |
-pushmetrics.disableCompression | |
Whether to disable request body compression when pushing metrics to every -pushmetrics.url | |
-pushmetrics.extraLabel array | |
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. | |
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces. | |
-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 | |
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. | |
-pushmetrics.interval duration | |
Interval for pushing metrics to every -pushmetrics.url (default 10s) | |
-pushmetrics.url array | |
Optional URL to push metrics exposed at /metrics page. See https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#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. | |
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces. | |
-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/victoriametrics/single-server-victoriametrics/#relabeling for details. The config is reloaded on SIGHUP signal | |
-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 | |
-replicationFactor int | |
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) | |
-rpc.disableCompression | |
Whether to disable compression for the data sent from vminsert to vmstorage. This reduces CPU usage at the cost of higher network bandwidth usage | |
-rpc.handshakeTimeout duration | |
Timeout for RPC handshake between vminsert/vmselect and vmstorage. Increase this value if transient handshake failures occur. See https://docs.victoriametrics.com/victoriametrics/troubleshooting/#cluster-instability section for more details. (default 5s) | |
-search.denyPartialResponse | |
Whether to deny partial responses if a part of -storageNode instances fail to perform queries; this trades availability over consistency; see also -search.maxQueryDuration | |
-sortLabels | |
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 | |
-storageNode array | |
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/victoriametrics/cluster-victoriametrics/#automatic-vmstorage-discovery | |
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. | |
-storageNode.discoveryInterval duration | |
Interval for refreshing -storageNode list behind DNS SRV records. The minimum supported interval is 1s. See https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/#automatic-vmstorage-discovery . This flag is available only in VictoriaMetrics enterprise. See https://docs.victoriametrics.com/victoriametrics/enterprise/ (default 2s) | |
-storageNode.filter string | |
An optional regexp filter for discovered -storageNode addresses according to https://docs.victoriametrics.com/victoriametrics/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/victoriametrics/enterprise/ | |
-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. | |
-tlsAutocertCacheDir string | |
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/victoriametrics/enterprise/ | |
-tlsAutocertEmail string | |
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/victoriametrics/enterprise/ | |
-tlsAutocertHosts array | |
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/victoriametrics/enterprise/ | |
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. | |
-tlsCertFile array | |
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 | |
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. | |
-tlsCipherSuites array | |
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 | |
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. | |
-tlsKeyFile array | |
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 | |
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. | |
-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 | |
-version | |
Show VictoriaMetrics version | |
-vmstorageDialTimeout duration | |
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) | |
``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment