Merge "Rewrite pref cleanup script"

[lhc/web/wiklou.git] / maintenance / benchmarks / Benchmarker.php

diff --git a/maintenance/benchmarks/Benchmarker.php b/maintenance/benchmarks/Benchmarker.php
index 0039d20..f1e7dbb 100644 (file)
--- a/maintenance/benchmarks/Benchmarker.php
+++ b/maintenance/benchmarks/Benchmarker.php
@@ -26,7 +26,11 @@
  * @ingroup Benchmark
  */
 
+use Wikimedia\RunningStat;
+
+// @codeCoverageIgnoreStart
 require_once __DIR__ . '/../Maintenance.php';
+// @codeCoverageIgnoreEnd
 
 /**
  * Base class for benchmark scripts.
@@ -35,15 +39,20 @@ require_once __DIR__ . '/../Maintenance.php';
  */
 abstract class Benchmarker extends Maintenance {
        protected $defaultCount = 100;
+       private $lang;
 
        public function __construct() {
                parent::__construct();
                $this->addOption( 'count', 'How many times to run a benchmark', false, true );
+               $this->addOption( 'verbose', 'Verbose logging of resource usage', false, false, 'v' );
        }
 
        public function bench( array $benchs ) {
+               $this->lang = Language::factory( 'en' );
+
                $this->startBench();
                $count = $this->getOption( 'count', $this->defaultCount );
+               $verbose = $this->hasOption( 'verbose' );
                foreach ( $benchs as $key => $bench ) {
                        // Shortcut for simple functions
                        if ( is_callable( $bench ) ) {
@@ -61,25 +70,16 @@ abstract class Benchmarker extends Maintenance {
                        }
 
                        // Run benchmarks
-                       $times = [];
+                       $stat = new RunningStat();
                        for ( $i = 0; $i < $count; $i++ ) {
                                $t = microtime( true );
                                call_user_func_array( $bench['function'], $bench['args'] );
                                $t = ( microtime( true ) - $t ) * 1000;
-                               $times[] = $t;
-                       }
-
-                       // Collect metrics
-                       sort( $times, SORT_NUMERIC );
-                       $min = $times[0];
-                       $max = end( $times );
-                       if ( $count % 2 ) {
-                               $median = $times[ ( $count - 1 ) / 2 ];
-                       } else {
-                               $median = ( $times[$count / 2] + $times[$count / 2 - 1] ) / 2;
+                               if ( $verbose ) {
+                                       $this->verboseRun( $i );
+                               }
+                               $stat->addObservation( $t );
                        }
-                       $total = array_sum( $times );
-                       $mean = $total / $count;
 
                        // Name defaults to name of called function
                        if ( is_string( $key ) ) {
@@ -98,12 +98,17 @@ abstract class Benchmarker extends Maintenance {
 
                        $this->addResult( [
                                'name' => $name,
-                               'count' => $count,
-                               'total' => $total,
-                               'min' => $min,
-                               'median' => $median,
-                               'mean' => $mean,
-                               'max' => $max,
+                               'count' => $stat->getCount(),
+                               // Get rate per second from mean (in ms)
+                               'rate' => 1.0 / ( $stat->getMean() / 1000.0 ),
+                               'total' => $stat->getMean() * $stat->getCount(),
+                               'mean' => $stat->getMean(),
+                               'max' => $stat->max,
+                               'stddev' => $stat->getStdDev(),
+                               'usage' => [
+                                       'mem' => memory_get_usage( true ),
+                                       'mempeak' => memory_get_peak_usage( true ),
+                               ],
                        ] );
                }
        }
@@ -123,15 +128,38 @@ abstract class Benchmarker extends Maintenance {
        public function addResult( $res ) {
                $ret = sprintf( "%s\n  %' 6s: %d\n",
                        $res['name'],
-                       'times',
+                       'count',
                        $res['count']
                );
-               foreach ( [ 'total', 'min', 'median', 'mean', 'max' ] as $metric ) {
-                       $ret .= sprintf( "  %' 6s: %6.2fms\n",
+               $ret .= sprintf( "  %' 6s: %8.1f/s\n",
+                       'rate',
+                       $res['rate']
+               );
+               foreach ( [ 'total', 'mean', 'max', 'stddev' ] as $metric ) {
+                       $ret .= sprintf( "  %' 6s: %8.2fms\n",
                                $metric,
                                $res[$metric]
                        );
                }
+
+               foreach ( [
+                       'mem' => 'Current memory usage',
+                       'mempeak' => 'Peak memory usage'
+               ] as $key => $label ) {
+                       $ret .= sprintf( "%' 20s: %s\n",
+                               $label,
+                               $this->lang->formatSize( $res['usage'][$key] )
+                       );
+               }
+
                $this->output( "$ret\n" );
        }
+
+       protected function verboseRun( $iteration ) {
+               $this->output( sprintf( "#%3d - memory: %-10s - peak: %-10s\n",
+                       $iteration,
+                       $this->lang->formatSize( memory_get_usage( true ) ),
+                       $this->lang->formatSize( memory_get_peak_usage( true ) )
+               ) );
+       }
 }