view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    App::BencherUtils - Utilities related to bencher

VERSION
    This document describes version 0.245 of App::BencherUtils (from Perl
    distribution App-BencherUtils), released on 2022-08-24.

SYNOPSIS
DESCRIPTION
    This distribution includes several utilities:

    *   bencher-code

    *   bencher-for

    *   bencher-module-startup-overhead

    *   chart-bencher-result

    *   cleanup-old-bencher-results

    *   format-bencher-result

    *   gen-bencher-scenario-from-cpanmodules

    *   list-bencher-results

    *   list-bencher-scenario-modules

FUNCTIONS
  bencher_code
    Usage:

     bencher_code(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Accept a list of codes and perform benchmark.

    % bencher-code 'code1' 'code2'

    is basically a shortcut for creating a scenario like this:

     {
         participants => [
             {code_template=>'code1'},
             {code_template=>'code2'},
         ],
     }

    and running that scenario with "bencher".

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   codes* => *array[str]*

    *   precision => *float*

    *   startup => *bool* (default: 0)

        Use code_startup mode instead of normal benchmark.

    *   with_process_size => *bool*

    Returns an enveloped result (an array).