NAME

Krang::Benchmark - manages the running of benchmarks scripts

SYNOPSIS

To create a new benchmark script, create a new .pl file in bench/:

  use Krang::ClassLoader Benchmark => qw(run_benchmark);

  run_benchmark(module => "Krang::Foo",
                name   => "name of benchmark here",
                count  => 1000,
                code   => sub { "some code to benchmark here" });

  run_benchmark(module => "Krang::Foo",
                name   => "name of another benchmark here",
                count  => 1000,
                code   => sub { "some code to benchmark here" });

To perform a benchmark run:

  make bench

If you want to name your benchmark run for later reference:

  make bench BENCH_NAME=some_name_here

If you want to run just one benchmark script:

  make bench BENCH_FILES=bench/file.pl

After doing at least two runs, use krang_bench to perform benchmark analysis between the last two runs:

  bin/krang_bench

Or pass in run names to do arbitrary comparisions:

  bin/krang_bench name1 name2

DESCRIPTION

This module manages benchmarking for Krang, run using ``make bench''. This module works like the standard Benchmark module with a couple differences. First, it only cares about wallclock time, since per-process CPU time is useless for a database application. Second, it dumps the results to a file called 'bench.out'. This file can then be used to compare benchmark results from different versions of Krang, different data loads or across different machines. For analysis, see the bin/krang_bench program.

INTERFACE

• run_benchmark
  
This subroutine is available for export. Calling it runs a single benchmark. It requires the following named parameters:
• module
  
The name of the module being benchmarked.
• name
  
The name of the benchmark. This must be unique among benchmarks for this module. Idealy, it should give the user an idea of what functionality is being tested. For example, ``save''.
• count
  
How many times to run the code being benchmarked. Ideally, look for a number of runs that completes within a few seconds.
• code
  
The code to run. Must be a reference to a subroutine.

• start_benchmark(name => $name)
  
Starts a new benchmark in bench.out. This is usually called by make bench to signify the start of a new benchmark run. The name argument is required and will be used as the name of the benchmark.

TODO