Skip to content

Commit

Permalink
Add Hints to guide
Browse files Browse the repository at this point in the history
  • Loading branch information
byronwasti committed May 14, 2024
1 parent b9297b8 commit 8b6c0e3
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/content/guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,19 @@ test_scaling_functionality()
.await;
```

### Hints

For certain Scenarios it can be useful to provide hints for how Balter should run them. This is primarily useful for speeding up the control loops that Balter uses internally, which are designed to work for a wide variety of use-cases and can sometimes be slow. Currently Balter provides one kind of hint, the `Hint::Concurrency` which Balter will use as the starting concurrency for a given Scenario:

```rust
use balter::{prelude::*, Hint};

my_scenario()
.tps(10_000)
.hint(Hint::Concurrency(100))
.await;
```

## Statistics

Scenario's will return statistical information about the run. For example,
Expand Down

0 comments on commit 8b6c0e3

Please sign in to comment.