-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Alex Orfanos
committed
Dec 11, 2020
1 parent
f1a0ba1
commit bf8830e
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# vmalertcli | ||
|
||
A CLI application to manage VictoriaMetrics vmalert. | ||
|
||
All actions return JSON objects (prettyprint TBA), so usage of `jq` is good for formatting output. | ||
|
||
### Help menu | ||
|
||
``` | ||
vmalertcli -h | ||
Usage of vmalertcli: | ||
-action="groups": VMAlert action to take {groups|alerts|metrics|reload} | ||
-host="localhost": Host where VMAlert responds | ||
-port=8880: VMAlert port | ||
``` | ||
|
||
### Installation | ||
|
||
Put binary in $PATH (release will be updated). | ||
|
||
### Usage | ||
|
||
View alert groups: | ||
``` | ||
vmalertcli -action groups | jq | ||
``` | ||
|
||
View VMAlert metrics: | ||
``` | ||
vmalertcli -action metrics | ||
``` | ||
|
||
Hot-reload VMAlert configuration: | ||
``` | ||
vmalertcli -action reload | ||
``` | ||
|
||
View active (firing) alerts: | ||
``` | ||
vmalertcli -action alerts | ||
``` |