max_sample_size changelog and README docs

Author: PragTob

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## Features (User Facing)
+* Introduce `max_sample_size` which guides how many samples will be gathered at most for a given scenario. This avoids a variety of issues when scenarios gather too many samples (memory consumption etc). Defaults to `1_000_000`, setting it to `nil` gathers unlimited samples again (behavior before this version).
+
 ### Bugfixes (User Facing)
 * fix a bug where if times were supplied as `0` instead of `0.0` we'd sometimes gather a single measurement
 

README.md

@@ -259,6 +259,10 @@ The available options are the following (also documented in [hexdocs](https://he
     [`:eprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Eprof.html)
     [`:fprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Fprof.html) and
     [`:tprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Tprof.html) (requires elixir >= 1.17 and erlang >= 27).
+* `max_sample_size` - the maximum number of samples collected per scenario. Defaults to `1_000_000`.
+  This is used to limit memory consumption and unnecessary processing - 1 Million samples is plenty.
+  This limit also applies to number of iterations done during warmup.
+  You can set your own number or set it to `nil` if you don't want any limit.
 
 ### Metrics to measure