Skip to content

Commit df4b9e4

Browse files
committed
Cosmetic update to throttle docs
1 parent af068a6 commit df4b9e4

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

guides/throttle.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,14 @@ See `amoc_throttle`
55
## Overview
66

77
Amoc throttle is a module that allows limiting the number of users' actions per given interval, no matter how many users there are in a test.
8-
It works in both local and distributed environments, allows for dynamic rate changes during a test and exposes metrics which show the number of requests and executions.
8+
It works in both local and distributed environments, allows for dynamic rate changes during a test and exposes telemetry events showing the number of requests and executions.
9+
10+
Amoc throttle allows to:
11+
12+
- Setting the execution `Rate` per `Interval`
13+
- Limiting the number of parallel executions when `Rate` is set to `infinity`
14+
- Setting the `Interarrival` time between actions.
915

10-
Amoc throttle allows setting the execution `Rate` per `Interval` or limiting the number of parallel executions when `Interval` is set to `0`.
1116
Each `Rate` is identified with a `Name`.
1217
The rate limiting mechanism allows responding to a request only when it does not exceed the given `Rate`.
1318
Amoc throttle makes sure that the given `Rate` per `Interval` is maintained on a constant level.
@@ -102,8 +107,8 @@ For every `Name`, a `NoOfProcesses` are created, each responsible for keeping ex
102107
### Distributed environment
103108

104109
#### Metrics
105-
In a distributed environment every Amoc node with a throttle started, exposes metrics showing the numbers of requests and executions.
106-
Those exposed by the master node show the sum of all metrics from all nodes.
110+
In a distributed environment every Amoc node with a throttle started, exposes telemetry events showing the numbers of requests and executions.
111+
Those exposed by the master node show the aggregate of all telemetry events from all nodes.
107112
This allows to quickly see the real rates across the whole system.
108113

109114
#### Workflow

0 commit comments

Comments
 (0)