Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-15 08:23:34 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

vmalert: update README

Browse Source
This commit is contained in:
hagen1778 2020-05-14 21:32:58 +01:00 committed by Aliaksandr Valialkin
parent a72f18e821
commit d369450f27
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
app/vmalert/README.md
View File

@ -13,7 +13,7 @@ sends alerts to [Alert Manager](https://github.com/prometheus/alertmanager).
* Lightweight without extra dependencies. * Lightweight without extra dependencies.
### TODO: ### TODO:
* Configuration hot reload. * Support recording rules.
### QuickStart ### QuickStart
@ -120,3 +120,22 @@ or send GET request to `/-/reload` endpoint.
`vmalert` is mostly designed and built by VictoriaMetrics community. `vmalert` is mostly designed and built by VictoriaMetrics community.
Feel free to share your experience and ideas for improving this Feel free to share your experience and ideas for improving this
software. Please keep simplicity as the main priority. software. Please keep simplicity as the main priority.
### How to build from sources
It is recommended using
[binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases)
- `vmalert` is located in `vmutils-*` archives there.
#### Development build
1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.13.
2. Run `make vmalert` from the root folder of the repository.
It builds `vmalert` binary and puts it into the `bin` folder.
#### Production build
1. [Install docker](https://docs.docker.com/install/).
2. Run `make vmalert-prod` from the root folder of the repository.
It builds `vmalert-prod` binary and puts it into the `bin` folder.