API Reference Beamchmark v1.2.0

Modules

Top level module providing Beamchmark.run/2 API.

The module defines a behaviour that will be used to format and output Beamchmark.Suite. You can adopt this behaviour to implement custom formatters.

The module formats Beamchmark.Suite and outputs it using Mix.shell/0.

The module formats Beamchmark.Suite and outputs it to an HTML file.

The module contains helper math types and utility functions.

Scenario to run during benchmarking. Defines a behaviour that needs to be adopted by benchmarked modules.

The module defines a struct representing a single run of benchmark. It is also responsible for running the benchmark and saving/loading the results.

This module contains the CPU benchmarking task. Measurements are performed using :cpu_sup.util/1 Currently (according to docs), as busy processor states we identify

The module defines a structure used to configure Beamchmark.Suite. For more information about customizing Beamchmark, refer to Beamchmark.options_t/0.

The module is responsible for gathering BEAM statistics during benchmarking.

Module representing statistics about cpu usage.

Module representing different statistics about scheduler usage.

The module defines a struct containing various information about system that is used for benchmarking.