RepoMirrors/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus synced 2024-12-25 07:52:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update unit testing rules (#6051)

Browse Source 
* docs: update unit testing rules

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

* More nits fixed

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
This commit is contained in:
Simon Pasquier 2019-09-25 09:26:53 +02:00 committed by GitHub
parent ddff1480a7
commit f6f23a2675
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/configuration/unit_testing_rules.md
View File

@ -50,7 +50,7 @@ input_series:
alert_rule_test:
[ - <alert_test_case> ]
# Unit tests PromQL expressions.
# Unit tests for PromQL expressions.
promql_expr_test:
[ - <promql_test_case> ]
@ -83,7 +83,7 @@ values: <string>
Prometheus allows you to have same alertname for different alerting rules. Hence in this unit testing, you have to list the union of all the firing alerts for the alertname under a single `<alert_test_case>`.
``` yaml
# It's the time elapsed from time=0s when the alerts have to be checked.
# The time elapsed from time=0s when the alerts have to be checked.
eval_time: <duration>
# Name of the alert to be tested.
@ -114,7 +114,7 @@ exp_annotations:
# Expression to evaluate
expr: <string>
# It's the time elapsed from time=0s when the alerts have to be checked.
# The time elapsed from time=0s when the expression has to be evaluated.
eval_time: <duration>
# Expected samples at the given evaluation time.
@ -131,7 +131,7 @@ exp_samples:
# go_goroutines{job="prometheus", instance="localhost:9090"}
labels: <string>
# The expected value of the promql expression.
# The expected value of the PromQL expression.
value: <number>
```