Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[11.x] Benchmark aggregate functions #51211

Conversation

serpentblade
Copy link
Contributor

Purpose

Provide more insight in benchmarking results, particularly when percentiles such as p95 or min/max may have more relevance than just a typical average.

Implementation

Adds a new optional parameter to the Benchmark methods that let's you define the aggregate function(s) you want applied to the measured benchmark timings.

Adds support for ‘total’, ‘max’, ‘min’, ‘median’, percentiles via ‘pXX’, and 'all' to get all timing results.

Also allows passing an array of aggregate functions to return multiple points of data for a benchmark.

Backwards Compatibility

Default aggregate function parameter is "average" which returns the same result as this function always has. No impact to existing implementations.

Examples:

// Get the 95th percentile for calls to an expensive method
Benchmark::measure(fn() => $service->someMethod(), 1000, 'p95');
// => 0.003862

// Return multiple stats for a benchmark
Benchmark::measure(fn() => $service->someMethod(), 1000, ['min', 'max', 'average', 'p50', 'p90', 'p95']);
/*
  =>  [
    "min" => 0.002568,
    "max" => 0.021423,
    "average" => 0.002958703,
    "p50" => 0.002927,
    "p90" => 0.003205,
    "p95" => 0.003339,
  ]
*/

Allow calculating other aggregate data from benchmark timings.

Adds support for ‘total’, ‘max’, ‘min’, ‘median’, percentiles via ‘pXX’, and ‘all’ for all timing results.

When an array of aggregate functions is provided will return all matching function values.
@taylorotwell
Copy link
Member

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If possible, please consider releasing your code as a package so that the community can still take advantage of your contributions!

If you feel absolutely certain that this code corrects a bug in the framework, please "@" mention me in a follow-up comment with further explanation so that GitHub will send me a notification of your response.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants