Skip to content

Commit 381bd40

Browse files
committed
Document the per-driver budget in the simulator example
The custom example ran 20 vehicles every 2s, which is 40x the one report per 5s the server allows for the single shared login.
1 parent 1d6ec92 commit 381bd40

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

docs/development.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,15 @@ make simulate
139139
Custom example:
140140

141141
```bash
142-
go run ./cmd/simulator -url http://localhost:8080 -vehicles 20 -interval 2s -duration 2m
142+
go run ./cmd/simulator -url http://localhost:8080 -vehicles 1 -interval 6s -duration 2m
143143
```
144144

145+
The server allows one location report per driver per 5 seconds, and every
146+
simulated vehicle authenticates with the same login, so they share a single
147+
budget. Raising `-vehicles` without raising `-interval` to match just turns the
148+
extra reports into `429`s. The simulator warns at startup when the two do not
149+
fit.
150+
145151
## API Sanity Checks
146152

147153
### Submit one location

0 commit comments

Comments
 (0)