View Source BencheeAsync (BencheeAsync v0.1.0-dev-28107980)

Documentation for BencheeAsync.

Summary

Functions

Runs the benchmark jobs as per the Benchee-compatible configuration.

Functions

@spec run(
  map(),
  keyword()
) :: Benchee.Suite.t()

Runs the benchmark jobs as per the Benchee-compatible configuration.

Full list of configuration can be found in the documentation for Benchee.

Internals

This function will inject Reporter lifecycle hooks into each bencahmark job. These hooks will be executed before the user provided hooks. The only exception to this is where the timer reset is performed after the user's :before_each global hook is run.

The BencheeAsync.Reporter will immediately start tracking work completion on warmup end, and on job completion (where the :after_scenario hook is run). This means that any configuration option that extends measurement times (such as :memory_time) will result in tracking occuring beyond the :time configured.