Beamchmark.Suite (Beamchmark v1.4.2)

Copy Markdown View Source

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

The results are serialized and stored in output_dir / scenario name / delay_duration directory, where scenario name is the name of module implementing scenario (without separating dots) and output_dir, delay, duration are fetched from the suite's configuration.

Summary

Types

t()

Functions

init(configuration)
init(scenario, configuration)
run(suite)
save(suite)
try_load_base(suite)

Types

t()

@type t() :: %Beamchmark.Suite{
  configuration: Beamchmark.Suite.Configuration.t(),
  measurements: Beamchmark.Suite.Measurements.t() | nil,
  scenario: Beamchmark.Scenario.t() | nil,
  system_info: Beamchmark.Suite.SystemInfo.t()
}

Functions

init(configuration)

@spec init(Beamchmark.Suite.Configuration.t()) :: t()

init(scenario, configuration)

@spec init(Beamchmark.Scenario.t(), Beamchmark.Suite.Configuration.t()) :: t()

run(suite)

@spec run(t()) :: t()

save(suite)

@spec save(t()) :: :ok

try_load_base(suite)

@spec try_load_base(t()) :: {:ok, t()} | {:error, File.posix()}