diff --git a/app/vmalert-tool/README.md b/app/vmalert-tool/README.md index e254652759..6d706190e9 100644 --- a/app/vmalert-tool/README.md +++ b/app/vmalert-tool/README.md @@ -13,6 +13,7 @@ It will perform the following actions: * checks whether the firing alerts or resulting recording rules match the expected results. See how to run vmalert-tool for unit test below: + ``` # Run vmalert-tool with one or multiple test files via --files cmd-line flag ./vmalert-tool unittest --files test1.yaml --files test2.yaml @@ -26,7 +27,8 @@ which aren't always backward compatible with [PromQL](https://prometheus.io/docs ### Test file format The configuration format for files specified in `--files` cmd-line flag is the following: -``` + +```yaml # Path to the files or http url containing [rule groups](https://docs.victoriametrics.com/vmalert.html#groups) configuration. # Enterprise version of vmalert-tool supports S3 and GCS paths to rules. rule_files: @@ -47,7 +49,7 @@ tests: #### `` -``` +```yaml # Interval between samples for input series interval: # Time series to persist into the database according to configured before running tests. @@ -73,7 +75,7 @@ external_labels: #### `` -``` +```yaml # series in the following format '{