github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2025-01-10 15:14:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs/vmalert: specify version requirements for new features (#4480)

Browse source 
Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
Roman Khavronenko 2023-06-21 09:44:00 +02:00 committed by GitHub
parent 1ebfea34d4
commit 94f516df43
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
app/vmalert/README.md
View file

@ -208,11 +208,13 @@ expr: <string>
# Please note, that if rule's query params contain sensitive # Please note, that if rule's query params contain sensitive
# information - it will be printed to logs. # information - it will be printed to logs.
# Is applicable to alerting rules only. # Is applicable to alerting rules only.
# Available starting from https://docs.victoriametrics.com/CHANGELOG.html#v1820
[ debug: <bool> | default = false ] [ debug: <bool> | default = false ]
# Defines the number of rule's updates entries stored in memory # Defines the number of rule's updates entries stored in memory
# and available for view on rule's Details page. # and available for view on rule's Details page.
# Overrides `rule.updateEntriesLimit` value for this specific rule. # Overrides `rule.updateEntriesLimit` value for this specific rule.
# Available starting from https://docs.victoriametrics.com/CHANGELOG.html#v1860
[ update_entries_limit: <integer> | default 0 ] [ update_entries_limit: <integer> | default 0 ]
# Labels to add or overwrite for each alert. # 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. changed in time.
vmalert stores last `-rule.updateEntriesLimit` (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 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: and check the `Last updates` section:
<img alt="vmalert state" src="vmalert_state.png"> <img alt="vmalert state" src="vmalert_state.png">
@ -804,8 +807,8 @@ moment when rule was evaluated.
### Debug mode ### Debug mode
vmalert allows configuring more detailed logging for specific alerting rule. Just set `debug: true` in rule's configuration vmalert allows configuring more detailed logging for specific alerting rule starting from [v1.82](https://docs.victoriametrics.com/CHANGELOG.html#v1820).
and vmalert will start printing additional log messages: Just set `debug: true` in rule's configuration and vmalert will start printing additional log messages:
```terminal ```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: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" 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 ### 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) 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 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 vmalerts UI and exposed via `vmalert_alerting_rules_last_evaluation_series_fetched` metric. The metric value will

12
docs/vmalert.md
View file

@ -219,11 +219,13 @@ expr: <string>
# Please note, that if rule's query params contain sensitive # Please note, that if rule's query params contain sensitive
# information - it will be printed to logs. # information - it will be printed to logs.
# Is applicable to alerting rules only. # Is applicable to alerting rules only.
# Available starting from https://docs.victoriametrics.com/CHANGELOG.html#v1820
[ debug: <bool> | default = false ] [ debug: <bool> | default = false ]
# Defines the number of rule's updates entries stored in memory # Defines the number of rule's updates entries stored in memory
# and available for view on rule's Details page. # and available for view on rule's Details page.
# Overrides `rule.updateEntriesLimit` value for this specific rule. # Overrides `rule.updateEntriesLimit` value for this specific rule.
# Available starting from https://docs.victoriametrics.com/CHANGELOG.html#v1860
[ update_entries_limit: <integer> | default 0 ] [ update_entries_limit: <integer> | default 0 ]
# Labels to add or overwrite for each alert. # 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. changed in time.
vmalert stores last `-rule.updateEntriesLimit` (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 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: and check the `Last updates` section:
<img alt="vmalert state" src="vmalert_state.png"> <img alt="vmalert state" src="vmalert_state.png">
@ -815,8 +818,8 @@ moment when rule was evaluated.
### Debug mode ### Debug mode
vmalert allows configuring more detailed logging for specific alerting rule. Just set `debug: true` in rule's configuration vmalert allows configuring more detailed logging for specific alerting rule starting from [v1.82](https://docs.victoriametrics.com/CHANGELOG.html#v1820).
and vmalert will start printing additional log messages: Just set `debug: true` in rule's configuration and vmalert will start printing additional log messages:
```terminal ```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: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" 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 ### 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) 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 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 vmalerts UI and exposed via `vmalert_alerting_rules_last_evaluation_series_fetched` metric. The metric value will