Skip to content

Commit 0e95cce

Browse files
committed
Clarify NIFs don't show up in memory measurements
Hi Peter!
1 parent dbed6b6 commit 0e95cce

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,8 @@ Benchee will print a big warning when this happens.
316316

317317
#### Measuring Memory Consumption
318318

319-
Starting with version 0.13, users can now get measurements of how much memory their benchmarked scenarios use. The measurement is **limited to the process that Benchee executes your provided code in** - i.e. other processes (like worker pools)/the whole BEAM isn't taken into account.
319+
Benchee can measure memory consumption of scenarios. The measurement is **limited to the process that Benchee executes your provided code in** - i.e. other processes (like worker pools)/the whole BEAM isn't taken into account.
320+
Similarly, only BEAM managed & reported memory is counted - i.e. memory allocated by NIFs also doesn't show up.
320321

321322
This measurement is **not** the actual effect on the size of the BEAM VM size, but the total amount of memory that was allocated during the execution of a given scenario. This includes all memory that was garbage collected during the execution of that scenario.
322323

0 commit comments

Comments
 (0)