Skip to content

Commit d0b3d1c

Browse files
[feat] improve intro to scenario docs
- Better description with less metaphor - Example Part of #808
1 parent 7718690 commit d0b3d1c

File tree

1 file changed

+19
-5
lines changed
  • src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios

1 file changed

+19
-5
lines changed

Diff for: src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios/01 Executors.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
---
22
title: 'Executors'
3-
excerpt: 'Executors are the workhorses of the k6 execution engine. Each one schedules VUs and iterations differently, and you choose one depending on the type of traffic you want to model to test your services'
3+
excerpt: 'Executors control how k6 schedules VUs and iterations. Choose the executor to model traffic you want to model to test your services'
44
---
55

6-
**Executors** are the workhorses of the k6 execution engine. Each one
7-
schedules VUs and iterations differently, and you'll choose one depending on the type of traffic you
8-
want to model to test your services.
6+
**Executors** control how k6 schedules VUs and iterations.
7+
The executor that you choose depends on the goals of your test and the type of traffic you want to model.
98

9+
Define the executor in `executor` key of the scenario object.
1010
Possible values for `executor` are the executor name separated by hyphens.
1111

12+
13+
```javascript
14+
export const options = {
15+
scenarios: {
16+
arbitrary_scenario_name: {
17+
//Name of executor
18+
executor: 'ramping-vus',
19+
// more configuration here
20+
},
21+
},
22+
};
23+
```
24+
25+
1226
<Blockquote mod="note" title="VUs might not distribute uniformely over iterations">
1327

1428
For any given scenario, you can't guarantee that a specific VU can run a specific iteration.
@@ -24,7 +38,7 @@ But, you _cannot_ reliably map, for example, the tenth VU to the tenth iteration
2438

2539
| Name | Value | Description |
2640
| ---------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
27-
| [Shared iterations](/using-k6/scenarios/executors/shared-iterations) | `shared-iterations` | A fixed amount of iterations are<br/> "shared" between a number of VUs. |
41+
| [Shared iterations](/using-k6/scenarios/executors/shared-iterations) | `shared-iterations` | A fixed amount of iterations are<br/> shared between a number of VUs. |
2842
| [Per VU iterations](/using-k6/scenarios/executors/per-vu-iterations) | `per-vu-iterations` | Each VU executes an exact number of iterations. |
2943
| [Constant VUs](/using-k6/scenarios/executors/constant-vus) | `constant-vus` | A fixed number of VUs execute as many<br/> iterations as possible for a specified amount of time. |
3044
| [Ramping VUs](/using-k6/scenarios/executors/ramping-vus) | `ramping-vus` | A variable number of VUs execute as many<br/> iterations as possible for a specified amount of time. |

0 commit comments

Comments
 (0)