mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-23 12:31:07 +01:00
docs: sync -help output with the latest changes
This commit is contained in:
Aliaksandr Valialkin
parent
d3f13ab85b
commit
7a87251ff5
@ -2104,7 +2104,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li
|
|||||||
-promscrape.suppressScrapeErrorsDelay duration
|
-promscrape.suppressScrapeErrorsDelay duration
|
||||||
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
||||||
-promscrape.yandexcloudSDCheckInterval duration
|
-promscrape.yandexcloudSDCheckInterval duration
|
||||||
Interval for checking for changes in Yandex Cloud. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
Interval for checking for changes in Yandex Cloud API. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
||||||
-pushmetrics.extraLabel array
|
-pushmetrics.extraLabel array
|
||||||
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
||||||
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.
|
||||||
|
|||||||
@ -1055,7 +1055,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html .
|
|||||||
-promscrape.suppressScrapeErrorsDelay duration
|
-promscrape.suppressScrapeErrorsDelay duration
|
||||||
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
||||||
-promscrape.yandexcloudSDCheckInterval duration
|
-promscrape.yandexcloudSDCheckInterval duration
|
||||||
Interval for checking for changes in Yandex Cloud. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
Interval for checking for changes in Yandex Cloud API. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
||||||
-pushmetrics.extraLabel array
|
-pushmetrics.extraLabel array
|
||||||
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
||||||
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.
|
||||||
@ -1067,6 +1067,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html .
|
|||||||
-remoteWrite.aws.accessKey array
|
-remoteWrite.aws.accessKey array
|
||||||
Optional AWS AccessKey to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
Optional AWS AccessKey to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
||||||
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.
|
||||||
|
-remoteWrite.aws.ec2Endpoint array
|
||||||
|
Optional AWS EC2 API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
||||||
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-remoteWrite.aws.region array
|
-remoteWrite.aws.region array
|
||||||
Optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
Optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
||||||
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.
|
||||||
@ -1079,6 +1082,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html .
|
|||||||
-remoteWrite.aws.service array
|
-remoteWrite.aws.service array
|
||||||
Optional AWS Service to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set. Defaults to "aps"
|
Optional AWS Service to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set. Defaults to "aps"
|
||||||
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.
|
||||||
|
-remoteWrite.aws.stsEndpoint array
|
||||||
|
Optional AWS STS API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
||||||
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-remoteWrite.aws.useSigv4 array
|
-remoteWrite.aws.useSigv4 array
|
||||||
Enables SigV4 request signing for the corresponding -remoteWrite.url. It is expected that other -remoteWrite.aws.* command-line flags are set if sigv4 request signing is enabled
|
Enables SigV4 request signing for the corresponding -remoteWrite.url. It is expected that other -remoteWrite.aws.* command-line flags are set if sigv4 request signing is enabled
|
||||||
Supports array of values separated by comma or specified via multiple flags.
|
Supports array of values separated by comma or specified via multiple flags.
|
||||||
|
|||||||
@ -622,272 +622,333 @@ command-line flags with their descriptions.
|
|||||||
The shortlist of configuration flags is the following:
|
The shortlist of configuration flags is the following:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
-clusterMode
|
||||||
|
If clusterMode is enabled, then vmalert automatically adds the tenant specified in config groups to -datasource.url, -remoteWrite.url and -remoteRead.url. See https://docs.victoriametrics.com/vmalert.html#multitenancy
|
||||||
-configCheckInterval duration
|
-configCheckInterval duration
|
||||||
Interval for checking for changes in '-rule' or '-notifier.config' files. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes.
|
Interval for checking for changes in '-rule' or '-notifier.config' files. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes.
|
||||||
-datasource.appendTypePrefix
|
-datasource.appendTypePrefix
|
||||||
Whether to add type prefix to -datasource.url based on the query type. Set to true if sending different query types to the vmselect URL.
|
Whether to add type prefix to -datasource.url based on the query type. Set to true if sending different query types to the vmselect URL.
|
||||||
-datasource.basicAuth.password string
|
-datasource.basicAuth.password string
|
||||||
Optional basic auth password for -datasource.url
|
Optional basic auth password for -datasource.url
|
||||||
-datasource.basicAuth.passwordFile string
|
-datasource.basicAuth.passwordFile string
|
||||||
Optional path to basic auth password to use for -datasource.url
|
Optional path to basic auth password to use for -datasource.url
|
||||||
-datasource.basicAuth.username string
|
-datasource.basicAuth.username string
|
||||||
Optional basic auth username for -datasource.url
|
Optional basic auth username for -datasource.url
|
||||||
-datasource.bearerToken string
|
-datasource.bearerToken string
|
||||||
Optional bearer auth token to use for -datasource.url.
|
Optional bearer auth token to use for -datasource.url.
|
||||||
-datasource.bearerTokenFile string
|
-datasource.bearerTokenFile string
|
||||||
Optional path to bearer token file to use for -datasource.url.
|
Optional path to bearer token file to use for -datasource.url.
|
||||||
-datasource.disableKeepAlive
|
-datasource.disableKeepAlive
|
||||||
Whether to disable long-lived connections to the datasource. If true, disables HTTP keep-alives and will only use the connection to the server for a single HTTP request.
|
Whether to disable long-lived connections to the datasource. If true, disables HTTP keep-alives and will only use the connection to the server for a single HTTP request.
|
||||||
-datasource.headers string
|
-datasource.headers string
|
||||||
Optional HTTP extraHeaders to send with each request to the corresponding -datasource.url. For example, -datasource.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -datasource.url. Multiple headers must be delimited by '^^': -datasource.headers='header1:value1^^header2:value2'
|
Optional HTTP extraHeaders to send with each request to the corresponding -datasource.url. For example, -datasource.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -datasource.url. Multiple headers must be delimited by '^^': -datasource.headers='header1:value1^^header2:value2'
|
||||||
-datasource.lookback duration
|
-datasource.lookback duration
|
||||||
Lookback defines how far into the past to look when evaluating queries. For example, if the datasource.lookback=5m then param "time" with value now()-5m will be added to every query.
|
Lookback defines how far into the past to look when evaluating queries. For example, if the datasource.lookback=5m then param "time" with value now()-5m will be added to every query.
|
||||||
-datasource.maxIdleConnections int
|
-datasource.maxIdleConnections int
|
||||||
Defines the number of idle (keep-alive connections) to each configured datasource. Consider setting this value equal to the value: groups_total * group.concurrency. Too low a value may result in a high number of sockets in TIME_WAIT state. (default 100)
|
Defines the number of idle (keep-alive connections) to each configured datasource. Consider setting this value equal to the value: groups_total * group.concurrency. Too low a value may result in a high number of sockets in TIME_WAIT state. (default 100)
|
||||||
-datasource.oauth2.clientID string
|
-datasource.oauth2.clientID string
|
||||||
Optional OAuth2 clientID to use for -datasource.url.
|
Optional OAuth2 clientID to use for -datasource.url.
|
||||||
-datasource.oauth2.clientSecret string
|
-datasource.oauth2.clientSecret string
|
||||||
Optional OAuth2 clientSecret to use for -datasource.url.
|
Optional OAuth2 clientSecret to use for -datasource.url.
|
||||||
-datasource.oauth2.clientSecretFile string
|
-datasource.oauth2.clientSecretFile string
|
||||||
Optional OAuth2 clientSecretFile to use for -datasource.url.
|
Optional OAuth2 clientSecretFile to use for -datasource.url.
|
||||||
-datasource.oauth2.scopes string
|
-datasource.oauth2.scopes string
|
||||||
Optional OAuth2 scopes to use for -datasource.url. Scopes must be delimited by ';'
|
Optional OAuth2 scopes to use for -datasource.url. Scopes must be delimited by ';'
|
||||||
-datasource.oauth2.tokenUrl string
|
-datasource.oauth2.tokenUrl string
|
||||||
Optional OAuth2 tokenURL to use for -datasource.url.
|
Optional OAuth2 tokenURL to use for -datasource.url.
|
||||||
-datasource.queryStep duration
|
-datasource.queryStep duration
|
||||||
queryStep defines how far a value can fallback to when evaluating queries. For example, if datasource.queryStep=15s then param "step" with value "15s" will be added to every query.If queryStep isn't specified, rule's evaluationInterval will be used instead.
|
queryStep defines how far a value can fallback to when evaluating queries. For example, if datasource.queryStep=15s then param "step" with value "15s" will be added to every query.If queryStep isn't specified, rule's evaluationInterval will be used instead.
|
||||||
-datasource.queryTimeAlignment
|
-datasource.queryTimeAlignment
|
||||||
Whether to align "time" parameter with evaluation interval.Alignment supposed to produce deterministic results despite of number of vmalert replicas or time they were started. See more details here https://github.com/VictoriaMetrics/VictoriaMetrics/pull/1257 (default true)
|
Whether to align "time" parameter with evaluation interval.Alignment supposed to produce deterministic results despite of number of vmalert replicas or time they were started. See more details here https://github.com/VictoriaMetrics/VictoriaMetrics/pull/1257 (default true)
|
||||||
-datasource.roundDigits int
|
-datasource.roundDigits int
|
||||||
Adds "round_digits" GET param to datasource requests. In VM "round_digits" limits the number of digits after the decimal point in response values.
|
Adds "round_digits" GET param to datasource requests. In VM "round_digits" limits the number of digits after the decimal point in response values.
|
||||||
-datasource.tlsCAFile string
|
-datasource.tlsCAFile string
|
||||||
Optional path to TLS CA file to use for verifying connections to -datasource.url. By default, system CA is used
|
Optional path to TLS CA file to use for verifying connections to -datasource.url. By default, system CA is used
|
||||||
-datasource.tlsCertFile string
|
-datasource.tlsCertFile string
|
||||||
Optional path to client-side TLS certificate file to use when connecting to -datasource.url
|
Optional path to client-side TLS certificate file to use when connecting to -datasource.url
|
||||||
-datasource.tlsInsecureSkipVerify
|
-datasource.tlsInsecureSkipVerify
|
||||||
Whether to skip tls verification when connecting to -datasource.url
|
Whether to skip tls verification when connecting to -datasource.url
|
||||||
-datasource.tlsKeyFile string
|
-datasource.tlsKeyFile string
|
||||||
Optional path to client-side TLS certificate key to use when connecting to -datasource.url
|
Optional path to client-side TLS certificate key to use when connecting to -datasource.url
|
||||||
-datasource.tlsServerName string
|
-datasource.tlsServerName string
|
||||||
Optional TLS server name to use for connections to -datasource.url. By default, the server name from -datasource.url is used
|
Optional TLS server name to use for connections to -datasource.url. By default, the server name from -datasource.url is used
|
||||||
-datasource.url string
|
-datasource.url string
|
||||||
Datasource compatible with Prometheus HTTP API. It can be single node VictoriaMetrics or vmselect URL. Required parameter. E.g. http://127.0.0.1:8428 . See also -remoteRead.disablePathAppend
|
Datasource compatible with Prometheus HTTP API. It can be single node VictoriaMetrics or vmselect URL. Required parameter. E.g. http://127.0.0.1:8428 . See also -remoteRead.disablePathAppend
|
||||||
|
-defaultTenant.graphite string
|
||||||
|
Default tenant for Graphite alerting groups. See https://docs.victoriametrics.com/vmalert.html#multitenancy
|
||||||
|
-defaultTenant.prometheus string
|
||||||
|
Default tenant for Prometheus alerting groups. See https://docs.victoriametrics.com/vmalert.html#multitenancy
|
||||||
-disableAlertgroupLabel
|
-disableAlertgroupLabel
|
||||||
Whether to disable adding group's Name as label to generated alerts and time series.
|
Whether to disable adding group's Name as label to generated alerts and time series.
|
||||||
-dryRun -rule
|
-dryRun -rule
|
||||||
Whether to check only config files without running vmalert. The rules file are validated. The -rule flag must be specified.
|
Whether to check only config files without running vmalert. The rules file are validated. The -rule flag must be specified.
|
||||||
-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
|
||||||
Whether to enable reading flags from environment variables additionally to command line. Command line flag values have priority over values from environment vars. Flags are read only from command line if this flag isn't set. See https://docs.victoriametrics.com/#environment-variables for more details
|
Whether to enable reading flags from environment variables additionally to command line. Command line flag values have priority over values from environment vars. Flags are read only from command line if this flag isn't set. See https://docs.victoriametrics.com/#environment-variables for more details
|
||||||
-envflag.prefix string
|
-envflag.prefix string
|
||||||
Prefix for environment variables if -envflag.enable is set
|
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
|
||||||
-evaluationInterval duration
|
-evaluationInterval duration
|
||||||
How often to evaluate the rules (default 1m0s)
|
How often to evaluate the rules (default 1m0s)
|
||||||
-external.alert.source string
|
-external.alert.source string
|
||||||
External Alert Source allows to override the Source link for alerts sent to AlertManager for cases where you want to build a custom link to Grafana, Prometheus or any other service.
|
External Alert Source allows to override the Source link for alerts sent to AlertManager for cases where you want to build a custom link to Grafana, Prometheus or any other service.
|
||||||
eg. 'explore?orgId=1&left=[\"now-1h\",\"now\",\"VictoriaMetrics\",{\"expr\": \"{{$expr|quotesEscape|crlfEscape|queryEscape}}\"},{\"mode\":\"Metrics\"},{\"ui\":[true,true,true,\"none\"]}]'.If empty '/vmalert/api/v1/alert?group_id=&alert_id=' is used
|
eg. 'explore?orgId=1&left=[\"now-1h\",\"now\",\"VictoriaMetrics\",{\"expr\": \"{{$expr|quotesEscape|crlfEscape|queryEscape}}\"},{\"mode\":\"Metrics\"},{\"ui\":[true,true,true,\"none\"]}]'.If empty '/vmalert/api/v1/alert?group_id=&alert_id=' is used
|
||||||
-external.label array
|
-external.label array
|
||||||
Optional label in the form 'Name=value' to add to all generated recording rules and alerts. Pass multiple -label flags in order to add multiple label sets.
|
Optional label in the form 'Name=value' to add to all generated recording rules and alerts. Pass multiple -label flags in order to add multiple label sets.
|
||||||
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.
|
||||||
-external.url string
|
-external.url string
|
||||||
External URL is used as alert's source for sent alerts to the notifier
|
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
|
||||||
|
Incoming http connections are closed after the configured timeout. This may help to spread the incoming load among a cluster of services behind a load balancer. Please note that the real timeout may be bigger by up to 10% as a protection against the thundering herd problem (default 2m0s)
|
||||||
|
-http.disableResponseCompression
|
||||||
|
Disable compression of HTTP responses to save CPU resources. By default compression is enabled to save network bandwidth
|
||||||
|
-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 string
|
-httpAuth.password string
|
||||||
Password for HTTP Basic Auth. The authentication is disabled if -httpAuth.username is empty
|
Password for HTTP Basic Auth. The authentication is disabled if -httpAuth.username is empty
|
||||||
-httpAuth.username string
|
-httpAuth.username string
|
||||||
Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
|
Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
|
||||||
-httpListenAddr string
|
-httpListenAddr string
|
||||||
Address to listen for http connections (default ":8880")
|
Address to listen for http connections (default ":8880")
|
||||||
|
-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")
|
||||||
|
-loggerLevel string
|
||||||
|
Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO")
|
||||||
|
-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
|
||||||
|
-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 OS page cache resulting in higher disk IO usage
|
||||||
|
Supports the following optional suffixes for size values: KB, MB, GB, KiB, MiB, GiB (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 OS page cache which will result in higher disk IO usage (default 60)
|
||||||
-metricsAuthKey string
|
-metricsAuthKey string
|
||||||
Auth key for /metrics endpoint. 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
|
-notifier.basicAuth.password array
|
||||||
Optional basic auth password for -notifier.url
|
Optional basic auth password for -notifier.url
|
||||||
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.
|
||||||
-notifier.basicAuth.passwordFile array
|
-notifier.basicAuth.passwordFile array
|
||||||
Optional path to basic auth password file for -notifier.url
|
Optional path to basic auth password file for -notifier.url
|
||||||
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.
|
||||||
-notifier.basicAuth.username array
|
-notifier.basicAuth.username array
|
||||||
Optional basic auth username for -notifier.url
|
Optional basic auth username for -notifier.url
|
||||||
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.
|
||||||
-notifier.bearerToken array
|
-notifier.bearerToken array
|
||||||
Optional bearer token for -notifier.url
|
Optional bearer token for -notifier.url
|
||||||
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.
|
||||||
-notifier.bearerTokenFile array
|
-notifier.bearerTokenFile array
|
||||||
Optional path to bearer token file for -notifier.url
|
Optional path to bearer token file for -notifier.url
|
||||||
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.
|
||||||
-notifier.config string
|
-notifier.config string
|
||||||
Path to configuration file for notifiers
|
Path to configuration file for notifiers
|
||||||
-notifier.oauth2.clientID array
|
-notifier.oauth2.clientID array
|
||||||
Optional OAuth2 clientID to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 clientID to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.oauth2.clientSecret array
|
-notifier.oauth2.clientSecret array
|
||||||
Optional OAuth2 clientSecret to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 clientSecret to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.oauth2.clientSecretFile array
|
-notifier.oauth2.clientSecretFile array
|
||||||
Optional OAuth2 clientSecretFile to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 clientSecretFile to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.oauth2.scopes array
|
-notifier.oauth2.scopes array
|
||||||
Optional OAuth2 scopes to use for -notifier.url. Scopes must be delimited by ';'. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 scopes to use for -notifier.url. Scopes must be delimited by ';'. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.oauth2.tokenUrl array
|
-notifier.oauth2.tokenUrl array
|
||||||
Optional OAuth2 tokenURL to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 tokenURL to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.suppressDuplicateTargetErrors
|
-notifier.suppressDuplicateTargetErrors
|
||||||
Whether to suppress 'duplicate target' errors during discovery
|
Whether to suppress 'duplicate target' errors during discovery
|
||||||
-notifier.tlsCAFile array
|
-notifier.tlsCAFile array
|
||||||
Optional path to TLS CA file to use for verifying connections to -notifier.url. By default system CA is used
|
Optional path to TLS CA file to use for verifying connections to -notifier.url. By default system CA is used
|
||||||
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.
|
||||||
-notifier.tlsCertFile array
|
-notifier.tlsCertFile array
|
||||||
Optional path to client-side TLS certificate file to use when connecting to -notifier.url
|
Optional path to client-side TLS certificate file to use when connecting to -notifier.url
|
||||||
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.
|
||||||
-notifier.tlsInsecureSkipVerify array
|
-notifier.tlsInsecureSkipVerify array
|
||||||
Whether to skip tls verification when connecting to -notifier.url
|
Whether to skip tls verification when connecting to -notifier.url
|
||||||
Supports array of values separated by comma or specified via multiple flags.
|
Supports array of values separated by comma or specified via multiple flags.
|
||||||
-notifier.tlsKeyFile array
|
-notifier.tlsKeyFile array
|
||||||
Optional path to client-side TLS certificate key to use when connecting to -notifier.url
|
Optional path to client-side TLS certificate key to use when connecting to -notifier.url
|
||||||
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.
|
||||||
-notifier.tlsServerName array
|
-notifier.tlsServerName array
|
||||||
Optional TLS server name to use for connections to -notifier.url. By default the server name from -notifier.url is used
|
Optional TLS server name to use for connections to -notifier.url. By default the server name from -notifier.url is used
|
||||||
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.
|
||||||
-notifier.url array
|
-notifier.url array
|
||||||
Prometheus alertmanager URL, e.g. http://127.0.0.1:9093
|
Prometheus alertmanager URL, e.g. http://127.0.0.1:9093
|
||||||
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.
|
||||||
-pprofAuthKey string
|
-pprofAuthKey string
|
||||||
Auth key for /debug/pprof/* endpoints. 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
|
||||||
|
Interval for checking for changes in Consul. This works only if consul_sd_configs is configured in '-promscrape.config' file. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config for details (default 30s)
|
||||||
|
-promscrape.discovery.concurrency int
|
||||||
|
The maximum number of concurrent requests to Prometheus autodiscovery API (Consul, Kubernetes, etc.) (default 100)
|
||||||
|
-promscrape.discovery.concurrentWaitTime duration
|
||||||
|
The maximum duration for waiting to perform API requests if more than -promscrape.discovery.concurrency requests are simultaneously performed (default 1m0s)
|
||||||
|
-promscrape.dnsSDCheckInterval duration
|
||||||
|
Interval for checking for changes in dns. This works only if dns_sd_configs is configured in '-promscrape.config' file. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dns_sd_config for details (default 30s)
|
||||||
|
-pushmetrics.extraLabel array
|
||||||
|
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
||||||
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
|
-pushmetrics.interval duration
|
||||||
|
Interval for pushing metrics to -pushmetrics.url (default 10s)
|
||||||
|
-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
|
||||||
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-remoteRead.basicAuth.password string
|
-remoteRead.basicAuth.password string
|
||||||
Optional basic auth password for -remoteRead.url
|
Optional basic auth password for -remoteRead.url
|
||||||
-remoteRead.basicAuth.passwordFile string
|
-remoteRead.basicAuth.passwordFile string
|
||||||
Optional path to basic auth password to use for -remoteRead.url
|
Optional path to basic auth password to use for -remoteRead.url
|
||||||
-remoteRead.basicAuth.username string
|
-remoteRead.basicAuth.username string
|
||||||
Optional basic auth username for -remoteRead.url
|
Optional basic auth username for -remoteRead.url
|
||||||
-remoteRead.bearerToken string
|
-remoteRead.bearerToken string
|
||||||
Optional bearer auth token to use for -remoteRead.url.
|
Optional bearer auth token to use for -remoteRead.url.
|
||||||
-remoteRead.bearerTokenFile string
|
-remoteRead.bearerTokenFile string
|
||||||
Optional path to bearer token file to use for -remoteRead.url.
|
Optional path to bearer token file to use for -remoteRead.url.
|
||||||
-remoteRead.disablePathAppend
|
-remoteRead.disablePathAppend
|
||||||
Whether to disable automatic appending of '/api/v1/query' path to the configured -datasource.url and -remoteRead.url
|
Whether to disable automatic appending of '/api/v1/query' path to the configured -datasource.url and -remoteRead.url
|
||||||
-remoteRead.headers string
|
-remoteRead.headers string
|
||||||
Optional HTTP headers to send with each request to the corresponding -remoteRead.url. For example, -remoteRead.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -remoteRead.url. Multiple headers must be delimited by '^^': -remoteRead.headers='header1:value1^^header2:value2'
|
Optional HTTP headers to send with each request to the corresponding -remoteRead.url. For example, -remoteRead.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -remoteRead.url. Multiple headers must be delimited by '^^': -remoteRead.headers='header1:value1^^header2:value2'
|
||||||
-remoteRead.ignoreRestoreErrors
|
-remoteRead.ignoreRestoreErrors
|
||||||
Whether to ignore errors from remote storage when restoring alerts state on startup. (default true)
|
Whether to ignore errors from remote storage when restoring alerts state on startup. (default true)
|
||||||
-remoteRead.lookback duration
|
-remoteRead.lookback duration
|
||||||
Lookback defines how far to look into past for alerts timeseries. For example, if lookback=1h then range from now() to now()-1h will be scanned. (default 1h0m0s)
|
Lookback defines how far to look into past for alerts timeseries. For example, if lookback=1h then range from now() to now()-1h will be scanned. (default 1h0m0s)
|
||||||
-remoteRead.oauth2.clientID string
|
-remoteRead.oauth2.clientID string
|
||||||
Optional OAuth2 clientID to use for -remoteRead.url.
|
Optional OAuth2 clientID to use for -remoteRead.url.
|
||||||
-remoteRead.oauth2.clientSecret string
|
-remoteRead.oauth2.clientSecret string
|
||||||
Optional OAuth2 clientSecret to use for -remoteRead.url.
|
Optional OAuth2 clientSecret to use for -remoteRead.url.
|
||||||
-remoteRead.oauth2.clientSecretFile string
|
-remoteRead.oauth2.clientSecretFile string
|
||||||
Optional OAuth2 clientSecretFile to use for -remoteRead.url.
|
Optional OAuth2 clientSecretFile to use for -remoteRead.url.
|
||||||
-remoteRead.oauth2.scopes string
|
-remoteRead.oauth2.scopes string
|
||||||
Optional OAuth2 scopes to use for -remoteRead.url. Scopes must be delimited by ';'.
|
Optional OAuth2 scopes to use for -remoteRead.url. Scopes must be delimited by ';'.
|
||||||
-remoteRead.oauth2.tokenUrl string
|
-remoteRead.oauth2.tokenUrl string
|
||||||
Optional OAuth2 tokenURL to use for -remoteRead.url.
|
Optional OAuth2 tokenURL to use for -remoteRead.url.
|
||||||
-remoteRead.tlsCAFile string
|
-remoteRead.tlsCAFile string
|
||||||
Optional path to TLS CA file to use for verifying connections to -remoteRead.url. By default system CA is used
|
Optional path to TLS CA file to use for verifying connections to -remoteRead.url. By default system CA is used
|
||||||
-remoteRead.tlsCertFile string
|
-remoteRead.tlsCertFile string
|
||||||
Optional path to client-side TLS certificate file to use when connecting to -remoteRead.url
|
Optional path to client-side TLS certificate file to use when connecting to -remoteRead.url
|
||||||
-remoteRead.tlsInsecureSkipVerify
|
-remoteRead.tlsInsecureSkipVerify
|
||||||
Whether to skip tls verification when connecting to -remoteRead.url
|
Whether to skip tls verification when connecting to -remoteRead.url
|
||||||
-remoteRead.tlsKeyFile string
|
-remoteRead.tlsKeyFile string
|
||||||
Optional path to client-side TLS certificate key to use when connecting to -remoteRead.url
|
Optional path to client-side TLS certificate key to use when connecting to -remoteRead.url
|
||||||
-remoteRead.tlsServerName string
|
-remoteRead.tlsServerName string
|
||||||
Optional TLS server name to use for connections to -remoteRead.url. By default the server name from -remoteRead.url is used
|
Optional TLS server name to use for connections to -remoteRead.url. By default the server name from -remoteRead.url is used
|
||||||
-remoteRead.url vmalert
|
-remoteRead.url vmalert
|
||||||
Optional URL to datasource compatible with Prometheus HTTP API. It can be single node VictoriaMetrics or vmselect.Remote read is used to restore alerts state.This configuration makes sense only if vmalert was configured with `remoteWrite.url` before and has been successfully persisted its state. E.g. http://127.0.0.1:8428. See also -remoteRead.disablePathAppend
|
Optional URL to datasource compatible with Prometheus HTTP API. It can be single node VictoriaMetrics or vmselect.Remote read is used to restore alerts state.This configuration makes sense only if vmalert was configured with `remoteWrite.url` before and has been successfully persisted its state. E.g. http://127.0.0.1:8428. See also -remoteRead.disablePathAppend
|
||||||
-remoteWrite.basicAuth.password string
|
-remoteWrite.basicAuth.password string
|
||||||
Optional basic auth password for -remoteWrite.url
|
Optional basic auth password for -remoteWrite.url
|
||||||
-remoteWrite.basicAuth.passwordFile string
|
-remoteWrite.basicAuth.passwordFile string
|
||||||
Optional path to basic auth password to use for -remoteWrite.url
|
Optional path to basic auth password to use for -remoteWrite.url
|
||||||
-remoteWrite.basicAuth.username string
|
-remoteWrite.basicAuth.username string
|
||||||
Optional basic auth username for -remoteWrite.url
|
Optional basic auth username for -remoteWrite.url
|
||||||
-remoteWrite.bearerToken string
|
-remoteWrite.bearerToken string
|
||||||
Optional bearer auth token to use for -remoteWrite.url.
|
Optional bearer auth token to use for -remoteWrite.url.
|
||||||
-remoteWrite.bearerTokenFile string
|
-remoteWrite.bearerTokenFile string
|
||||||
Optional path to bearer token file to use for -remoteWrite.url.
|
Optional path to bearer token file to use for -remoteWrite.url.
|
||||||
-remoteWrite.concurrency int
|
-remoteWrite.concurrency int
|
||||||
Defines number of writers for concurrent writing into remote querier (default 1)
|
Defines number of writers for concurrent writing into remote querier (default 1)
|
||||||
-remoteWrite.disablePathAppend
|
-remoteWrite.disablePathAppend
|
||||||
Whether to disable automatic appending of '/api/v1/write' path to the configured -remoteWrite.url.
|
Whether to disable automatic appending of '/api/v1/write' path to the configured -remoteWrite.url.
|
||||||
-remoteWrite.flushInterval duration
|
-remoteWrite.flushInterval duration
|
||||||
Defines interval of flushes to remote write endpoint (default 5s)
|
Defines interval of flushes to remote write endpoint (default 5s)
|
||||||
-remoteWrite.headers string
|
-remoteWrite.headers string
|
||||||
Optional HTTP headers to send with each request to the corresponding -remoteWrite.url. For example, -remoteWrite.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -remoteWrite.url. Multiple headers must be delimited by '^^': -remoteWrite.headers='header1:value1^^header2:value2'
|
Optional HTTP headers to send with each request to the corresponding -remoteWrite.url. For example, -remoteWrite.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -remoteWrite.url. Multiple headers must be delimited by '^^': -remoteWrite.headers='header1:value1^^header2:value2'
|
||||||
-remoteWrite.maxBatchSize int
|
-remoteWrite.maxBatchSize int
|
||||||
Defines defines max number of timeseries to be flushed at once (default 1000)
|
Defines defines max number of timeseries to be flushed at once (default 1000)
|
||||||
-remoteWrite.maxQueueSize int
|
-remoteWrite.maxQueueSize int
|
||||||
Defines the max number of pending datapoints to remote write endpoint (default 100000)
|
Defines the max number of pending datapoints to remote write endpoint (default 100000)
|
||||||
-remoteWrite.oauth2.clientID string
|
-remoteWrite.oauth2.clientID string
|
||||||
Optional OAuth2 clientID to use for -remoteWrite.url.
|
Optional OAuth2 clientID to use for -remoteWrite.url.
|
||||||
-remoteWrite.oauth2.clientSecret string
|
-remoteWrite.oauth2.clientSecret string
|
||||||
Optional OAuth2 clientSecret to use for -remoteWrite.url.
|
Optional OAuth2 clientSecret to use for -remoteWrite.url.
|
||||||
-remoteWrite.oauth2.clientSecretFile string
|
-remoteWrite.oauth2.clientSecretFile string
|
||||||
Optional OAuth2 clientSecretFile to use for -remoteWrite.url.
|
Optional OAuth2 clientSecretFile to use for -remoteWrite.url.
|
||||||
-remoteWrite.oauth2.scopes string
|
-remoteWrite.oauth2.scopes string
|
||||||
Optional OAuth2 scopes to use for -notifier.url. Scopes must be delimited by ';'.
|
Optional OAuth2 scopes to use for -notifier.url. Scopes must be delimited by ';'.
|
||||||
-remoteWrite.oauth2.tokenUrl string
|
-remoteWrite.oauth2.tokenUrl string
|
||||||
Optional OAuth2 tokenURL to use for -notifier.url.
|
Optional OAuth2 tokenURL to use for -notifier.url.
|
||||||
-remoteWrite.tlsCAFile string
|
-remoteWrite.tlsCAFile string
|
||||||
Optional path to TLS CA file to use for verifying connections to -remoteWrite.url. By default system CA is used
|
Optional path to TLS CA file to use for verifying connections to -remoteWrite.url. By default system CA is used
|
||||||
-remoteWrite.tlsCertFile string
|
-remoteWrite.tlsCertFile string
|
||||||
Optional path to client-side TLS certificate file to use when connecting to -remoteWrite.url
|
Optional path to client-side TLS certificate file to use when connecting to -remoteWrite.url
|
||||||
-remoteWrite.tlsInsecureSkipVerify
|
-remoteWrite.tlsInsecureSkipVerify
|
||||||
Whether to skip tls verification when connecting to -remoteWrite.url
|
Whether to skip tls verification when connecting to -remoteWrite.url
|
||||||
-remoteWrite.tlsKeyFile string
|
-remoteWrite.tlsKeyFile string
|
||||||
Optional path to client-side TLS certificate key to use when connecting to -remoteWrite.url
|
Optional path to client-side TLS certificate key to use when connecting to -remoteWrite.url
|
||||||
-remoteWrite.tlsServerName string
|
-remoteWrite.tlsServerName string
|
||||||
Optional TLS server name to use for connections to -remoteWrite.url. By default the server name from -remoteWrite.url is used
|
Optional TLS server name to use for connections to -remoteWrite.url. By default the server name from -remoteWrite.url is used
|
||||||
-remoteWrite.url string
|
-remoteWrite.url string
|
||||||
Optional URL to VictoriaMetrics or vminsert where to persist alerts state and recording rules results in form of timeseries. For example, if -remoteWrite.url=http://127.0.0.1:8428 is specified, then the alerts state will be written to http://127.0.0.1:8428/api/v1/write . See also -remoteWrite.disablePathAppend
|
Optional URL to VictoriaMetrics or vminsert where to persist alerts state and recording rules results in form of timeseries. For example, if -remoteWrite.url=http://127.0.0.1:8428 is specified, then the alerts state will be written to http://127.0.0.1:8428/api/v1/write . See also -remoteWrite.disablePathAppend
|
||||||
-replay.disableProgressBar
|
-replay.disableProgressBar
|
||||||
Whether to disable rendering progress bars during the replay. Progress bar rendering might be verbose or break the logs parsing, so it is recommended to be disabled when not used in interactive mode.
|
Whether to disable rendering progress bars during the replay. Progress bar rendering might be verbose or break the logs parsing, so it is recommended to be disabled when not used in interactive mode.
|
||||||
-replay.maxDatapointsPerQuery int
|
-replay.maxDatapointsPerQuery int
|
||||||
Max number of data points expected in one request. The higher the value, the less requests will be made during replay. (default 1000)
|
Max number of data points expected in one request. The higher the value, the less requests will be made during replay. (default 1000)
|
||||||
-replay.ruleRetryAttempts int
|
-replay.ruleRetryAttempts int
|
||||||
Defines how many retries to make before giving up on rule if request for it returns an error. (default 5)
|
Defines how many retries to make before giving up on rule if request for it returns an error. (default 5)
|
||||||
-replay.rulesDelay duration
|
-replay.rulesDelay duration
|
||||||
Delay between rules evaluation within the group. Could be important if there are chained rules inside of the groupand processing need to wait for previous rule results to be persisted by remote storage before evaluating the next rule.Keep it equal or bigger than -remoteWrite.flushInterval. (default 1s)
|
Delay between rules evaluation within the group. Could be important if there are chained rules inside of the groupand processing need to wait for previous rule results to be persisted by remote storage before evaluating the next rule.Keep it equal or bigger than -remoteWrite.flushInterval. (default 1s)
|
||||||
-replay.timeFrom string
|
-replay.timeFrom string
|
||||||
The time filter in RFC3339 format to select time series with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'
|
The time filter in RFC3339 format to select time series with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'
|
||||||
-replay.timeTo string
|
-replay.timeTo string
|
||||||
The time filter in RFC3339 format to select timeseries with timestamp equal or lower than provided value. E.g. '2020-01-01T20:07:00Z'
|
The time filter in RFC3339 format to select timeseries with timestamp equal or lower than provided value. E.g. '2020-01-01T20:07:00Z'
|
||||||
-rule array
|
-rule array
|
||||||
Path to the file with alert rules.
|
Path to the file with alert rules.
|
||||||
Supports patterns. Flag can be specified multiple times.
|
Supports patterns. Flag can be specified multiple times.
|
||||||
Examples:
|
Examples:
|
||||||
-rule="/path/to/file". Path to a single file with alerting rules
|
-rule="/path/to/file". Path to a single file with alerting rules
|
||||||
-rule="dir/*.yaml" -rule="/*.yaml". Relative path to all .yaml files in "dir" folder,
|
-rule="dir/*.yaml" -rule="/*.yaml". Relative path to all .yaml files in "dir" folder,
|
||||||
absolute path to all .yaml files in root.
|
absolute path to all .yaml files in root.
|
||||||
Rule files may contain %{ENV_VAR} placeholders, which are substituted by the corresponding env vars.
|
Rule files may contain %{ENV_VAR} placeholders, which are substituted by the corresponding env vars.
|
||||||
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.
|
||||||
-rule.configCheckInterval duration
|
-rule.configCheckInterval duration
|
||||||
Interval for checking for changes in '-rule' files. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes. DEPRECATED - see '-configCheckInterval' instead
|
Interval for checking for changes in '-rule' files. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes. DEPRECATED - see '-configCheckInterval' instead
|
||||||
-rule.maxResolveDuration duration
|
-rule.maxResolveDuration duration
|
||||||
Limits the maximum duration for automatic alert expiration, which is by default equal to 3 evaluation intervals of the parent group.
|
Limits the maximum duration for automatic alert expiration, which is by default equal to 3 evaluation intervals of the parent group.
|
||||||
-rule.resendDelay duration
|
-rule.resendDelay duration
|
||||||
Minimum amount of time to wait before resending an alert to notifier
|
Minimum amount of time to wait before resending an alert to notifier
|
||||||
-rule.templates array
|
-rule.templates array
|
||||||
Path or glob pattern to location with go template definitions
|
Path or glob pattern to location with go template definitions
|
||||||
for rules annotations templating. Flag can be specified multiple times.
|
for rules annotations templating. Flag can be specified multiple times.
|
||||||
Examples:
|
Examples:
|
||||||
-rule.templates="/path/to/file". Path to a single file with go templates
|
-rule.templates="/path/to/file". Path to a single file with go templates
|
||||||
-rule.templates="dir/*.tpl" -rule.templates="/*.tpl". Relative path to all .tpl files in "dir" folder,
|
-rule.templates="dir/*.tpl" -rule.templates="/*.tpl". Relative path to all .tpl files in "dir" folder,
|
||||||
absolute path to all .tpl files in root.
|
absolute path to all .tpl files in root.
|
||||||
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.
|
||||||
-rule.validateExpressions
|
-rule.validateExpressions
|
||||||
Whether to validate rules expressions via MetricsQL engine (default true)
|
Whether to validate rules expressions via MetricsQL engine (default true)
|
||||||
-rule.validateTemplates
|
-rule.validateTemplates
|
||||||
Whether to validate annotation and label templates (default true)
|
Whether to validate annotation and label templates (default true)
|
||||||
-tls
|
-tls
|
||||||
Whether to enable TLS for incoming HTTP requests at -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set
|
Whether to enable TLS for incoming HTTP requests at -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set
|
||||||
-tlsCertFile string
|
-tlsCertFile string
|
||||||
Path to file with TLS certificate 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
|
Path to file with TLS certificate 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
|
||||||
-tlsCipherSuites array
|
-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
|
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.
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-tlsKeyFile string
|
-tlsKeyFile string
|
||||||
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
|
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
|
-version
|
||||||
Show VictoriaMetrics version
|
Show VictoriaMetrics version
|
||||||
```
|
```
|
||||||
|
|
||||||
### Hot config reload
|
### Hot config reload
|
||||||
|
|||||||
@ -2104,7 +2104,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li
|
|||||||
-promscrape.suppressScrapeErrorsDelay duration
|
-promscrape.suppressScrapeErrorsDelay duration
|
||||||
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
||||||
-promscrape.yandexcloudSDCheckInterval duration
|
-promscrape.yandexcloudSDCheckInterval duration
|
||||||
Interval for checking for changes in Yandex Cloud. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
Interval for checking for changes in Yandex Cloud API. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
||||||
-pushmetrics.extraLabel array
|
-pushmetrics.extraLabel array
|
||||||
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
||||||
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.
|
||||||
|
|||||||
@ -2108,7 +2108,7 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li
|
|||||||
-promscrape.suppressScrapeErrorsDelay duration
|
-promscrape.suppressScrapeErrorsDelay duration
|
||||||
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
||||||
-promscrape.yandexcloudSDCheckInterval duration
|
-promscrape.yandexcloudSDCheckInterval duration
|
||||||
Interval for checking for changes in Yandex Cloud. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
Interval for checking for changes in Yandex Cloud API. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
||||||
-pushmetrics.extraLabel array
|
-pushmetrics.extraLabel array
|
||||||
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
||||||
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.
|
||||||
|
|||||||
@ -1059,7 +1059,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html .
|
|||||||
-promscrape.suppressScrapeErrorsDelay duration
|
-promscrape.suppressScrapeErrorsDelay duration
|
||||||
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
The delay for suppressing repeated scrape errors logging per each scrape targets. This may be used for reducing the number of log lines related to scrape errors. See also -promscrape.suppressScrapeErrors
|
||||||
-promscrape.yandexcloudSDCheckInterval duration
|
-promscrape.yandexcloudSDCheckInterval duration
|
||||||
Interval for checking for changes in Yandex Cloud. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
Interval for checking for changes in Yandex Cloud API. This works only if yandexcloud_sd_configs is configured in '-promscrape.config' file. (default 30s)
|
||||||
-pushmetrics.extraLabel array
|
-pushmetrics.extraLabel array
|
||||||
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
||||||
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.
|
||||||
@ -1071,6 +1071,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html .
|
|||||||
-remoteWrite.aws.accessKey array
|
-remoteWrite.aws.accessKey array
|
||||||
Optional AWS AccessKey to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
Optional AWS AccessKey to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
||||||
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.
|
||||||
|
-remoteWrite.aws.ec2Endpoint array
|
||||||
|
Optional AWS EC2 API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
||||||
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-remoteWrite.aws.region array
|
-remoteWrite.aws.region array
|
||||||
Optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
Optional AWS region to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
||||||
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.
|
||||||
@ -1083,6 +1086,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html .
|
|||||||
-remoteWrite.aws.service array
|
-remoteWrite.aws.service array
|
||||||
Optional AWS Service to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set. Defaults to "aps"
|
Optional AWS Service to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set. Defaults to "aps"
|
||||||
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.
|
||||||
|
-remoteWrite.aws.stsEndpoint array
|
||||||
|
Optional AWS STS API endpoint to use for the corresponding -remoteWrite.url if -remoteWrite.aws.useSigv4 is set
|
||||||
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-remoteWrite.aws.useSigv4 array
|
-remoteWrite.aws.useSigv4 array
|
||||||
Enables SigV4 request signing for the corresponding -remoteWrite.url. It is expected that other -remoteWrite.aws.* command-line flags are set if sigv4 request signing is enabled
|
Enables SigV4 request signing for the corresponding -remoteWrite.url. It is expected that other -remoteWrite.aws.* command-line flags are set if sigv4 request signing is enabled
|
||||||
Supports array of values separated by comma or specified via multiple flags.
|
Supports array of values separated by comma or specified via multiple flags.
|
||||||
|
|||||||
359
docs/vmalert.md
359
docs/vmalert.md
@ -626,272 +626,333 @@ command-line flags with their descriptions.
|
|||||||
The shortlist of configuration flags is the following:
|
The shortlist of configuration flags is the following:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
-clusterMode
|
||||||
|
If clusterMode is enabled, then vmalert automatically adds the tenant specified in config groups to -datasource.url, -remoteWrite.url and -remoteRead.url. See https://docs.victoriametrics.com/vmalert.html#multitenancy
|
||||||
-configCheckInterval duration
|
-configCheckInterval duration
|
||||||
Interval for checking for changes in '-rule' or '-notifier.config' files. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes.
|
Interval for checking for changes in '-rule' or '-notifier.config' files. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes.
|
||||||
-datasource.appendTypePrefix
|
-datasource.appendTypePrefix
|
||||||
Whether to add type prefix to -datasource.url based on the query type. Set to true if sending different query types to the vmselect URL.
|
Whether to add type prefix to -datasource.url based on the query type. Set to true if sending different query types to the vmselect URL.
|
||||||
-datasource.basicAuth.password string
|
-datasource.basicAuth.password string
|
||||||
Optional basic auth password for -datasource.url
|
Optional basic auth password for -datasource.url
|
||||||
-datasource.basicAuth.passwordFile string
|
-datasource.basicAuth.passwordFile string
|
||||||
Optional path to basic auth password to use for -datasource.url
|
Optional path to basic auth password to use for -datasource.url
|
||||||
-datasource.basicAuth.username string
|
-datasource.basicAuth.username string
|
||||||
Optional basic auth username for -datasource.url
|
Optional basic auth username for -datasource.url
|
||||||
-datasource.bearerToken string
|
-datasource.bearerToken string
|
||||||
Optional bearer auth token to use for -datasource.url.
|
Optional bearer auth token to use for -datasource.url.
|
||||||
-datasource.bearerTokenFile string
|
-datasource.bearerTokenFile string
|
||||||
Optional path to bearer token file to use for -datasource.url.
|
Optional path to bearer token file to use for -datasource.url.
|
||||||
-datasource.disableKeepAlive
|
-datasource.disableKeepAlive
|
||||||
Whether to disable long-lived connections to the datasource. If true, disables HTTP keep-alives and will only use the connection to the server for a single HTTP request.
|
Whether to disable long-lived connections to the datasource. If true, disables HTTP keep-alives and will only use the connection to the server for a single HTTP request.
|
||||||
-datasource.headers string
|
-datasource.headers string
|
||||||
Optional HTTP extraHeaders to send with each request to the corresponding -datasource.url. For example, -datasource.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -datasource.url. Multiple headers must be delimited by '^^': -datasource.headers='header1:value1^^header2:value2'
|
Optional HTTP extraHeaders to send with each request to the corresponding -datasource.url. For example, -datasource.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -datasource.url. Multiple headers must be delimited by '^^': -datasource.headers='header1:value1^^header2:value2'
|
||||||
-datasource.lookback duration
|
-datasource.lookback duration
|
||||||
Lookback defines how far into the past to look when evaluating queries. For example, if the datasource.lookback=5m then param "time" with value now()-5m will be added to every query.
|
Lookback defines how far into the past to look when evaluating queries. For example, if the datasource.lookback=5m then param "time" with value now()-5m will be added to every query.
|
||||||
-datasource.maxIdleConnections int
|
-datasource.maxIdleConnections int
|
||||||
Defines the number of idle (keep-alive connections) to each configured datasource. Consider setting this value equal to the value: groups_total * group.concurrency. Too low a value may result in a high number of sockets in TIME_WAIT state. (default 100)
|
Defines the number of idle (keep-alive connections) to each configured datasource. Consider setting this value equal to the value: groups_total * group.concurrency. Too low a value may result in a high number of sockets in TIME_WAIT state. (default 100)
|
||||||
-datasource.oauth2.clientID string
|
-datasource.oauth2.clientID string
|
||||||
Optional OAuth2 clientID to use for -datasource.url.
|
Optional OAuth2 clientID to use for -datasource.url.
|
||||||
-datasource.oauth2.clientSecret string
|
-datasource.oauth2.clientSecret string
|
||||||
Optional OAuth2 clientSecret to use for -datasource.url.
|
Optional OAuth2 clientSecret to use for -datasource.url.
|
||||||
-datasource.oauth2.clientSecretFile string
|
-datasource.oauth2.clientSecretFile string
|
||||||
Optional OAuth2 clientSecretFile to use for -datasource.url.
|
Optional OAuth2 clientSecretFile to use for -datasource.url.
|
||||||
-datasource.oauth2.scopes string
|
-datasource.oauth2.scopes string
|
||||||
Optional OAuth2 scopes to use for -datasource.url. Scopes must be delimited by ';'
|
Optional OAuth2 scopes to use for -datasource.url. Scopes must be delimited by ';'
|
||||||
-datasource.oauth2.tokenUrl string
|
-datasource.oauth2.tokenUrl string
|
||||||
Optional OAuth2 tokenURL to use for -datasource.url.
|
Optional OAuth2 tokenURL to use for -datasource.url.
|
||||||
-datasource.queryStep duration
|
-datasource.queryStep duration
|
||||||
queryStep defines how far a value can fallback to when evaluating queries. For example, if datasource.queryStep=15s then param "step" with value "15s" will be added to every query.If queryStep isn't specified, rule's evaluationInterval will be used instead.
|
queryStep defines how far a value can fallback to when evaluating queries. For example, if datasource.queryStep=15s then param "step" with value "15s" will be added to every query.If queryStep isn't specified, rule's evaluationInterval will be used instead.
|
||||||
-datasource.queryTimeAlignment
|
-datasource.queryTimeAlignment
|
||||||
Whether to align "time" parameter with evaluation interval.Alignment supposed to produce deterministic results despite of number of vmalert replicas or time they were started. See more details here https://github.com/VictoriaMetrics/VictoriaMetrics/pull/1257 (default true)
|
Whether to align "time" parameter with evaluation interval.Alignment supposed to produce deterministic results despite of number of vmalert replicas or time they were started. See more details here https://github.com/VictoriaMetrics/VictoriaMetrics/pull/1257 (default true)
|
||||||
-datasource.roundDigits int
|
-datasource.roundDigits int
|
||||||
Adds "round_digits" GET param to datasource requests. In VM "round_digits" limits the number of digits after the decimal point in response values.
|
Adds "round_digits" GET param to datasource requests. In VM "round_digits" limits the number of digits after the decimal point in response values.
|
||||||
-datasource.tlsCAFile string
|
-datasource.tlsCAFile string
|
||||||
Optional path to TLS CA file to use for verifying connections to -datasource.url. By default, system CA is used
|
Optional path to TLS CA file to use for verifying connections to -datasource.url. By default, system CA is used
|
||||||
-datasource.tlsCertFile string
|
-datasource.tlsCertFile string
|
||||||
Optional path to client-side TLS certificate file to use when connecting to -datasource.url
|
Optional path to client-side TLS certificate file to use when connecting to -datasource.url
|
||||||
-datasource.tlsInsecureSkipVerify
|
-datasource.tlsInsecureSkipVerify
|
||||||
Whether to skip tls verification when connecting to -datasource.url
|
Whether to skip tls verification when connecting to -datasource.url
|
||||||
-datasource.tlsKeyFile string
|
-datasource.tlsKeyFile string
|
||||||
Optional path to client-side TLS certificate key to use when connecting to -datasource.url
|
Optional path to client-side TLS certificate key to use when connecting to -datasource.url
|
||||||
-datasource.tlsServerName string
|
-datasource.tlsServerName string
|
||||||
Optional TLS server name to use for connections to -datasource.url. By default, the server name from -datasource.url is used
|
Optional TLS server name to use for connections to -datasource.url. By default, the server name from -datasource.url is used
|
||||||
-datasource.url string
|
-datasource.url string
|
||||||
Datasource compatible with Prometheus HTTP API. It can be single node VictoriaMetrics or vmselect URL. Required parameter. E.g. http://127.0.0.1:8428 . See also -remoteRead.disablePathAppend
|
Datasource compatible with Prometheus HTTP API. It can be single node VictoriaMetrics or vmselect URL. Required parameter. E.g. http://127.0.0.1:8428 . See also -remoteRead.disablePathAppend
|
||||||
|
-defaultTenant.graphite string
|
||||||
|
Default tenant for Graphite alerting groups. See https://docs.victoriametrics.com/vmalert.html#multitenancy
|
||||||
|
-defaultTenant.prometheus string
|
||||||
|
Default tenant for Prometheus alerting groups. See https://docs.victoriametrics.com/vmalert.html#multitenancy
|
||||||
-disableAlertgroupLabel
|
-disableAlertgroupLabel
|
||||||
Whether to disable adding group's Name as label to generated alerts and time series.
|
Whether to disable adding group's Name as label to generated alerts and time series.
|
||||||
-dryRun -rule
|
-dryRun -rule
|
||||||
Whether to check only config files without running vmalert. The rules file are validated. The -rule flag must be specified.
|
Whether to check only config files without running vmalert. The rules file are validated. The -rule flag must be specified.
|
||||||
-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
|
||||||
Whether to enable reading flags from environment variables additionally to command line. Command line flag values have priority over values from environment vars. Flags are read only from command line if this flag isn't set. See https://docs.victoriametrics.com/#environment-variables for more details
|
Whether to enable reading flags from environment variables additionally to command line. Command line flag values have priority over values from environment vars. Flags are read only from command line if this flag isn't set. See https://docs.victoriametrics.com/#environment-variables for more details
|
||||||
-envflag.prefix string
|
-envflag.prefix string
|
||||||
Prefix for environment variables if -envflag.enable is set
|
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
|
||||||
-evaluationInterval duration
|
-evaluationInterval duration
|
||||||
How often to evaluate the rules (default 1m0s)
|
How often to evaluate the rules (default 1m0s)
|
||||||
-external.alert.source string
|
-external.alert.source string
|
||||||
External Alert Source allows to override the Source link for alerts sent to AlertManager for cases where you want to build a custom link to Grafana, Prometheus or any other service.
|
External Alert Source allows to override the Source link for alerts sent to AlertManager for cases where you want to build a custom link to Grafana, Prometheus or any other service.
|
||||||
eg. 'explore?orgId=1&left=[\"now-1h\",\"now\",\"VictoriaMetrics\",{\"expr\": \"{{$expr|quotesEscape|crlfEscape|queryEscape}}\"},{\"mode\":\"Metrics\"},{\"ui\":[true,true,true,\"none\"]}]'.If empty '/vmalert/api/v1/alert?group_id=&alert_id=' is used
|
eg. 'explore?orgId=1&left=[\"now-1h\",\"now\",\"VictoriaMetrics\",{\"expr\": \"{{$expr|quotesEscape|crlfEscape|queryEscape}}\"},{\"mode\":\"Metrics\"},{\"ui\":[true,true,true,\"none\"]}]'.If empty '/vmalert/api/v1/alert?group_id=&alert_id=' is used
|
||||||
-external.label array
|
-external.label array
|
||||||
Optional label in the form 'Name=value' to add to all generated recording rules and alerts. Pass multiple -label flags in order to add multiple label sets.
|
Optional label in the form 'Name=value' to add to all generated recording rules and alerts. Pass multiple -label flags in order to add multiple label sets.
|
||||||
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.
|
||||||
-external.url string
|
-external.url string
|
||||||
External URL is used as alert's source for sent alerts to the notifier
|
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
|
||||||
|
Incoming http connections are closed after the configured timeout. This may help to spread the incoming load among a cluster of services behind a load balancer. Please note that the real timeout may be bigger by up to 10% as a protection against the thundering herd problem (default 2m0s)
|
||||||
|
-http.disableResponseCompression
|
||||||
|
Disable compression of HTTP responses to save CPU resources. By default compression is enabled to save network bandwidth
|
||||||
|
-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 string
|
-httpAuth.password string
|
||||||
Password for HTTP Basic Auth. The authentication is disabled if -httpAuth.username is empty
|
Password for HTTP Basic Auth. The authentication is disabled if -httpAuth.username is empty
|
||||||
-httpAuth.username string
|
-httpAuth.username string
|
||||||
Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
|
Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
|
||||||
-httpListenAddr string
|
-httpListenAddr string
|
||||||
Address to listen for http connections (default ":8880")
|
Address to listen for http connections (default ":8880")
|
||||||
|
-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")
|
||||||
|
-loggerLevel string
|
||||||
|
Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO")
|
||||||
|
-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
|
||||||
|
-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 OS page cache resulting in higher disk IO usage
|
||||||
|
Supports the following optional suffixes for size values: KB, MB, GB, KiB, MiB, GiB (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 OS page cache which will result in higher disk IO usage (default 60)
|
||||||
-metricsAuthKey string
|
-metricsAuthKey string
|
||||||
Auth key for /metrics endpoint. 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
|
-notifier.basicAuth.password array
|
||||||
Optional basic auth password for -notifier.url
|
Optional basic auth password for -notifier.url
|
||||||
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.
|
||||||
-notifier.basicAuth.passwordFile array
|
-notifier.basicAuth.passwordFile array
|
||||||
Optional path to basic auth password file for -notifier.url
|
Optional path to basic auth password file for -notifier.url
|
||||||
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.
|
||||||
-notifier.basicAuth.username array
|
-notifier.basicAuth.username array
|
||||||
Optional basic auth username for -notifier.url
|
Optional basic auth username for -notifier.url
|
||||||
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.
|
||||||
-notifier.bearerToken array
|
-notifier.bearerToken array
|
||||||
Optional bearer token for -notifier.url
|
Optional bearer token for -notifier.url
|
||||||
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.
|
||||||
-notifier.bearerTokenFile array
|
-notifier.bearerTokenFile array
|
||||||
Optional path to bearer token file for -notifier.url
|
Optional path to bearer token file for -notifier.url
|
||||||
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.
|
||||||
-notifier.config string
|
-notifier.config string
|
||||||
Path to configuration file for notifiers
|
Path to configuration file for notifiers
|
||||||
-notifier.oauth2.clientID array
|
-notifier.oauth2.clientID array
|
||||||
Optional OAuth2 clientID to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 clientID to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.oauth2.clientSecret array
|
-notifier.oauth2.clientSecret array
|
||||||
Optional OAuth2 clientSecret to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 clientSecret to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.oauth2.clientSecretFile array
|
-notifier.oauth2.clientSecretFile array
|
||||||
Optional OAuth2 clientSecretFile to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 clientSecretFile to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.oauth2.scopes array
|
-notifier.oauth2.scopes array
|
||||||
Optional OAuth2 scopes to use for -notifier.url. Scopes must be delimited by ';'. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 scopes to use for -notifier.url. Scopes must be delimited by ';'. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.oauth2.tokenUrl array
|
-notifier.oauth2.tokenUrl array
|
||||||
Optional OAuth2 tokenURL to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
Optional OAuth2 tokenURL to use for -notifier.url. If multiple args are set, then they are applied independently for the corresponding -notifier.url
|
||||||
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.
|
||||||
-notifier.suppressDuplicateTargetErrors
|
-notifier.suppressDuplicateTargetErrors
|
||||||
Whether to suppress 'duplicate target' errors during discovery
|
Whether to suppress 'duplicate target' errors during discovery
|
||||||
-notifier.tlsCAFile array
|
-notifier.tlsCAFile array
|
||||||
Optional path to TLS CA file to use for verifying connections to -notifier.url. By default system CA is used
|
Optional path to TLS CA file to use for verifying connections to -notifier.url. By default system CA is used
|
||||||
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.
|
||||||
-notifier.tlsCertFile array
|
-notifier.tlsCertFile array
|
||||||
Optional path to client-side TLS certificate file to use when connecting to -notifier.url
|
Optional path to client-side TLS certificate file to use when connecting to -notifier.url
|
||||||
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.
|
||||||
-notifier.tlsInsecureSkipVerify array
|
-notifier.tlsInsecureSkipVerify array
|
||||||
Whether to skip tls verification when connecting to -notifier.url
|
Whether to skip tls verification when connecting to -notifier.url
|
||||||
Supports array of values separated by comma or specified via multiple flags.
|
Supports array of values separated by comma or specified via multiple flags.
|
||||||
-notifier.tlsKeyFile array
|
-notifier.tlsKeyFile array
|
||||||
Optional path to client-side TLS certificate key to use when connecting to -notifier.url
|
Optional path to client-side TLS certificate key to use when connecting to -notifier.url
|
||||||
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.
|
||||||
-notifier.tlsServerName array
|
-notifier.tlsServerName array
|
||||||
Optional TLS server name to use for connections to -notifier.url. By default the server name from -notifier.url is used
|
Optional TLS server name to use for connections to -notifier.url. By default the server name from -notifier.url is used
|
||||||
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.
|
||||||
-notifier.url array
|
-notifier.url array
|
||||||
Prometheus alertmanager URL, e.g. http://127.0.0.1:9093
|
Prometheus alertmanager URL, e.g. http://127.0.0.1:9093
|
||||||
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.
|
||||||
-pprofAuthKey string
|
-pprofAuthKey string
|
||||||
Auth key for /debug/pprof/* endpoints. 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
|
||||||
|
Interval for checking for changes in Consul. This works only if consul_sd_configs is configured in '-promscrape.config' file. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config for details (default 30s)
|
||||||
|
-promscrape.discovery.concurrency int
|
||||||
|
The maximum number of concurrent requests to Prometheus autodiscovery API (Consul, Kubernetes, etc.) (default 100)
|
||||||
|
-promscrape.discovery.concurrentWaitTime duration
|
||||||
|
The maximum duration for waiting to perform API requests if more than -promscrape.discovery.concurrency requests are simultaneously performed (default 1m0s)
|
||||||
|
-promscrape.dnsSDCheckInterval duration
|
||||||
|
Interval for checking for changes in dns. This works only if dns_sd_configs is configured in '-promscrape.config' file. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dns_sd_config for details (default 30s)
|
||||||
|
-pushmetrics.extraLabel array
|
||||||
|
Optional labels to add to metrics pushed to -pushmetrics.url . For example, -pushmetrics.extraLabel='instance="foo"' adds instance="foo" label to all the metrics pushed to -pushmetrics.url
|
||||||
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
|
-pushmetrics.interval duration
|
||||||
|
Interval for pushing metrics to -pushmetrics.url (default 10s)
|
||||||
|
-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
|
||||||
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-remoteRead.basicAuth.password string
|
-remoteRead.basicAuth.password string
|
||||||
Optional basic auth password for -remoteRead.url
|
Optional basic auth password for -remoteRead.url
|
||||||
-remoteRead.basicAuth.passwordFile string
|
-remoteRead.basicAuth.passwordFile string
|
||||||
Optional path to basic auth password to use for -remoteRead.url
|
Optional path to basic auth password to use for -remoteRead.url
|
||||||
-remoteRead.basicAuth.username string
|
-remoteRead.basicAuth.username string
|
||||||
Optional basic auth username for -remoteRead.url
|
Optional basic auth username for -remoteRead.url
|
||||||
-remoteRead.bearerToken string
|
-remoteRead.bearerToken string
|
||||||
Optional bearer auth token to use for -remoteRead.url.
|
Optional bearer auth token to use for -remoteRead.url.
|
||||||
-remoteRead.bearerTokenFile string
|
-remoteRead.bearerTokenFile string
|
||||||
Optional path to bearer token file to use for -remoteRead.url.
|
Optional path to bearer token file to use for -remoteRead.url.
|
||||||
-remoteRead.disablePathAppend
|
-remoteRead.disablePathAppend
|
||||||
Whether to disable automatic appending of '/api/v1/query' path to the configured -datasource.url and -remoteRead.url
|
Whether to disable automatic appending of '/api/v1/query' path to the configured -datasource.url and -remoteRead.url
|
||||||
-remoteRead.headers string
|
-remoteRead.headers string
|
||||||
Optional HTTP headers to send with each request to the corresponding -remoteRead.url. For example, -remoteRead.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -remoteRead.url. Multiple headers must be delimited by '^^': -remoteRead.headers='header1:value1^^header2:value2'
|
Optional HTTP headers to send with each request to the corresponding -remoteRead.url. For example, -remoteRead.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -remoteRead.url. Multiple headers must be delimited by '^^': -remoteRead.headers='header1:value1^^header2:value2'
|
||||||
-remoteRead.ignoreRestoreErrors
|
-remoteRead.ignoreRestoreErrors
|
||||||
Whether to ignore errors from remote storage when restoring alerts state on startup. (default true)
|
Whether to ignore errors from remote storage when restoring alerts state on startup. (default true)
|
||||||
-remoteRead.lookback duration
|
-remoteRead.lookback duration
|
||||||
Lookback defines how far to look into past for alerts timeseries. For example, if lookback=1h then range from now() to now()-1h will be scanned. (default 1h0m0s)
|
Lookback defines how far to look into past for alerts timeseries. For example, if lookback=1h then range from now() to now()-1h will be scanned. (default 1h0m0s)
|
||||||
-remoteRead.oauth2.clientID string
|
-remoteRead.oauth2.clientID string
|
||||||
Optional OAuth2 clientID to use for -remoteRead.url.
|
Optional OAuth2 clientID to use for -remoteRead.url.
|
||||||
-remoteRead.oauth2.clientSecret string
|
-remoteRead.oauth2.clientSecret string
|
||||||
Optional OAuth2 clientSecret to use for -remoteRead.url.
|
Optional OAuth2 clientSecret to use for -remoteRead.url.
|
||||||
-remoteRead.oauth2.clientSecretFile string
|
-remoteRead.oauth2.clientSecretFile string
|
||||||
Optional OAuth2 clientSecretFile to use for -remoteRead.url.
|
Optional OAuth2 clientSecretFile to use for -remoteRead.url.
|
||||||
-remoteRead.oauth2.scopes string
|
-remoteRead.oauth2.scopes string
|
||||||
Optional OAuth2 scopes to use for -remoteRead.url. Scopes must be delimited by ';'.
|
Optional OAuth2 scopes to use for -remoteRead.url. Scopes must be delimited by ';'.
|
||||||
-remoteRead.oauth2.tokenUrl string
|
-remoteRead.oauth2.tokenUrl string
|
||||||
Optional OAuth2 tokenURL to use for -remoteRead.url.
|
Optional OAuth2 tokenURL to use for -remoteRead.url.
|
||||||
-remoteRead.tlsCAFile string
|
-remoteRead.tlsCAFile string
|
||||||
Optional path to TLS CA file to use for verifying connections to -remoteRead.url. By default system CA is used
|
Optional path to TLS CA file to use for verifying connections to -remoteRead.url. By default system CA is used
|
||||||
-remoteRead.tlsCertFile string
|
-remoteRead.tlsCertFile string
|
||||||
Optional path to client-side TLS certificate file to use when connecting to -remoteRead.url
|
Optional path to client-side TLS certificate file to use when connecting to -remoteRead.url
|
||||||
-remoteRead.tlsInsecureSkipVerify
|
-remoteRead.tlsInsecureSkipVerify
|
||||||
Whether to skip tls verification when connecting to -remoteRead.url
|
Whether to skip tls verification when connecting to -remoteRead.url
|
||||||
-remoteRead.tlsKeyFile string
|
-remoteRead.tlsKeyFile string
|
||||||
Optional path to client-side TLS certificate key to use when connecting to -remoteRead.url
|
Optional path to client-side TLS certificate key to use when connecting to -remoteRead.url
|
||||||
-remoteRead.tlsServerName string
|
-remoteRead.tlsServerName string
|
||||||
Optional TLS server name to use for connections to -remoteRead.url. By default the server name from -remoteRead.url is used
|
Optional TLS server name to use for connections to -remoteRead.url. By default the server name from -remoteRead.url is used
|
||||||
-remoteRead.url vmalert
|
-remoteRead.url vmalert
|
||||||
Optional URL to datasource compatible with Prometheus HTTP API. It can be single node VictoriaMetrics or vmselect.Remote read is used to restore alerts state.This configuration makes sense only if vmalert was configured with `remoteWrite.url` before and has been successfully persisted its state. E.g. http://127.0.0.1:8428. See also -remoteRead.disablePathAppend
|
Optional URL to datasource compatible with Prometheus HTTP API. It can be single node VictoriaMetrics or vmselect.Remote read is used to restore alerts state.This configuration makes sense only if vmalert was configured with `remoteWrite.url` before and has been successfully persisted its state. E.g. http://127.0.0.1:8428. See also -remoteRead.disablePathAppend
|
||||||
-remoteWrite.basicAuth.password string
|
-remoteWrite.basicAuth.password string
|
||||||
Optional basic auth password for -remoteWrite.url
|
Optional basic auth password for -remoteWrite.url
|
||||||
-remoteWrite.basicAuth.passwordFile string
|
-remoteWrite.basicAuth.passwordFile string
|
||||||
Optional path to basic auth password to use for -remoteWrite.url
|
Optional path to basic auth password to use for -remoteWrite.url
|
||||||
-remoteWrite.basicAuth.username string
|
-remoteWrite.basicAuth.username string
|
||||||
Optional basic auth username for -remoteWrite.url
|
Optional basic auth username for -remoteWrite.url
|
||||||
-remoteWrite.bearerToken string
|
-remoteWrite.bearerToken string
|
||||||
Optional bearer auth token to use for -remoteWrite.url.
|
Optional bearer auth token to use for -remoteWrite.url.
|
||||||
-remoteWrite.bearerTokenFile string
|
-remoteWrite.bearerTokenFile string
|
||||||
Optional path to bearer token file to use for -remoteWrite.url.
|
Optional path to bearer token file to use for -remoteWrite.url.
|
||||||
-remoteWrite.concurrency int
|
-remoteWrite.concurrency int
|
||||||
Defines number of writers for concurrent writing into remote querier (default 1)
|
Defines number of writers for concurrent writing into remote querier (default 1)
|
||||||
-remoteWrite.disablePathAppend
|
-remoteWrite.disablePathAppend
|
||||||
Whether to disable automatic appending of '/api/v1/write' path to the configured -remoteWrite.url.
|
Whether to disable automatic appending of '/api/v1/write' path to the configured -remoteWrite.url.
|
||||||
-remoteWrite.flushInterval duration
|
-remoteWrite.flushInterval duration
|
||||||
Defines interval of flushes to remote write endpoint (default 5s)
|
Defines interval of flushes to remote write endpoint (default 5s)
|
||||||
-remoteWrite.headers string
|
-remoteWrite.headers string
|
||||||
Optional HTTP headers to send with each request to the corresponding -remoteWrite.url. For example, -remoteWrite.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -remoteWrite.url. Multiple headers must be delimited by '^^': -remoteWrite.headers='header1:value1^^header2:value2'
|
Optional HTTP headers to send with each request to the corresponding -remoteWrite.url. For example, -remoteWrite.headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding -remoteWrite.url. Multiple headers must be delimited by '^^': -remoteWrite.headers='header1:value1^^header2:value2'
|
||||||
-remoteWrite.maxBatchSize int
|
-remoteWrite.maxBatchSize int
|
||||||
Defines defines max number of timeseries to be flushed at once (default 1000)
|
Defines defines max number of timeseries to be flushed at once (default 1000)
|
||||||
-remoteWrite.maxQueueSize int
|
-remoteWrite.maxQueueSize int
|
||||||
Defines the max number of pending datapoints to remote write endpoint (default 100000)
|
Defines the max number of pending datapoints to remote write endpoint (default 100000)
|
||||||
-remoteWrite.oauth2.clientID string
|
-remoteWrite.oauth2.clientID string
|
||||||
Optional OAuth2 clientID to use for -remoteWrite.url.
|
Optional OAuth2 clientID to use for -remoteWrite.url.
|
||||||
-remoteWrite.oauth2.clientSecret string
|
-remoteWrite.oauth2.clientSecret string
|
||||||
Optional OAuth2 clientSecret to use for -remoteWrite.url.
|
Optional OAuth2 clientSecret to use for -remoteWrite.url.
|
||||||
-remoteWrite.oauth2.clientSecretFile string
|
-remoteWrite.oauth2.clientSecretFile string
|
||||||
Optional OAuth2 clientSecretFile to use for -remoteWrite.url.
|
Optional OAuth2 clientSecretFile to use for -remoteWrite.url.
|
||||||
-remoteWrite.oauth2.scopes string
|
-remoteWrite.oauth2.scopes string
|
||||||
Optional OAuth2 scopes to use for -notifier.url. Scopes must be delimited by ';'.
|
Optional OAuth2 scopes to use for -notifier.url. Scopes must be delimited by ';'.
|
||||||
-remoteWrite.oauth2.tokenUrl string
|
-remoteWrite.oauth2.tokenUrl string
|
||||||
Optional OAuth2 tokenURL to use for -notifier.url.
|
Optional OAuth2 tokenURL to use for -notifier.url.
|
||||||
-remoteWrite.tlsCAFile string
|
-remoteWrite.tlsCAFile string
|
||||||
Optional path to TLS CA file to use for verifying connections to -remoteWrite.url. By default system CA is used
|
Optional path to TLS CA file to use for verifying connections to -remoteWrite.url. By default system CA is used
|
||||||
-remoteWrite.tlsCertFile string
|
-remoteWrite.tlsCertFile string
|
||||||
Optional path to client-side TLS certificate file to use when connecting to -remoteWrite.url
|
Optional path to client-side TLS certificate file to use when connecting to -remoteWrite.url
|
||||||
-remoteWrite.tlsInsecureSkipVerify
|
-remoteWrite.tlsInsecureSkipVerify
|
||||||
Whether to skip tls verification when connecting to -remoteWrite.url
|
Whether to skip tls verification when connecting to -remoteWrite.url
|
||||||
-remoteWrite.tlsKeyFile string
|
-remoteWrite.tlsKeyFile string
|
||||||
Optional path to client-side TLS certificate key to use when connecting to -remoteWrite.url
|
Optional path to client-side TLS certificate key to use when connecting to -remoteWrite.url
|
||||||
-remoteWrite.tlsServerName string
|
-remoteWrite.tlsServerName string
|
||||||
Optional TLS server name to use for connections to -remoteWrite.url. By default the server name from -remoteWrite.url is used
|
Optional TLS server name to use for connections to -remoteWrite.url. By default the server name from -remoteWrite.url is used
|
||||||
-remoteWrite.url string
|
-remoteWrite.url string
|
||||||
Optional URL to VictoriaMetrics or vminsert where to persist alerts state and recording rules results in form of timeseries. For example, if -remoteWrite.url=http://127.0.0.1:8428 is specified, then the alerts state will be written to http://127.0.0.1:8428/api/v1/write . See also -remoteWrite.disablePathAppend
|
Optional URL to VictoriaMetrics or vminsert where to persist alerts state and recording rules results in form of timeseries. For example, if -remoteWrite.url=http://127.0.0.1:8428 is specified, then the alerts state will be written to http://127.0.0.1:8428/api/v1/write . See also -remoteWrite.disablePathAppend
|
||||||
-replay.disableProgressBar
|
-replay.disableProgressBar
|
||||||
Whether to disable rendering progress bars during the replay. Progress bar rendering might be verbose or break the logs parsing, so it is recommended to be disabled when not used in interactive mode.
|
Whether to disable rendering progress bars during the replay. Progress bar rendering might be verbose or break the logs parsing, so it is recommended to be disabled when not used in interactive mode.
|
||||||
-replay.maxDatapointsPerQuery int
|
-replay.maxDatapointsPerQuery int
|
||||||
Max number of data points expected in one request. The higher the value, the less requests will be made during replay. (default 1000)
|
Max number of data points expected in one request. The higher the value, the less requests will be made during replay. (default 1000)
|
||||||
-replay.ruleRetryAttempts int
|
-replay.ruleRetryAttempts int
|
||||||
Defines how many retries to make before giving up on rule if request for it returns an error. (default 5)
|
Defines how many retries to make before giving up on rule if request for it returns an error. (default 5)
|
||||||
-replay.rulesDelay duration
|
-replay.rulesDelay duration
|
||||||
Delay between rules evaluation within the group. Could be important if there are chained rules inside of the groupand processing need to wait for previous rule results to be persisted by remote storage before evaluating the next rule.Keep it equal or bigger than -remoteWrite.flushInterval. (default 1s)
|
Delay between rules evaluation within the group. Could be important if there are chained rules inside of the groupand processing need to wait for previous rule results to be persisted by remote storage before evaluating the next rule.Keep it equal or bigger than -remoteWrite.flushInterval. (default 1s)
|
||||||
-replay.timeFrom string
|
-replay.timeFrom string
|
||||||
The time filter in RFC3339 format to select time series with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'
|
The time filter in RFC3339 format to select time series with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'
|
||||||
-replay.timeTo string
|
-replay.timeTo string
|
||||||
The time filter in RFC3339 format to select timeseries with timestamp equal or lower than provided value. E.g. '2020-01-01T20:07:00Z'
|
The time filter in RFC3339 format to select timeseries with timestamp equal or lower than provided value. E.g. '2020-01-01T20:07:00Z'
|
||||||
-rule array
|
-rule array
|
||||||
Path to the file with alert rules.
|
Path to the file with alert rules.
|
||||||
Supports patterns. Flag can be specified multiple times.
|
Supports patterns. Flag can be specified multiple times.
|
||||||
Examples:
|
Examples:
|
||||||
-rule="/path/to/file". Path to a single file with alerting rules
|
-rule="/path/to/file". Path to a single file with alerting rules
|
||||||
-rule="dir/*.yaml" -rule="/*.yaml". Relative path to all .yaml files in "dir" folder,
|
-rule="dir/*.yaml" -rule="/*.yaml". Relative path to all .yaml files in "dir" folder,
|
||||||
absolute path to all .yaml files in root.
|
absolute path to all .yaml files in root.
|
||||||
Rule files may contain %{ENV_VAR} placeholders, which are substituted by the corresponding env vars.
|
Rule files may contain %{ENV_VAR} placeholders, which are substituted by the corresponding env vars.
|
||||||
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.
|
||||||
-rule.configCheckInterval duration
|
-rule.configCheckInterval duration
|
||||||
Interval for checking for changes in '-rule' files. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes. DEPRECATED - see '-configCheckInterval' instead
|
Interval for checking for changes in '-rule' files. By default the checking is disabled. Send SIGHUP signal in order to force config check for changes. DEPRECATED - see '-configCheckInterval' instead
|
||||||
-rule.maxResolveDuration duration
|
-rule.maxResolveDuration duration
|
||||||
Limits the maximum duration for automatic alert expiration, which is by default equal to 3 evaluation intervals of the parent group.
|
Limits the maximum duration for automatic alert expiration, which is by default equal to 3 evaluation intervals of the parent group.
|
||||||
-rule.resendDelay duration
|
-rule.resendDelay duration
|
||||||
Minimum amount of time to wait before resending an alert to notifier
|
Minimum amount of time to wait before resending an alert to notifier
|
||||||
-rule.templates array
|
-rule.templates array
|
||||||
Path or glob pattern to location with go template definitions
|
Path or glob pattern to location with go template definitions
|
||||||
for rules annotations templating. Flag can be specified multiple times.
|
for rules annotations templating. Flag can be specified multiple times.
|
||||||
Examples:
|
Examples:
|
||||||
-rule.templates="/path/to/file". Path to a single file with go templates
|
-rule.templates="/path/to/file". Path to a single file with go templates
|
||||||
-rule.templates="dir/*.tpl" -rule.templates="/*.tpl". Relative path to all .tpl files in "dir" folder,
|
-rule.templates="dir/*.tpl" -rule.templates="/*.tpl". Relative path to all .tpl files in "dir" folder,
|
||||||
absolute path to all .tpl files in root.
|
absolute path to all .tpl files in root.
|
||||||
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.
|
||||||
-rule.validateExpressions
|
-rule.validateExpressions
|
||||||
Whether to validate rules expressions via MetricsQL engine (default true)
|
Whether to validate rules expressions via MetricsQL engine (default true)
|
||||||
-rule.validateTemplates
|
-rule.validateTemplates
|
||||||
Whether to validate annotation and label templates (default true)
|
Whether to validate annotation and label templates (default true)
|
||||||
-tls
|
-tls
|
||||||
Whether to enable TLS for incoming HTTP requests at -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set
|
Whether to enable TLS for incoming HTTP requests at -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set
|
||||||
-tlsCertFile string
|
-tlsCertFile string
|
||||||
Path to file with TLS certificate 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
|
Path to file with TLS certificate 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
|
||||||
-tlsCipherSuites array
|
-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
|
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.
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
-tlsKeyFile string
|
-tlsKeyFile string
|
||||||
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
|
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
|
-version
|
||||||
Show VictoriaMetrics version
|
Show VictoriaMetrics version
|
||||||
```
|
```
|
||||||
|
|
||||||
### Hot config reload
|
### Hot config reload
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user