github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

added clarifcation for using vmalert with an existing setup

Browse source
This commit is contained in:
mathias palmersheim 2024-11-05 11:55:07 -06:00
parent d73e5bdb8b
commit 74d77cc510
No known key found for this signature in database
GPG key ID: 187CA27B75688D16
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/VictoriaLogs/vmalert.md
View file

@ -21,7 +21,7 @@ _Note: This page provides only integration instructions for vmalert and Victoria
## Quick Start ## Quick Start
Run vmalert with `-rule.defaultRuleType=vlogs` cmd-line flag. Run vmalert with following arguments.
``` ```
./bin/vmalert -rule=alert.rules \ # Path to the files or http url with alerting and/or recording rules in YAML format. ./bin/vmalert -rule=alert.rules \ # Path to the files or http url with alerting and/or recording rules in YAML format.
-datasource.url=http://localhost:9428 \ # VictoriaLogs address. -datasource.url=http://localhost:9428 \ # VictoriaLogs address.
@ -30,6 +30,7 @@ Run vmalert with `-rule.defaultRuleType=vlogs` cmd-line flag.
-remoteWrite.url=http://localhost:8428 \ # Remote write compatible storage to persist rules and alerts state info (required for recording rules) -remoteWrite.url=http://localhost:8428 \ # Remote write compatible storage to persist rules and alerts state info (required for recording rules)
-remoteRead.url=http://localhost:8428 \ # Prometheus HTTP API compatible datasource to restore alerts state from -remoteRead.url=http://localhost:8428 \ # Prometheus HTTP API compatible datasource to restore alerts state from
``` ```
_Note: If you are using vmalert with existing rules that do not specify a `type:`, then exclude the `-rule.defaultRuleType=vlogs` flag. This will require setting `type: vlogs` for each group but, will prevent existing rules from breaking.
> See the full list of configuration flags and their descriptions in [configuration](#configuration) section. > See the full list of configuration flags and their descriptions in [configuration](#configuration) section.
@ -97,6 +98,7 @@ Examples:
``` ```
groups: groups:
- name: ServiceLog - name: ServiceLog
type: vlogs
interval: 5m interval: 5m
rules: rules:
- alert: HasErrorLog - alert: HasErrorLog
@ -105,6 +107,7 @@ groups:
description: "Service {{$labels.service}} generated {{$labels.errorLog}} error logs in the last 5 minutes" description: "Service {{$labels.service}} generated {{$labels.errorLog}} error logs in the last 5 minutes"
- name: ServiceRequest - name: ServiceRequest
type: vlogs
interval: 5m interval: 5m
rules: rules:
- alert: TooManyFailedRequest - alert: TooManyFailedRequest
@ -119,6 +122,7 @@ Examples:
``` ```
groups: groups:
- name: RequestCount - name: RequestCount
type: vlogs
interval: 5m interval: 5m
rules: rules:
- record: nginxRequestCount - record: nginxRequestCount
@ -138,6 +142,8 @@ By default, vmalert automatically appends the time filter `_time: <group_interva
For instance, the rule below will be evaluated every 5 minutes, and will return the result with logs from the last 5 minutes: For instance, the rule below will be evaluated every 5 minutes, and will return the result with logs from the last 5 minutes:
``` ```
groups: groups:
- name: RequestAlerts
type: vlogs
interval: 5m interval: 5m
rules: rules:
- alert: TooManyFailedRequest - alert: TooManyFailedRequest
@ -149,6 +155,8 @@ User can also specify a customized time filter if needed. For example, rule belo
but will calculate result over the logs from the last 10 minutes. but will calculate result over the logs from the last 10 minutes.
``` ```
groups: groups:
- name: RequestAlerts
type: vlogs
interval: 5m interval: 5m
rules: rules:
- alert: TooManyFailedRequest - alert: TooManyFailedRequest
@ -188,6 +196,7 @@ This expression can also be used in recording rules as follows:
``` ```
groups: groups:
- name: requestDuration - name: requestDuration
type: vlogs
interval: 5m interval: 5m
rules: rules:
- record: requestDurationQuantile - record: requestDurationQuantile