benchee_csv Hex VersiondocsBuild StatusCoverage Status

Formatter for benchee to turn the statistics output into a CSV file. This can then be used in the Spreadsheet tool of your choice to generate graphs to your liking.

These might then look like this one (quickly generated with LibreOffice from the output of the sample):

sample graphs

Installation

Add benchee_csv to your list of dependencies in mix.exs:

def deps do
  [{:benchee_csv, "~> 0.5", only: :dev}]
end

Afterwards, run mix deps.get to install it.

Usage

Simply configure Benchee.Formatters.CSV.output/1 as one of the formatters for Benchee.run/2 along with the %{csv: %{file: "my_file.csv"}} option as to where to save the csv file:

list = Enum.to_list(1..10_000)
map_fun = fn(i) -> [i, i * i] end

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.output/1,
    &Benchee.Formatters.Console.output/1
  ],
  formatter_options: [csv: [file: "my.csv"]])

The sample defines both the standard console formatter and the CSV formatter, if you don't care about the console output you can also only define the CSV formatter.

You can also use the more verbose and versatile API of Benchee. When it comes to formatting just use Benchee.Formatters.CSV.format and then write it to a file (taking into account the new input structure). Check out the samples directory for the verbose samples to see how it's done.

Contributing

Contributions to benchee_csv are very welcome! Bug reports, documentation, spelling corrections, whole features, feature ideas, bugfixes, new plugins, fancy graphics... all of those (and probably more) are much appreciated contributions!

Please respect the Code of Conduct.

You can get started with a look at the open issues.

A couple of (hopefully) helpful points:

Development