From 1731fe2adad33c41eca7739e776527d561f48590 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Fri, 20 May 2022 15:07:16 +0300 Subject: [PATCH] docs: update the description for command-line flags according to recent changes --- README.md | 3 ++- app/vmagent/README.md | 3 +++ app/vmalert/README.md | 19 ++++++++++++------- docs/README.md | 3 ++- docs/Single-server-VictoriaMetrics.md | 3 ++- docs/vmagent.md | 3 +++ docs/vmalert.md | 19 ++++++++++++------- 7 files changed, 36 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 37c14ea02..820b6d1c2 100644 --- a/README.md +++ b/README.md @@ -1918,8 +1918,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li The maximum number of CPU cores to use for small merges. Default value is used if set to 0 -snapshotAuthKey string authKey, which must be passed in query string to /snapshot* pages - -snapshotsMaxAge duration + -snapshotsMaxAge value Automatically delete snapshots older than -snapshotsMaxAge if it is set to non-zero duration. Make sure that backup process has enough time to finish the backup before the corresponding snapshot is automatically deleted + The following optional suffixes are supported: h (hour), d (day), w (week), y (year). If suffix isn't set, then the duration is counted in months (default 0) -sortLabels Whether to sort labels for incoming samples before writing them to storage. This may be needed for reducing memory usage at storage when the order of labels in incoming samples is random. For example, if m{k1="v1",k2="v2"} may be sent as m{k2="v2",k1="v1"}. Enabled sorting for labels can slow down ingestion performance a bit -storage.cacheSizeIndexDBDataBlocks size diff --git a/app/vmagent/README.md b/app/vmagent/README.md index 7bc2bbb6f..d6ca120b0 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -926,6 +926,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -remoteWrite.aws.secretKey array Optional AWS SecretKey to use for -remoteWrite.url if -remoteWrite.aws.useSigv4 is set. If multiple args are set, then they are applied independently for the corresponding -remoteWrite.url Supports an array of values separated by comma or specified via multiple flags. + -remoteWrite.aws.serice array + Optional AWS Service to use for -remoteWrite.url if -remoteWrite.aws.useSigv4 is set. If multiple args are set, then they are applied independently for the corresponding -remoteWrite.url. Defaults to "aps". + Supports an array of values separated by comma or specified via multiple flags. -remoteWrite.aws.useSigv4 array Enables SigV4 request signing for -remoteWrite.url. It is expected that other -remoteWrite.aws.* command-line flags are set if sigv4 request signing is enabled. If multiple args are set, then they are applied independently for the corresponding -remoteWrite.url Supports array of values separated by comma or specified via multiple flags. diff --git a/app/vmalert/README.md b/app/vmalert/README.md index d100edb60..0a54570ac 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -605,7 +605,7 @@ The shortlist of configuration flags is the following: -datasource.tlsServerName string Optional TLS server name to use for connections to -datasource.url. By default, the server name from -datasource.url is used -datasource.url string - VictoriaMetrics or vmselect url. Required parameter. E.g. http://127.0.0.1:8428 + 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 @@ -748,7 +748,7 @@ The shortlist of configuration flags is the following: -remoteRead.bearerTokenFile string Optional path to bearer token file to use for -remoteRead.url. -remoteRead.disablePathAppend - Whether to disable automatic appending of '/api/v1/query' path to the configured -remoteRead.url. + Whether to disable automatic appending of '/api/v1/query' path to the configured -datasource.url and -remoteRead.url -remoteRead.ignoreRestoreErrors Whether to ignore errors from remote storage when restoring alerts state on startup. (default true) -remoteRead.lookback duration @@ -817,6 +817,8 @@ The shortlist of configuration flags is the following: Optional TLS server name to use for connections to -remoteWrite.url. By default the server name from -remoteWrite.url is used -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 + -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. -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) -replay.ruleRetryAttempts int @@ -836,17 +838,20 @@ The shortlist of configuration flags is the following: absolute path to all .yaml files in root. 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. - -rule.templates - Path or glob pattern to location with go template definitions for rules annotations templating. Flag can be specified multiple times. - Examples: - -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, absolute path to all .tpl files in root. -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 -rule.maxResolveDuration duration Limits the maximum duration for automatic alert expiration, which is by default equal to 3 evaluation intervals of the parent group. -rule.resendDelay duration Minimum amount of time to wait before resending an alert to notifier + -rule.templates array + Path or glob pattern to location with go template definitions + for rules annotations templating. Flag can be specified multiple times. + Examples: + -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, + absolute path to all .tpl files in root. + Supports an array of values separated by comma or specified via multiple flags. -rule.validateExpressions Whether to validate rules expressions via MetricsQL engine (default true) -rule.validateTemplates diff --git a/docs/README.md b/docs/README.md index 37c14ea02..820b6d1c2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1918,8 +1918,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li The maximum number of CPU cores to use for small merges. Default value is used if set to 0 -snapshotAuthKey string authKey, which must be passed in query string to /snapshot* pages - -snapshotsMaxAge duration + -snapshotsMaxAge value Automatically delete snapshots older than -snapshotsMaxAge if it is set to non-zero duration. Make sure that backup process has enough time to finish the backup before the corresponding snapshot is automatically deleted + The following optional suffixes are supported: h (hour), d (day), w (week), y (year). If suffix isn't set, then the duration is counted in months (default 0) -sortLabels Whether to sort labels for incoming samples before writing them to storage. This may be needed for reducing memory usage at storage when the order of labels in incoming samples is random. For example, if m{k1="v1",k2="v2"} may be sent as m{k2="v2",k1="v1"}. Enabled sorting for labels can slow down ingestion performance a bit -storage.cacheSizeIndexDBDataBlocks size diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index d6ab05e44..46943d458 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -1922,8 +1922,9 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li The maximum number of CPU cores to use for small merges. Default value is used if set to 0 -snapshotAuthKey string authKey, which must be passed in query string to /snapshot* pages - -snapshotsMaxAge duration + -snapshotsMaxAge value Automatically delete snapshots older than -snapshotsMaxAge if it is set to non-zero duration. Make sure that backup process has enough time to finish the backup before the corresponding snapshot is automatically deleted + The following optional suffixes are supported: h (hour), d (day), w (week), y (year). If suffix isn't set, then the duration is counted in months (default 0) -sortLabels Whether to sort labels for incoming samples before writing them to storage. This may be needed for reducing memory usage at storage when the order of labels in incoming samples is random. For example, if m{k1="v1",k2="v2"} may be sent as m{k2="v2",k1="v1"}. Enabled sorting for labels can slow down ingestion performance a bit -storage.cacheSizeIndexDBDataBlocks size diff --git a/docs/vmagent.md b/docs/vmagent.md index 395d5a533..257ee8bed 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -930,6 +930,9 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -remoteWrite.aws.secretKey array Optional AWS SecretKey to use for -remoteWrite.url if -remoteWrite.aws.useSigv4 is set. If multiple args are set, then they are applied independently for the corresponding -remoteWrite.url Supports an array of values separated by comma or specified via multiple flags. + -remoteWrite.aws.serice array + Optional AWS Service to use for -remoteWrite.url if -remoteWrite.aws.useSigv4 is set. If multiple args are set, then they are applied independently for the corresponding -remoteWrite.url. Defaults to "aps". + Supports an array of values separated by comma or specified via multiple flags. -remoteWrite.aws.useSigv4 array Enables SigV4 request signing for -remoteWrite.url. It is expected that other -remoteWrite.aws.* command-line flags are set if sigv4 request signing is enabled. If multiple args are set, then they are applied independently for the corresponding -remoteWrite.url Supports array of values separated by comma or specified via multiple flags. diff --git a/docs/vmalert.md b/docs/vmalert.md index 885d5877c..79ce0da20 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -609,7 +609,7 @@ The shortlist of configuration flags is the following: -datasource.tlsServerName string Optional TLS server name to use for connections to -datasource.url. By default, the server name from -datasource.url is used -datasource.url string - VictoriaMetrics or vmselect url. Required parameter. E.g. http://127.0.0.1:8428 + 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 @@ -752,7 +752,7 @@ The shortlist of configuration flags is the following: -remoteRead.bearerTokenFile string Optional path to bearer token file to use for -remoteRead.url. -remoteRead.disablePathAppend - Whether to disable automatic appending of '/api/v1/query' path to the configured -remoteRead.url. + Whether to disable automatic appending of '/api/v1/query' path to the configured -datasource.url and -remoteRead.url -remoteRead.ignoreRestoreErrors Whether to ignore errors from remote storage when restoring alerts state on startup. (default true) -remoteRead.lookback duration @@ -821,6 +821,8 @@ The shortlist of configuration flags is the following: Optional TLS server name to use for connections to -remoteWrite.url. By default the server name from -remoteWrite.url is used -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 + -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. -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) -replay.ruleRetryAttempts int @@ -840,17 +842,20 @@ The shortlist of configuration flags is the following: absolute path to all .yaml files in root. 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. - -rule.templates - Path or glob pattern to location with go template definitions for rules annotations templating. Flag can be specified multiple times. - Examples: - -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, absolute path to all .tpl files in root. -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 -rule.maxResolveDuration duration Limits the maximum duration for automatic alert expiration, which is by default equal to 3 evaluation intervals of the parent group. -rule.resendDelay duration Minimum amount of time to wait before resending an alert to notifier + -rule.templates array + Path or glob pattern to location with go template definitions + for rules annotations templating. Flag can be specified multiple times. + Examples: + -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, + absolute path to all .tpl files in root. + Supports an array of values separated by comma or specified via multiple flags. -rule.validateExpressions Whether to validate rules expressions via MetricsQL engine (default true) -rule.validateTemplates