From fd175ad80b236057c1c84a11e7802118841f7ab6 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Tue, 3 Jan 2023 22:40:00 -0800 Subject: [PATCH] docs: update `-help` outputs for vm* tools --- README.md | 6 ++++++ app/vmagent/README.md | 12 ++++++++++-- app/vmagent/remotewrite/remotewrite.go | 4 ++-- app/vmalert/README.md | 8 ++++---- app/vmauth/README.md | 2 ++ app/vmbackup/README.md | 2 ++ app/vmbackupmanager/README.md | 2 ++ app/vmgateway/README.md | 2 ++ app/vminsert/common/streamaggr.go | 4 ++-- app/vmrestore/README.md | 2 ++ docs/Cluster-VictoriaMetrics.md | 6 ++++++ docs/README.md | 6 ++++++ docs/Single-server-VictoriaMetrics.md | 6 ++++++ docs/vmagent.md | 12 ++++++++++-- docs/vmalert.md | 8 ++++---- docs/vmauth.md | 2 ++ docs/vmbackup.md | 2 ++ docs/vmbackupmanager.md | 2 ++ docs/vmgateway.md | 2 ++ docs/vmrestore.md | 2 ++ 20 files changed, 76 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index dd3366e6a..d904d5320 100644 --- a/README.md +++ b/README.md @@ -2224,6 +2224,8 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string @@ -2476,6 +2478,10 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 10000000) -storageDataPath string Path to storage data (default "victoria-metrics-data") + -streamAggr.config string + Optional path to file with stream aggregation config. See https://docs.victoriametrics.com/stream-aggregation.html .See also -remoteWrite.streamAggr.keepInput + -streamAggr.keepInput + Whether to keep input samples after the aggregation with -streamAggr.config .By default the input is dropped after the aggregation, so only the aggregate data is stored. See https://docs.victoriametrics.com/stream-aggregation.html -tls Whether to enable TLS for incoming HTTP requests at -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set -tlsCertFile string diff --git a/app/vmagent/README.md b/app/vmagent/README.md index 56b2c1ebe..627d9b789 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -1238,6 +1238,8 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string @@ -1449,7 +1451,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . Optional rate limit in bytes per second for data sent to the corresponding -remoteWrite.url. By default the rate limit is disabled. It can be useful for limiting load on remote storage when big amounts of buffered data is sent after temporary unavailability of the remote storage Supports array of values separated by comma or specified via multiple flags. -remoteWrite.relabelConfig string - Optional path to file with relabel_config entries. The path can point either to local file or to http url. These entries are applied to all the metrics before sending them to -remoteWrite.url. See https://docs.victoriametrics.com/vmagent.html#relabeling for details + Optional path to file with relabeling configs, which are applied to all the metrics before sending them to -remoteWrite.url. See also -remoteWrite.urlRelabelConfig. The path can point either to local file or to http url. See https://docs.victoriametrics.com/vmagent.html#relabeling -remoteWrite.roundDigits array Round metric values to this number of decimal digits after the point before writing them to remote storage. Examples: -remoteWrite.roundDigits=2 would round 1.236 to 1.24, while -remoteWrite.roundDigits=-1 would round 126.78 to 130. By default digits rounding is disabled. Set it to 100 for disabling it for a particular remote storage. This option may be used for improving data compression for the stored metrics Supports array of values separated by comma or specified via multiple flags. @@ -1461,6 +1463,12 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -remoteWrite.significantFigures array The number of significant figures to leave in metric values before writing them to remote storage. See https://en.wikipedia.org/wiki/Significant_figures . Zero value saves all the significant figures. This option may be used for improving data compression for the stored metrics. See also -remoteWrite.roundDigits Supports array of values separated by comma or specified via multiple flags. + -remoteWrite.streamAggr.config array + Optional path to file with stream aggregation config. See https://docs.victoriametrics.com/stream-aggregation.html . See also -remoteWrite.streamAggr.keepInput + Supports an array of values separated by comma or specified via multiple flags. + -remoteWrite.streamAggr.keepInput array + Whether to keep input samples after the aggregation with -remoteWrite.streamAggr.config. By default the input is dropped after the aggregation, so only the aggregate data is sent to the -remoteWrite.url. See https://docs.victoriametrics.com/stream-aggregation.html + Supports array of values separated by comma or specified via multiple flags. -remoteWrite.tlsCAFile array Optional path to TLS CA file to use for verifying connections to the corresponding -remoteWrite.url. By default system CA is used Supports an array of values separated by comma or specified via multiple flags. @@ -1482,7 +1490,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . Remote storage URL to write data to. It must support Prometheus remote_write API. It is recommended using VictoriaMetrics as remote storage. Example url: http://:8428/api/v1/write . Pass multiple -remoteWrite.url flags in order to replicate data to multiple remote storage systems. See also -remoteWrite.multitenantURL Supports an array of values separated by comma or specified via multiple flags. -remoteWrite.urlRelabelConfig array - Optional path to relabel config for the corresponding -remoteWrite.url. The path can point either to local file or to http url + Optional path to relabel configs for the corresponding -remoteWrite.url. See also -remoteWrite.relabelConfig. The path can point either to local file or to http url. See https://docs.victoriametrics.com/vmagent.html#relabeling Supports an array of values separated by comma or specified via multiple flags. -sortLabels Whether to sort labels for incoming samples before writing them to all the configured remote storage systems. This may be needed for reducing memory usage at remote 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 diff --git a/app/vmagent/remotewrite/remotewrite.go b/app/vmagent/remotewrite/remotewrite.go index 5a67c4a34..407fd6d13 100644 --- a/app/vmagent/remotewrite/remotewrite.go +++ b/app/vmagent/remotewrite/remotewrite.go @@ -61,9 +61,9 @@ var ( "Excess series are logged and dropped. This can be useful for limiting series churn rate. See https://docs.victoriametrics.com/vmagent.html#cardinality-limiter") streamAggrConfig = flagutil.NewArrayString("remoteWrite.streamAggr.config", "Optional path to file with stream aggregation config. "+ - "See https://docs.victoriametrics.com/stream-aggregation.html ."+ + "See https://docs.victoriametrics.com/stream-aggregation.html . "+ "See also -remoteWrite.streamAggr.keepInput") - streamAggrKeepInput = flagutil.NewArrayBool("remoteWrite.streamAggr.keepInput", "Whether to keep input samples after the aggregation with -remoteWrite.streamAggr.config ."+ + streamAggrKeepInput = flagutil.NewArrayBool("remoteWrite.streamAggr.keepInput", "Whether to keep input samples after the aggregation with -remoteWrite.streamAggr.config. "+ "By default the input is dropped after the aggregation, so only the aggregate data is sent to the -remoteWrite.url. "+ "See https://docs.victoriametrics.com/stream-aggregation.html") ) diff --git a/app/vmalert/README.md b/app/vmalert/README.md index 107529ad6..babe8ffc7 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -734,7 +734,7 @@ If `-remoteWrite.url` command-line flag is configured, vmalert will persist aler [vmui](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui) or Grafana to track how alerts state changed in time. -vmalert stores last `-rule.maxUpdateEntries` (or `update_entries_limit` [per-rule config](https://docs.victoriametrics.com/vmalert.html#alerting-rules)) +vmalert stores last `-rule.updateEntriesLimit` (or `update_entries_limit` [per-rule config](https://docs.victoriametrics.com/vmalert.html#alerting-rules)) state updates for each rule. To check updates, click on `Details` link next to rule's name on `/vmalert/groups` page and check the `Last updates` section: @@ -971,7 +971,7 @@ The shortlist of configuration flags is the following: 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. -notifier.url array - Prometheus alertmanager URL, e.g. http://127.0.0.1:9093. List all Alertmanager URLs if it runs in the cluster mode to ensure high availability. + Prometheus Alertmanager URL, e.g. http://127.0.0.1:9093. List all Alertmanager URLs if it runs in the cluster mode to ensure high availability. Supports an array of values separated by comma or specified via multiple flags. -pprofAuthKey string Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings @@ -1108,8 +1108,6 @@ The shortlist of configuration flags is the following: 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.maxUpdateEntries int - Defines the max number of rule's state updates. (default 20) -rule.resendDelay duration Minimum amount of time to wait before resending an alert to notifier -rule.templates array @@ -1120,6 +1118,8 @@ The shortlist of configuration flags is the following: -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.updateEntriesLimit int + Defines the max number of rule's state updates stored in-memory. Rule's updates are available on rule's Details page and are used for debugging purposes. The number of stored updates can be overriden per rule via update_entries_limit param. (default 20) -rule.validateExpressions Whether to validate rules expressions via MetricsQL engine (default true) -rule.validateTemplates diff --git a/app/vmauth/README.md b/app/vmauth/README.md index b787ca353..9740f9851 100644 --- a/app/vmauth/README.md +++ b/app/vmauth/README.md @@ -270,6 +270,8 @@ See the docs at https://docs.victoriametrics.com/vmauth.html . Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/app/vmbackup/README.md b/app/vmbackup/README.md index 551192856..bd73b0410 100644 --- a/app/vmbackup/README.md +++ b/app/vmbackup/README.md @@ -225,6 +225,8 @@ See [this article](https://medium.com/@valyala/speeding-up-backups-for-big-time- Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/app/vmbackupmanager/README.md b/app/vmbackupmanager/README.md index f98a0fdf1..20775c53f 100644 --- a/app/vmbackupmanager/README.md +++ b/app/vmbackupmanager/README.md @@ -407,6 +407,8 @@ command-line flags: Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/app/vmgateway/README.md b/app/vmgateway/README.md index 0f2df81bf..70772090c 100644 --- a/app/vmgateway/README.md +++ b/app/vmgateway/README.md @@ -311,6 +311,8 @@ The shortlist of configuration flags include the following: Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/app/vminsert/common/streamaggr.go b/app/vminsert/common/streamaggr.go index 40f9357ad..9f4cbc233 100644 --- a/app/vminsert/common/streamaggr.go +++ b/app/vminsert/common/streamaggr.go @@ -15,9 +15,9 @@ import ( var ( streamAggrConfig = flag.String("streamAggr.config", "", "Optional path to file with stream aggregation config. "+ - "See https://docs.victoriametrics.com/stream-aggregation.html ."+ + "See https://docs.victoriametrics.com/stream-aggregation.html . "+ "See also -remoteWrite.streamAggr.keepInput") - streamAggrKeepInput = flag.Bool("streamAggr.keepInput", false, "Whether to keep input samples after the aggregation with -streamAggr.config ."+ + streamAggrKeepInput = flag.Bool("streamAggr.keepInput", false, "Whether to keep input samples after the aggregation with -streamAggr.config. "+ "By default the input is dropped after the aggregation, so only the aggregate data is stored. "+ "See https://docs.victoriametrics.com/stream-aggregation.html") ) diff --git a/app/vmrestore/README.md b/app/vmrestore/README.md index e02a2156d..28295537f 100644 --- a/app/vmrestore/README.md +++ b/app/vmrestore/README.md @@ -129,6 +129,8 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index d83f12215..a22f59132 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -828,6 +828,8 @@ Below is the output for `/path/to/vminsert -help`: Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string @@ -996,6 +998,8 @@ Below is the output for `/path/to/vmselect -help`: Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string @@ -1201,6 +1205,8 @@ Below is the output for `/path/to/vmstorage -help`: Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/docs/README.md b/docs/README.md index 56ea4e324..e81c9c29e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2225,6 +2225,8 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string @@ -2477,6 +2479,10 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 10000000) -storageDataPath string Path to storage data (default "victoria-metrics-data") + -streamAggr.config string + Optional path to file with stream aggregation config. See https://docs.victoriametrics.com/stream-aggregation.html .See also -remoteWrite.streamAggr.keepInput + -streamAggr.keepInput + Whether to keep input samples after the aggregation with -streamAggr.config .By default the input is dropped after the aggregation, so only the aggregate data is stored. See https://docs.victoriametrics.com/stream-aggregation.html -tls Whether to enable TLS for incoming HTTP requests at -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set -tlsCertFile string diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 4fe577056..62d344d82 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -2228,6 +2228,8 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string @@ -2480,6 +2482,10 @@ Pass `-help` to VictoriaMetrics in order to see the list of supported command-li Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 10000000) -storageDataPath string Path to storage data (default "victoria-metrics-data") + -streamAggr.config string + Optional path to file with stream aggregation config. See https://docs.victoriametrics.com/stream-aggregation.html .See also -remoteWrite.streamAggr.keepInput + -streamAggr.keepInput + Whether to keep input samples after the aggregation with -streamAggr.config .By default the input is dropped after the aggregation, so only the aggregate data is stored. See https://docs.victoriametrics.com/stream-aggregation.html -tls Whether to enable TLS for incoming HTTP requests at -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set -tlsCertFile string diff --git a/docs/vmagent.md b/docs/vmagent.md index ff853c436..3f2a18c5e 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -1242,6 +1242,8 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string @@ -1453,7 +1455,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . Optional rate limit in bytes per second for data sent to the corresponding -remoteWrite.url. By default the rate limit is disabled. It can be useful for limiting load on remote storage when big amounts of buffered data is sent after temporary unavailability of the remote storage Supports array of values separated by comma or specified via multiple flags. -remoteWrite.relabelConfig string - Optional path to file with relabel_config entries. The path can point either to local file or to http url. These entries are applied to all the metrics before sending them to -remoteWrite.url. See https://docs.victoriametrics.com/vmagent.html#relabeling for details + Optional path to file with relabeling configs, which are applied to all the metrics before sending them to -remoteWrite.url. See also -remoteWrite.urlRelabelConfig. The path can point either to local file or to http url. See https://docs.victoriametrics.com/vmagent.html#relabeling -remoteWrite.roundDigits array Round metric values to this number of decimal digits after the point before writing them to remote storage. Examples: -remoteWrite.roundDigits=2 would round 1.236 to 1.24, while -remoteWrite.roundDigits=-1 would round 126.78 to 130. By default digits rounding is disabled. Set it to 100 for disabling it for a particular remote storage. This option may be used for improving data compression for the stored metrics Supports array of values separated by comma or specified via multiple flags. @@ -1465,6 +1467,12 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . -remoteWrite.significantFigures array The number of significant figures to leave in metric values before writing them to remote storage. See https://en.wikipedia.org/wiki/Significant_figures . Zero value saves all the significant figures. This option may be used for improving data compression for the stored metrics. See also -remoteWrite.roundDigits Supports array of values separated by comma or specified via multiple flags. + -remoteWrite.streamAggr.config array + Optional path to file with stream aggregation config. See https://docs.victoriametrics.com/stream-aggregation.html . See also -remoteWrite.streamAggr.keepInput + Supports an array of values separated by comma or specified via multiple flags. + -remoteWrite.streamAggr.keepInput array + Whether to keep input samples after the aggregation with -remoteWrite.streamAggr.config. By default the input is dropped after the aggregation, so only the aggregate data is sent to the -remoteWrite.url. See https://docs.victoriametrics.com/stream-aggregation.html + Supports array of values separated by comma or specified via multiple flags. -remoteWrite.tlsCAFile array Optional path to TLS CA file to use for verifying connections to the corresponding -remoteWrite.url. By default system CA is used Supports an array of values separated by comma or specified via multiple flags. @@ -1486,7 +1494,7 @@ See the docs at https://docs.victoriametrics.com/vmagent.html . Remote storage URL to write data to. It must support Prometheus remote_write API. It is recommended using VictoriaMetrics as remote storage. Example url: http://:8428/api/v1/write . Pass multiple -remoteWrite.url flags in order to replicate data to multiple remote storage systems. See also -remoteWrite.multitenantURL Supports an array of values separated by comma or specified via multiple flags. -remoteWrite.urlRelabelConfig array - Optional path to relabel config for the corresponding -remoteWrite.url. The path can point either to local file or to http url + Optional path to relabel configs for the corresponding -remoteWrite.url. See also -remoteWrite.relabelConfig. The path can point either to local file or to http url. See https://docs.victoriametrics.com/vmagent.html#relabeling Supports an array of values separated by comma or specified via multiple flags. -sortLabels Whether to sort labels for incoming samples before writing them to all the configured remote storage systems. This may be needed for reducing memory usage at remote 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 diff --git a/docs/vmalert.md b/docs/vmalert.md index 08e33b64d..e90efa3d9 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -738,7 +738,7 @@ If `-remoteWrite.url` command-line flag is configured, vmalert will persist aler [vmui](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui) or Grafana to track how alerts state changed in time. -vmalert stores last `-rule.maxUpdateEntries` (or `update_entries_limit` [per-rule config](https://docs.victoriametrics.com/vmalert.html#alerting-rules)) +vmalert stores last `-rule.updateEntriesLimit` (or `update_entries_limit` [per-rule config](https://docs.victoriametrics.com/vmalert.html#alerting-rules)) state updates for each rule. To check updates, click on `Details` link next to rule's name on `/vmalert/groups` page and check the `Last updates` section: @@ -975,7 +975,7 @@ The shortlist of configuration flags is the following: 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. -notifier.url array - Prometheus alertmanager URL, e.g. http://127.0.0.1:9093. List all Alertmanager URLs if it runs in the cluster mode to ensure high availability. + Prometheus Alertmanager URL, e.g. http://127.0.0.1:9093. List all Alertmanager URLs if it runs in the cluster mode to ensure high availability. Supports an array of values separated by comma or specified via multiple flags. -pprofAuthKey string Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings @@ -1112,8 +1112,6 @@ The shortlist of configuration flags is the following: 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.maxUpdateEntries int - Defines the max number of rule's state updates. (default 20) -rule.resendDelay duration Minimum amount of time to wait before resending an alert to notifier -rule.templates array @@ -1124,6 +1122,8 @@ The shortlist of configuration flags is the following: -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.updateEntriesLimit int + Defines the max number of rule's state updates stored in-memory. Rule's updates are available on rule's Details page and are used for debugging purposes. The number of stored updates can be overriden per rule via update_entries_limit param. (default 20) -rule.validateExpressions Whether to validate rules expressions via MetricsQL engine (default true) -rule.validateTemplates diff --git a/docs/vmauth.md b/docs/vmauth.md index 4a5fa2fc3..563a6ac65 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -274,6 +274,8 @@ See the docs at https://docs.victoriametrics.com/vmauth.html . Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/docs/vmbackup.md b/docs/vmbackup.md index 032a239b3..ab3438045 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -229,6 +229,8 @@ See [this article](https://medium.com/@valyala/speeding-up-backups-for-big-time- Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/docs/vmbackupmanager.md b/docs/vmbackupmanager.md index 0e129a0d6..1ac6083d3 100644 --- a/docs/vmbackupmanager.md +++ b/docs/vmbackupmanager.md @@ -411,6 +411,8 @@ command-line flags: Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/docs/vmgateway.md b/docs/vmgateway.md index 2eb152af3..06c963316 100644 --- a/docs/vmgateway.md +++ b/docs/vmgateway.md @@ -315,6 +315,8 @@ The shortlist of configuration flags include the following: Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string diff --git a/docs/vmrestore.md b/docs/vmrestore.md index 7504153b2..4bbe3278c 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -133,6 +133,8 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, the remaining errors are suppressed. Zero values disable the rate limit -loggerFormat string Format for logs. Possible values: default, json (default "default") + -loggerJSONFields string + Allows renaming fields in JSON formatted logs. Example: "ts:timestamp,msg:message" renames "ts" to "timestamp" and "msg" to "message". Supported fields: ts, level, caller, msg -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string