BencheeCSV

v1.0.0

BencheeCSV v1.0.0 Benchee.Formatters.CSV View Source

Functionality for converting Benchee benchmarking results to CSV so that they can be written to file and opened in a spreadsheet tool for graph generation for instance.

The most basic use case is to configure it as one of the formatters to be used by Benchee.run/2.

Benchee.run(
  %{
    "flat_map"    => fn -> Enum.flat_map(list, map_fun) end,
    "map.flatten" => fn -> list |> Enum.map(map_fun) |> List.flatten end
  },
  formatters: [
    {Benchee.Formatters.CSV, file: "my.csv"},
    Benchee.Formatters.Console
  ]
)

Link to this section Summary

Functions

format(suite, _)

Transforms the statistical results Benche.statistics to be written somewhere, such as a file through IO.write/2

write(arg, options)

Uses the return value of Benchee.Formatters.CSV.format/2 to write the statistics output to a CSV file, defined in the initial configuration. The raw measurements are placed in a file with "raw_" prepended onto the file name given in the initial configuration

Link to this section Functions

Link to this function

format(suite, _) View Source 
format(Benchee.Suite.t(), any()) :: {Enumerable.t(), Enumerable.t()}

Transforms the statistical results Benche.statistics to be written somewhere, such as a file through IO.write/2.

Examples 

iex> suite = %Benchee.Suite{
...>    scenarios: [
...>        %Benchee.Scenario{
...>            name: "My Job",
...>            input_name: "Some Input",
...>            input: "Some Input",
...>            run_time_data: %Benchee.CollectionData{
...>        samples: [500],
...>        statistics: %Benchee.Statistics{
...>                  average:       500.0,
...>                  ips:           2000.0,
...>                  std_dev:       200.0,
...>                  std_dev_ratio: 0.4,
...>                  std_dev_ips:   800.0,
...>                  median:        450.0,
...>                  minimum:       200,
...>                  maximum:       900,
...>                  sample_size:   8
...>        }
...>            },
...>            memory_usage_data: %Benchee.CollectionData{
...>        samples: [500],
...>        statistics: %Benchee.Statistics{
...>                  average:       500.0,
...>                  ips:           nil,
...>                  std_dev:       200.0,
...>                  std_dev_ratio: 0.4,
...>                  std_dev_ips:   nil,
...>                  median:        450.0,
...>                  minimum:       200,
...>                  maximum:       900,
...>                  sample_size:   8
...>        }
...>            }
...>        }
...>    ]
...> }
iex> suite
iex> |> Benchee.Formatters.CSV.format(%{})
iex> |> elem(0)
iex> |> (fn rows -> Enum.take(rows, 2) end).()
[
  "Name,Input,Iterations per Second,Standard Deviation Iterations Per Second,Run Time Average,Run Time Median,Run Time Minimum,Run Time Maximum,Run Time Standard Deviation,Run Time Standard Deviation Ratio,Run Time Sample Size,Memory Usage Average,Memory Usage Median,Memory Usage Minimum,Memory Usage Maximum,Memory Usage Standard Deviation,Memory Usage Standard Deviation Ratio,Memory Usage Sample Size\r\n",
  "My Job,Some Input,2.0e3,800.0,500.0,450.0,200,900,200.0,0.4,8,500.0,450.0,200,900,200.0,0.4,8\r\n"
]
Link to this function

write(arg, options) View Source 
write({Enumerable.t(), Enumerable.t()}, map() | nil) :: :ok

Uses the return value of Benchee.Formatters.CSV.format/2 to write the statistics output to a CSV file, defined in the initial configuration. The raw measurements are placed in a file with "raw_" prepended onto the file name given in the initial configuration.

If no file name is given in the configuration, "benchmark_output.csv" is used as a default.