Skip to content

Commit

Permalink
Typo fix in fix-load documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Vivek Jha <[email protected]>
  • Loading branch information
duckling69 committed May 16, 2024
1 parent c5a569f commit 552c3cb
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/v0.2/Rate_Controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,14 +129,14 @@ The linear rate controller can be used in both duration-based and transaction nu
{
"type": "linear-rate",
"opts": {
"startingTps": 25,
"startTps": 25,
"finishingTps": 75
}
}
```

The linear rate controller can be specified by setting the rate controller `type` to the `linear-rate` string. The available options (`opts` property) are the following:
* `startingTps`: the TPS at the beginning of the round.
* `startTps`: the TPS at the beginning of the round.
* `finishingTps`: the TPS at the end of the round.

**Note:** similarly to the [fixed rate controller](#fixed-rate), this controller also divides the workload between the available client, so the specified rates in the configuration are cumulative rates, and not the rates of individual clients. Using the above configuration with 5 clients results in clients that start at 5 TPS and finish at 15 TPS. Together they generate a [25-75] TPS load.
Expand Down
6 changes: 3 additions & 3 deletions docs/v0.3.2/Rate_Controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The PID rate controller, targeting a backlog of 5 transactions with a starting T
"type": "fixed-backlog",
"opts": {
"unfinished_per_client": 5,
"startingTps": 100
"startTps": 100
}
}
```
Expand Down Expand Up @@ -128,14 +128,14 @@ The linear rate controller can be used in both duration-based and transaction nu
{
"type": "linear-rate",
"opts": {
"startingTps": 25,
"startTps": 25,
"finishingTps": 75
}
}
```

The linear rate controller can be specified by setting the rate controller `type` to the `linear-rate` string. The available options (`opts` property) are the following:
* `startingTps`: the TPS at the beginning of the round.
* `startTps`: the TPS at the beginning of the round.
* `finishingTps`: the TPS at the end of the round.

**Note:** similarly to the [fixed rate controller](#fixed-rate), this controller also divides the workload between the available client, so the specified rates in the configuration are cumulative rates, and not the rates of individual clients. Using the above configuration with 5 clients results in clients that start at 5 TPS and finish at 15 TPS. Together they generate a [25-75] TPS load.
Expand Down
8 changes: 4 additions & 4 deletions docs/v0.4.2/Rate_Controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The fixed load rate controller is a controller for driving the tests at a target
The fixed-load controller can be specified by setting the rate controller `type` to the `fixed-load` string.

Controller options include:
- `startingTps`: the initial rate at which transactions are cumulatively sent to the SUT by all workers
- `startTps`: the initial rate at which transactions are cumulatively sent to the SUT by all workers
- `transactionLoad`: the number of transactions being processed by the SUT that is to be maintained

The fixed load controller, aiming to maintain a SUT transaction load of 5, with a starting TPS of 100, is specified through the following controller option:
Expand All @@ -79,7 +79,7 @@ The fixed load controller, aiming to maintain a SUT transaction load of 5, with
"type": "fixed-load",
"opts": {
"transactionLoad": 5,
"startingTps": 100
"startTps": 100
}
}
```
Expand Down Expand Up @@ -126,7 +126,7 @@ The linear rate controller can be used in both duration-based and transaction nu
The linear rate controller can be specified by setting the rate controller `type` to the `linear-rate` string.

Controller options include:
- `startingTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the start of the round
- `startTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the start of the round
- `finishingTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the end of the round

The following example specifies a rate controller that gradually changes the transaction load from 25 TPS to 75 TPS during the benchmark round.
Expand All @@ -135,7 +135,7 @@ The following example specifies a rate controller that gradually changes the tra
{
"type": "linear-rate",
"opts": {
"startingTps": 25,
"startTps": 25,
"finishingTps": 75
}
}
Expand Down
8 changes: 4 additions & 4 deletions docs/v0.5.0/Rate_Controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The fixed load rate controller is a controller for driving the tests at a target
The fixed-load controller can be specified by setting the rate controller `type` to the `fixed-load` string.

Controller options include:
- `startingTps`: the initial rate at which transactions are cumulatively sent to the SUT by all workers
- `startTps`: the initial rate at which transactions are cumulatively sent to the SUT by all workers
- `transactionLoad`: the number of transactions being processed by the SUT that is to be maintained

The fixed load controller, aiming to maintain a SUT transaction load of 5, with a starting TPS of 100, is specified through the following controller option:
Expand All @@ -79,7 +79,7 @@ The fixed load controller, aiming to maintain a SUT transaction load of 5, with
"type": "fixed-load",
"opts": {
"transactionLoad": 5,
"startingTps": 100
"startTps": 100
}
}
```
Expand Down Expand Up @@ -126,7 +126,7 @@ The linear rate controller can be used in both duration-based and transaction nu
The linear rate controller can be specified by setting the rate controller `type` to the `linear-rate` string.

Controller options include:
- `startingTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the start of the round
- `startTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the start of the round
- `finishingTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the end of the round

The following example specifies a rate controller that gradually changes the transaction load from 25 TPS to 75 TPS during the benchmark round.
Expand All @@ -135,7 +135,7 @@ The following example specifies a rate controller that gradually changes the tra
{
"type": "linear-rate",
"opts": {
"startingTps": 25,
"startTps": 25,
"finishingTps": 75
}
}
Expand Down
8 changes: 4 additions & 4 deletions docs/v0.6.0/Rate_Controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The fixed load rate controller is a controller for driving the tests at a target
The fixed-load controller can be specified by setting the rate controller `type` to the `fixed-load` string.

Controller options include:
- `startingTps`: the initial rate at which transactions are cumulatively sent to the SUT by all workers
- `startTps`: the initial rate at which transactions are cumulatively sent to the SUT by all workers
- `transactionLoad`: the number of transactions being processed by the SUT that is to be maintained

The fixed load controller, aiming to maintain a SUT transaction load of 5, with a starting TPS of 100, is specified through the following controller option:
Expand All @@ -79,7 +79,7 @@ The fixed load controller, aiming to maintain a SUT transaction load of 5, with
"type": "fixed-load",
"opts": {
"transactionLoad": 5,
"startingTps": 100
"startTps": 100
}
}
```
Expand Down Expand Up @@ -126,7 +126,7 @@ The linear rate controller can be used in both duration-based and transaction nu
The linear rate controller can be specified by setting the rate controller `type` to the `linear-rate` string.

Controller options include:
- `startingTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the start of the round
- `startTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the start of the round
- `finishingTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the end of the round

The following example specifies a rate controller that gradually changes the transaction load from 25 TPS to 75 TPS during the benchmark round.
Expand All @@ -135,7 +135,7 @@ The following example specifies a rate controller that gradually changes the tra
{
"type": "linear-rate",
"opts": {
"startingTps": 25,
"startTps": 25,
"finishingTps": 75
}
}
Expand Down
8 changes: 4 additions & 4 deletions docs/vNext/Rate_Controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The fixed load rate controller is a controller for driving the tests at a target
The fixed-load controller can be specified by setting the rate controller `type` to the `fixed-load` string.

Controller options include:
- `startingTps`: the initial rate at which transactions are cumulatively sent to the SUT by all workers
- `startTps`: the initial rate at which transactions are cumulatively sent to the SUT by all workers
- `transactionLoad`: the number of transactions being processed by the SUT that is to be maintained

The fixed load controller, aiming to maintain a SUT transaction load of 5, with a starting TPS of 100, is specified through the following controller option:
Expand All @@ -79,7 +79,7 @@ The fixed load controller, aiming to maintain a SUT transaction load of 5, with
"type": "fixed-load",
"opts": {
"transactionLoad": 5,
"startingTps": 100
"startTps": 100
}
}
```
Expand Down Expand Up @@ -126,7 +126,7 @@ The linear rate controller can be used in both duration-based and transaction nu
The linear rate controller can be specified by setting the rate controller `type` to the `linear-rate` string.

Controller options include:
- `startingTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the start of the round
- `startTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the start of the round
- `finishingTps`: the rate at which transactions are cumulatively sent to the SUT by all workers at the end of the round

The following example specifies a rate controller that gradually changes the transaction load from 25 TPS to 75 TPS during the benchmark round.
Expand All @@ -135,7 +135,7 @@ The following example specifies a rate controller that gradually changes the tra
{
"type": "linear-rate",
"opts": {
"startingTps": 25,
"startTps": 25,
"finishingTps": 75
}
}
Expand Down

0 comments on commit 552c3cb

Please sign in to comment.