Skip to content

Commit 38ff262

Browse files
[feat] clarify and standardize executor intros
Hopefully simpler language makes it more understandable, and standardized structure makes it easier to scan from page to page. - Standardize structure - Less words - Use "shortcut" instead of "global option".
1 parent 30eb7b8 commit 38ff262

File tree

6 files changed

+32
-33
lines changed

6 files changed

+32
-33
lines changed

src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios/01 Executors/01 shared-iterations.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,21 @@ title: 'Shared iterations'
33
excerpt: 'A fixed number of iterations are "shared" between a number of VUs, and the test ends once all iterations are executed.'
44
---
55

6-
## Description
6+
The `shared-iterations` executor shares iterations between the number of VUs.
7+
The test ends once k6 executes all iterations.
78

8-
In this executor, the iterations are shared between the number of VUs.
9-
The test ends once all iterations are executed. This executor is equivalent to the global [vus](/using-k6/k6-options/reference#vus) and [iterations](/using-k6/k6-options/reference#iterations) shortcut options.
9+
For a shortcut to this executor, use the [vus](/using-k6/k6-options/reference#vus) and [iterations](/using-k6/k6-options/reference#iterations) options.
10+
11+
<Blockquote mod="note" title="">
1012

1113
Iterations **are not guaranteed to be evenly distributed** with this executor.
1214
VU that executes faster will complete more iterations than slower VUs.
1315

1416
To guarantee that every VU completes a specific, fixed number of iterations, [use the per-VU iterations executor](/using-k6/scenarios/executors/per-vu-iterations).
1517

18+
</Blockquote>
19+
20+
1621
## Options
1722

1823
Besides the [common configuration options](/using-k6/scenarios#options),

src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios/01 Executors/02 per-vu-iterations.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@ title: 'Per VU iterations'
33
excerpt: 'Each VU executes an exact number of iterations.'
44
---
55

6-
## Description
7-
8-
Each VU executes an exact number of iterations. The total number of completed
9-
iterations will be `vus * iterations`.
6+
With the `per-vu-iterations` executor, each VU executes an exact number of iterations.
7+
The total number of completed iterations equals `vus * iterations`.
108

119
## Options
1210

src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios/01 Executors/03 constant-vus.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@ title: 'Constant VUs'
33
excerpt: 'A fixed number of VUs execute as many iterations as possible for a specified amount of time.'
44
---
55

6-
## Description
6+
With the `constant-vus` executor, a fixed number of VUs execute as many iterations as possible for a specified amount of time.
77

8-
A fixed number of VUs execute as many iterations as possible for a specified amount
9-
of time. This executor is equivalent to the global [vus](/using-k6/options#vus) and [duration](/using-k6/options#duration) options.
8+
For a shortcut to this executor, use the [vus](/using-k6/options#vus) and [duration](/using-k6/options#duration) options.
109

1110
## Options
1211

src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios/01 Executors/04 ramping-vus.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@ title: 'Ramping VUs'
33
excerpt: 'A variable number of VUs execute as many iterations as possible for a specified amount of time.'
44
---
55

6-
## Description
6+
With the `ramping-vus` executor, a variable number of VUs executes as many iterations as possible for a specified amount of time.
77

8-
A variable number of VUs execute as many iterations as possible for a specified
9-
amount of time. This executor is equivalent to the global [stages](/using-k6/options#stages) option.
8+
For a shortcut to this executor, use the [stages](/using-k6/options#stages) option.
109

1110
## Options
1211

src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios/01 Executors/05 constant-arrival-rate.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,14 @@ title: 'Constant arrival rate'
33
excerpt: 'A fixed number of iterations are started in a specified period of time.'
44
---
55

6-
## Description
6+
With the `constant-arrival-rate` executor, k6 starts a fixed number of iterations over a specified period of time.
7+
It is an open-model executor, meaning iterations start independently of system response (for details, read
8+
[Open and Closed models](/using-k6/scenarios/concepts/open-vs-closed).
79

8-
A fixed number of iterations are started in a specified period of time.
9-
This executor will continue to start iterations at the given rate as long as there are VUs
10-
available to run them. Since iteration execution time can vary because of test logic or the
11-
system-under-test responding more slowly, this executor will try to compensate
12-
by running a variable number of VUs&mdash;including potentially initializing more in the middle
13-
of the test&mdash;to meet the configured iteration rate. This approach is
14-
useful for a more accurate representation of RPS, for example.
15-
16-
For explanations about how this executor works, refer to [Open and Closed models](/using-k6/scenarios/concepts/open-vs-closed)
17-
and [Arrival-rate VU allocation](/using-k6/scenarios/concepts/arrival-rate-vu-allocation).
10+
This executor continues to start iterations at the given rate as long as VUs are available.
11+
The time to execute an iteration can vary with test logic or the system-under-test response time.
12+
To compensate for this, the executor starts a varied number of VUs to meet the configured iteration rate.
13+
For explanations of how allocation works, read [Arrival-rate VU allocation](/using-k6/scenarios/concepts/arrival-rate-vu-allocation).
1814

1915
<Blockquote mod="Note" title="">
2016

@@ -42,6 +38,8 @@ this executor has the following options:
4238

4339
When you want to maintain a constant number of iterations without being affected by the
4440
performance of the system under test.
41+
This approach is useful for a more accurate representation of RPS, for example.
42+
4543

4644
<Blockquote mod="note" title="">
4745

@@ -54,7 +52,7 @@ So it's unnecessary to use a `sleep()` function at the end of the VU code.
5452

5553
## Example
5654

57-
In this example, we'll start a constant rate of 30 iterations per second for 30 seconds, allowing k6 to dynamically schedule up to 50 VUs.
55+
This example starts a constant rate of 30 iterations per second for 30 seconds, allowing k6 to dynamically schedule up to 50 VUs.
5856

5957
<CodeGroup labels={[ "constant-arr-rate.js" ]} lineNumbers={[true]}>
6058

src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios/01 Executors/06 ramping-arrival-rate.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: 'Ramping arrival rate'
33
excerpt: 'A variable number of iterations are started in a specified period of time.'
44
---
55

6-
## Description
6+
With the `ramping-arrival-rate` executor, k6 starts iterations at a variable rate.
7+
It is an open-model executor, meaning iterations start independently of system response (for details, read
8+
[Open and Closed models](/using-k6/scenarios/concepts/open-vs-closed).
79

8-
A variable number of iterations are started in specified periods of time. This is
9-
similar to the [ramping VUs executor](/using-k6/scenarios/executors/ramping-vus/), but for iterations instead.
10-
k6 will attempt to dynamically change the number of VUs to achieve the configured iteration rate.
11-
12-
For explanations about how this executor works, refer to [Open and Closed models](/using-k6/scenarios/concepts/open-vs-closed)
13-
and [Arrival-rate VU allocation](/using-k6/scenarios/concepts/arrival-rate-vu-allocation).
10+
This executor has _stages_ that configure target number of iterations and the time k6 takes to reach or stay at this target.
11+
Unlike the [ramping VUs executor](/using-k6/scenarios/executors/ramping-vus/), which configures VUs,
12+
this executor dynamically changes the number of iterations to start, and starts these iterations as long as the test has enough allocated VUs.
13+
To learn how allocation works, read [Arrival-rate VU allocation](/using-k6/scenarios/concepts/arrival-rate-vu-allocation).
1414

1515
<Blockquote mod="Note" title="">
1616

@@ -37,7 +37,7 @@ this executor has the following options:
3737
## When to use
3838

3939
If you need your tests to not be affected by the system-under-test's performance, and
40-
would like to ramp the number of iterations up or down during specific periods of time.
40+
want to ramp the number of iterations up or down during specific periods of time.
4141

4242
<Blockquote mod="note" title="">
4343

0 commit comments

Comments
 (0)