Skip to content

Commit 2ede1c2

Browse files
docs: update links for ensure and expect docs (#3508)
1 parent ad2aa81 commit 2ede1c2

File tree

2 files changed

+4
-35
lines changed

2 files changed

+4
-35
lines changed

packages/artillery-plugin-ensure/README.md

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,12 @@
11
# Metric / SLO checks with Artillery
22

3-
With this plugin Artillery can validate if a metric meets a predefined threshold or condition. You can create simple checks, e.g. that `p95` response time is <250ms, or more complex conditions which are based on several metrics.
3+
With this plugin Artillery can validate if a metric meets a predefined threshold or condition.
44

55
If an `ensure` check fails Artillery will exit with a non-zero exit code. This is useful in CI/CD pipelines for automatic quality checks and as a way to check that SLOs are met.
66

7-
Docs: https://www.artillery.io/docs/reference/extensions/ensure
7+
## Documentation
88

9-
## Example
10-
11-
In the following example, we set three `ensure` checks:
12-
13-
1. The first one checks that HTTP response time `p95` is <= 1000ms, with a `threshold` check
14-
2. The second one uses a more complex conditional expression, and checks that HTTP response time `p99` is less than 2000ms **and** that at least 10 virtual users were launched
15-
3. The third check makes sure that all virtual user scenarios completed successfully
16-
17-
```yaml
18-
config:
19-
target: "https://www.artillery.io"
20-
plugins:
21-
ensure: {}
22-
phases:
23-
- duration: 10
24-
arrivalRate: 1
25-
ensure:
26-
thresholds:
27-
- engine.http.response_time.p95: 1000
28-
conditions:
29-
- expression: engine.http.response_time.p99 < 2000 and core.vusers.created.total > 10
30-
strict: false
31-
- expression: core.vusers.failed == 0
32-
scenarios:
33-
- flow:
34-
- get:
35-
url: "/"
36-
- get:
37-
url: "/docs"
38-
- get:
39-
url: "/integrations"
40-
```
9+
📖 [Plugin documentation](https://www.artillery.io/docs/reference/extensions/ensure)
4110

4211
## License
4312

packages/artillery-plugin-expect/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Documentation
1414

15-
📖 [Plugin documentation](https://artillery.io/docs/guides/plugins/plugin-expectations-assertions.html)
15+
📖 [Plugin documentation](https://www.artillery.io/docs/reference/extensions/expect)
1616

1717
## Feedback, Bugs, Issues
1818

0 commit comments

Comments
 (0)