Skip to content

Commit

Permalink
Documentation for fixed backlog controller
Browse files Browse the repository at this point in the history
Signed-off-by: lmuswere <[email protected]>
  • Loading branch information
lynn14m committed Jan 16, 2020
1 parent c002e07 commit 6a0645c
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/vNext/Rate_Controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,15 @@ The fixed feedback rate controller, driving at 100 TPS, 100 unfinished transacti
## Fixed Backlog
The fixed backlog rate controller is a controller for driving the tests at a target loading (backlog transactions). This controller will aim to maintain a defined backlog of transactions within the system by modifying the driven TPS. The result is the maximum possible TPS for the system whilst maintaining the backlog level.

The modification of the TPS is performed by a basic controller, which aims to drive the backlog error (difference between current and desired transaction backlog) to zero. It works on the proportional (error size), derivative (rate of change of error) and integral (error history) to adjust the time between transaction submission such that the backlog is maintained at a set level.


The PID rate controller, targeting a backlog of 5 transactions, is specified through the following controller option:
The PID rate controller, targeting a backlog of 5 transactions with a starting TPS of 100, is specified through the following controller option:

```json
{
"type": "fixed-backlog",
"opts": {
"unfinished_per_client": 5
"unfinished_per_client": 5,
"startingTps": 100
}
}
```
Expand Down

0 comments on commit 6a0645c

Please sign in to comment.