You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/data/markdown/docs/40 xk6-disruptor/00 About.md
+8-22Lines changed: 8 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: 'Welcome'
2
+
title: 'About'
3
3
heading: 'xk6-disruptor Documentation'
4
4
head_title: 'xk6-disruptor Documentation'
5
5
excerpt: 'xk6-disruptor is a k6 extension providing fault injection capabilities to test system reliability under turbulent conditions.'
@@ -21,24 +21,6 @@ It provides a Javascript API to inject different [faults](/javascript-api/xk6-di
21
21
22
22
Other types of faults and disruptors will be introduced in the future. The [Roadmap](https://github.com/grafana/xk6-disruptor/blob/main/ROADMAP.md) presents the project's goals for the coming months regarding new functionalities and enhancements.
23
23
24
-
```javascript
25
-
exportdefaultfunction () {
26
-
// Create a new pod disruptor with a selector
27
-
// that matches pods from the "default" namespace with the label "app=my-app"
// Disrupt the targets by injecting HTTP faults into them for 30 seconds
34
-
constfault= {
35
-
averageDelay:500,
36
-
errorRate:0.1,
37
-
errorCode:500
38
-
}
39
-
disruptor.injectHTTPFaults(fault, "30s")
40
-
}
41
-
```
42
24
43
25
## Use cases
44
26
@@ -59,11 +41,15 @@ Common use cases are:
59
41
60
42
## Learn more
61
43
62
-
Check the [requirements](/javascript-api/xk6-disruptor/get-started/requirements/), [installation](/javascript-api/xk6-disruptor/get-started/installation/), and [how to expose your application](/javascript-api/xk6-disruptor/get-started/expose-your-application/) to get started with the disruptor.
44
+
Lear more about [Fault injection](https://k6.io/blog/democratize-chaos-testing/) and [Building Resilience early in the development cycle](https://k6.io/blog/building-resilience-early-in-the-development-cycle/).
63
45
64
-
This documentation presents a few [examples of injecting faults in different scenarios](/javascript-api/xk6-disruptor/examples/).
46
+
Check the [first steps](/javascript-api/xk6-disruptor/get-started/first-steps) to get started with the disruptor.
65
47
66
-
Also, an [interactive demo environment in Killercoda](https://killercoda.com/grafana-xk6-disruptor/scenario/killercoda) is available to use the k6 disruptor right away. You can fail the services of a demo application without having to install Kubernetes on your local machine.
48
+
Follow the [examples of injecting faults in different scenarios](/javascript-api/xk6-disruptor/examples/).
49
+
50
+
Visit the [interactive demo environment in Killercoda](https://killercoda.com/grafana-xk6-disruptor/scenario/killercoda) and try the disruptor in a demo application without having to do any setup.
51
+
52
+
## Contributing
67
53
68
54
For any unexpected behavior, please search the [GitHub issues](https://github.com/grafana/xk6-disruptor/issues) first.
69
55
Collapse file: src/data/markdown/docs/40 xk6-disruptor/01 Get started.md
excerpt: 'xk6-disruptor is a k6 extension providing fault injection capabilities to k6.'
6
+
---
7
+
8
+
[xk6-disruptor](https://github.com/grafana/xk6-disruptor) is an extension that adds fault injection capabilities to k6.
9
+
10
+
It provides a Javascript [API]((/javascript-api/xk6-disruptor/api)) to inject [faults](/javascript-api/xk6-disruptor/api/faults/) such as errors and delays into HTTP and gRPC requests served by selected Kubernetes [Pods](/javascript-api/xk6-disruptor/api/poddisruptor) or [Services](/javascript-api/xk6-disruptor/api/servicedisruptor).
0 commit comments