From 94f516df43dd7feebc95dd185fb8f886584af7ce Mon Sep 17 00:00:00 2001 From: Roman Khavronenko Date: Wed, 21 Jun 2023 09:44:00 +0200 Subject: [PATCH] docs/vmalert: specify version requirements for new features (#4480) Signed-off-by: hagen1778 --- app/vmalert/README.md | 12 ++++++++---- docs/vmalert.md | 12 ++++++++---- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/app/vmalert/README.md b/app/vmalert/README.md index 7a56af4fd2..29ebd14c67 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -208,11 +208,13 @@ expr: # Please note, that if rule's query params contain sensitive # information - it will be printed to logs. # Is applicable to alerting rules only. +# Available starting from https://docs.victoriametrics.com/CHANGELOG.html#v1820 [ debug: | default = false ] # Defines the number of rule's updates entries stored in memory # and available for view on rule's Details page. # Overrides `rule.updateEntriesLimit` value for this specific rule. +# Available starting from https://docs.victoriametrics.com/CHANGELOG.html#v1860 [ update_entries_limit: | default 0 ] # Labels to add or overwrite for each alert. @@ -792,7 +794,8 @@ If `-remoteWrite.url` command-line flag is configured, vmalert will persist aler changed in time. 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 +state updates for each rule starting from [v1.86](https://docs.victoriametrics.com/CHANGELOG.html#v1860). +To check updates, click on `Details` link next to rule's name on `/vmalert/groups` page and check the `Last updates` section: vmalert state @@ -804,8 +807,8 @@ moment when rule was evaluated. ### Debug mode -vmalert allows configuring more detailed logging for specific alerting rule. Just set `debug: true` in rule's configuration -and vmalert will start printing additional log messages: +vmalert allows configuring more detailed logging for specific alerting rule starting from [v1.82](https://docs.victoriametrics.com/CHANGELOG.html#v1820). +Just set `debug: true` in rule's configuration and vmalert will start printing additional log messages: ```terminal 2022-09-15T13:35:41.155Z DEBUG rule "TestGroup":"Conns" (2601299393013563564) at 2022-09-15T15:35:41+02:00: query returned 0 samples (elapsed: 5.896041ms) 2022-09-15T13:35:56.149Z DEBUG datasource request: executing POST request with params "denyPartialResponse=true&query=sum%28vm_tcplistener_conns%7Binstance%3D%22localhost%3A8429%22%7D%29+by%28instance%29+%3E+0&step=15s&time=1663248945" @@ -818,7 +821,8 @@ and vmalert will start printing additional log messages: ### Never-firing alerts -vmalert can detect if alert's expression doesn't match any time series in runtime. This problem usually happens +vmalert can detect if alert's expression doesn't match any time series in runtime +starting from [v1.91](https://docs.victoriametrics.com/CHANGELOG.html#v1910). This problem usually happens when alerting expression selects time series which aren't present in the datasource (i.e. wrong `job` label) or there is a typo in the series selector (i.e. `env=rpod`). Such alerting rules will be marked with special icon in vmalerts UI and exposed via `vmalert_alerting_rules_last_evaluation_series_fetched` metric. The metric value will diff --git a/docs/vmalert.md b/docs/vmalert.md index 0727b9425d..4bb91c3b1b 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -219,11 +219,13 @@ expr: # Please note, that if rule's query params contain sensitive # information - it will be printed to logs. # Is applicable to alerting rules only. +# Available starting from https://docs.victoriametrics.com/CHANGELOG.html#v1820 [ debug: | default = false ] # Defines the number of rule's updates entries stored in memory # and available for view on rule's Details page. # Overrides `rule.updateEntriesLimit` value for this specific rule. +# Available starting from https://docs.victoriametrics.com/CHANGELOG.html#v1860 [ update_entries_limit: | default 0 ] # Labels to add or overwrite for each alert. @@ -803,7 +805,8 @@ If `-remoteWrite.url` command-line flag is configured, vmalert will persist aler changed in time. 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 +state updates for each rule starting from [v1.86](https://docs.victoriametrics.com/CHANGELOG.html#v1860). +To check updates, click on `Details` link next to rule's name on `/vmalert/groups` page and check the `Last updates` section: vmalert state @@ -815,8 +818,8 @@ moment when rule was evaluated. ### Debug mode -vmalert allows configuring more detailed logging for specific alerting rule. Just set `debug: true` in rule's configuration -and vmalert will start printing additional log messages: +vmalert allows configuring more detailed logging for specific alerting rule starting from [v1.82](https://docs.victoriametrics.com/CHANGELOG.html#v1820). +Just set `debug: true` in rule's configuration and vmalert will start printing additional log messages: ```terminal 2022-09-15T13:35:41.155Z DEBUG rule "TestGroup":"Conns" (2601299393013563564) at 2022-09-15T15:35:41+02:00: query returned 0 samples (elapsed: 5.896041ms) 2022-09-15T13:35:56.149Z DEBUG datasource request: executing POST request with params "denyPartialResponse=true&query=sum%28vm_tcplistener_conns%7Binstance%3D%22localhost%3A8429%22%7D%29+by%28instance%29+%3E+0&step=15s&time=1663248945" @@ -829,7 +832,8 @@ and vmalert will start printing additional log messages: ### Never-firing alerts -vmalert can detect if alert's expression doesn't match any time series in runtime. This problem usually happens +vmalert can detect if alert's expression doesn't match any time series in runtime +starting from [v1.91](https://docs.victoriametrics.com/CHANGELOG.html#v1910). This problem usually happens when alerting expression selects time series which aren't present in the datasource (i.e. wrong `job` label) or there is a typo in the series selector (i.e. `env=rpod`). Such alerting rules will be marked with special icon in vmalerts UI and exposed via `vmalert_alerting_rules_last_evaluation_series_fetched` metric. The metric value will