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.md: follow-up after 7748a9d629

Browse source 
- Consistently use single dash in front of command-line flags instead of double dashes.
- Add a warning that too small -search.latencyOffset may lead to incomplete query results.
This commit is contained in:
Aliaksandr Valialkin 2022-09-26 08:36:22 +03:00
parent b68cd810fc
commit 6b71f33c8b
No known key found for this signature in database
GPG key ID: A72BEC6CD3D0DED1
2 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
app/vmalert/README.md
View file

@ -620,7 +620,7 @@ There are following non-required `replay` flags:
Progress bar may generate a lot of log records, which is not formatted as standard VictoriaMetrics logger.
It could break logs parsing by external system and generate additional load on it.
See full description for these flags in `./vmalert --help`.
See full description for these flags in `./vmalert -help`.
### Limitations
@ -650,9 +650,10 @@ may get empty response from datasource and produce empty recording rules or rese
<img alt="vmalert evaluation when data is delayed" src="vmalert_ts_data_delay.gif">
_Please note, by default recently written datapoints to VictoriaMetrics aren't visible for queries up to 30s.
This behavior is controlled by `--search.latencyOffset` command-line flag on vmselect. Usually, this results into
a 30s shift for recording rules results._
_By default recently written samples to VictoriaMetrics aren't visible for queries for up to 30s.
This behavior is controlled by `-search.latencyOffset` command-line flag on vmselect. Usually, this results into
a 30s shift for recording rules results.
Note that too small value passed to `-search.latencyOffset` may lead to incomplete query results._
Try the following recommendations in such cases:

9
docs/vmalert.md
View file

@ -624,7 +624,7 @@ There are following non-required `replay` flags:
Progress bar may generate a lot of log records, which is not formatted as standard VictoriaMetrics logger.
It could break logs parsing by external system and generate additional load on it.
See full description for these flags in `./vmalert --help`.
See full description for these flags in `./vmalert -help`.
### Limitations
@ -654,9 +654,10 @@ may get empty response from datasource and produce empty recording rules or rese
<img alt="vmalert evaluation when data is delayed" src="vmalert_ts_data_delay.gif">
_Please note, by default recently written datapoints to VictoriaMetrics aren't visible for queries up to 30s.
This behavior is controlled by `--search.latencyOffset` command-line flag on vmselect. Usually, this results into
a 30s shift for recording rules results._
_By default recently written samples to VictoriaMetrics aren't visible for queries for up to 30s.
This behavior is controlled by `-search.latencyOffset` command-line flag on vmselect. Usually, this results into
a 30s shift for recording rules results.
Note that too small value passed to `-search.latencyOffset` may lead to incomplete query results._
Try the following recommendations in such cases: