vmalert-tool

vmalert-tool

https://docs.victoriametrics.com/vmalert-tool/

Unit testing for rules

https://docs.victoriametrics.com/vmalert-tool/#unit-testing-for-rules

You can use vmalert-tool to run unit tests for alerting and recording rules. It will perform the following actions:

• sets up an isolated VictoriaMetrics instance;
• simulates the periodic ingestion of time series;
• queries the ingested data for recording and alerting rules evaluation like https://docs.victoriametrics.com/vmalert/;
• 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

vmalert-tool unittest is compatible with Prometheus config format for tests (https://prometheus.io/docs/prometheus/latest/configuration/unit_testing_rules/#test-file-format except) promql_expr_test field. Use metricsql_expr_test field name instead. The name is different because vmalert-tool validates and executes MetricsQL (https://docs.victoriametrics.com/metricsql/) expressions, which aren’t always backward compatible with PromQL (https://prometheus.io/docs/prometheus/latest/querying/basics/).