From 3c0470f91e370e35a8f1ed85aa5abf4280324f2c Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Mon, 8 May 2023 16:21:42 -0700 Subject: [PATCH] docs/vmalert.md: clarify docs regarding the support of recursive globs Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4041 --- app/vmalert/README.md | 4 ++-- app/vmalert/main.go | 4 ++-- docs/CHANGELOG.md | 2 +- docs/vmalert.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/app/vmalert/README.md b/app/vmalert/README.md index 61dca921f..aa5dd6611 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -1182,7 +1182,7 @@ The shortlist of configuration flags is the following: -rule="/path/to/file". Path to a single file with alerting rules. -rule="http:///path/to/rules". HTTP URL to a page with alerting rules. -rule="dir/*.yaml" -rule="/*.yaml" -rule="gcs://vmalert-rules/tenant_%{TENANT_ID}/prod". - -rule="dir/**/*.yaml". Includes to all .yaml files in "dir" folder and it's subfolders recursively. + -rule="dir/**/*.yaml". Includes all the .yaml files in "dir" subfolders recursively. Rule files may contain %{ENV_VAR} placeholders, which are substituted by the corresponding env vars. Enterprise version of vmalert supports S3 and GCS paths to rules. @@ -1205,7 +1205,7 @@ The shortlist of configuration flags is the following: -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.templates="dir/**/*.tpl". Includes to all .tpl files in "dir" folder and it's subfolders recursively. + -rule.templates="dir/**/*.tpl". Includes all the .tpl files in "dir" subfolders recursively. 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) diff --git a/app/vmalert/main.go b/app/vmalert/main.go index eab42d7a6..19524b1e9 100644 --- a/app/vmalert/main.go +++ b/app/vmalert/main.go @@ -35,7 +35,7 @@ Examples: -rule="/path/to/file". Path to a single file with alerting rules. -rule="http:///path/to/rules". HTTP URL to a page with alerting rules. -rule="dir/*.yaml" -rule="/*.yaml" -rule="gcs://vmalert-rules/tenant_%{TENANT_ID}/prod". - -rule="dir/**/*.yaml". Includes to all .yaml files in "dir" folder and it's subfolders recursively. + -rule="dir/**/*.yaml". Includes all the .yaml files in "dir" subfolders recursively. Rule files may contain %{ENV_VAR} placeholders, which are substituted by the corresponding env vars. Enterprise version of vmalert supports S3 and GCS paths to rules. @@ -51,7 +51,7 @@ 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.templates="dir/**/*.tpl". Includes to all .tpl files in "dir" folder and it's subfolders recursively. + -rule.templates="dir/**/*.tpl". Includes all the .tpl files in "dir" subfolders recursively. `) rulesCheckInterval = flag.Duration("rule.configCheckInterval", 0, "Interval for checking for changes in '-rule' files. "+ diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 62b861f5b..7adfc9439 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -37,7 +37,7 @@ The following tip changes can be tested by building VictoriaMetrics components f * FEATURE: [vmui](https://docs.victoriametrics.com/#vmui): add `WITH template` playground to `vmui`. See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3811). * FEATURE: [vmui](https://docs.victoriametrics.com/#vmui): add a comparison of data from the previous day with data from the current day to the `Cardinality Explorer`. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3967). * FEATURE: [vmui](https://docs.victoriametrics.com/#vmui): display histogram metrics as a heatmap in the `explore metrics` tab. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4111). -* FEATURE: [vmalert](https://docs.victoriametrics.com/vmalert.html): add support of recursive globs for `-rule` and `-rule.templates` by using `**` in the glob pattern. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4041). +* FEATURE: [vmalert](https://docs.victoriametrics.com/vmalert.html): add support of recursive globs for `-rule` and `-rule.templates` command-line flags by using `**` in the glob pattern. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4041). * FEATURE: [vmui](https://docs.victoriametrics.com/#vmui): add the metric relabel playground feature to the vmui. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3807). * FEATURE: [vmauth](https://docs.victoriametrics.com/vmauth.html): add ability to filter incoming requests by IP. See [these docs](https://docs.victoriametrics.com/vmauth.html#ip-filters) and [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3491). * FEATURE: [vmauth](https://docs.victoriametrics.com/vmauth.html): add ability to proxy requests for unauthorized users. See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4083). diff --git a/docs/vmalert.md b/docs/vmalert.md index f416524af..082fd35a5 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -1186,7 +1186,7 @@ The shortlist of configuration flags is the following: -rule="/path/to/file". Path to a single file with alerting rules. -rule="http:///path/to/rules". HTTP URL to a page with alerting rules. -rule="dir/*.yaml" -rule="/*.yaml" -rule="gcs://vmalert-rules/tenant_%{TENANT_ID}/prod". - -rule="dir/**/*.yaml". Includes to all .yaml files in "dir" folder and it's subfolders recursively. + -rule="dir/**/*.yaml". Includes all the .yaml files in "dir" subfolders recursively. Rule files may contain %{ENV_VAR} placeholders, which are substituted by the corresponding env vars. Enterprise version of vmalert supports S3 and GCS paths to rules. @@ -1209,7 +1209,7 @@ The shortlist of configuration flags is the following: -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.templates="dir/**/*.tpl". Includes to all .tpl files in "dir" folder and it's subfolders recursively. + -rule.templates="dir/**/*.tpl". Includes all the .tpl files in "dir" subfolders recursively. 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)