includes/profiler/output/ProfilerOutputStats.php

   1 <?php
   2 /**
   3  * ProfilerOutput class that flushes profiling data to the profiling
   4  * context's stats buffer.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Profiler
  23  */
  24
  25 /**
  26  * ProfilerOutput class that flushes profiling data to the profiling
  27  * context's stats buffer.
  28  *
  29  * @ingroup Profiler
  30  * @since 1.25
  31  */
  32 class ProfilerOutputStats extends ProfilerOutput {
  33
  34         /**
  35          * Normalize a metric key for StatsD
  36          *
  37          * Replace occurences of '::' with dots and any other non-alphabetic
  38          * characters with underscores. Combine runs of dots or underscores.
  39          * Then trim leading or trailing dots or underscores.
  40          *
  41          * @param string $key
  42          * @since 1.26
  43          */
  44         private static function normalizeMetricKey( $key ) {
  45                 $key = preg_replace( '/[:.]+/', '.', $key );
  46                 $key = preg_replace( '/[^a-z.]+/i', '_', $key );
  47                 $key = trim( $key, '_.' );
  48                 return str_replace( array( '._', '_.' ), '.', $key );
  49         }
  50
  51         /**
  52          * Flush profiling data to the current profiling context's stats buffer.
  53          *
  54          * @param array $stats
  55          */
  56         public function log( array $stats ) {
  57                 if ( isset( $this->params['prefix'] ) ) {
  58                         $prefix = self::normalizeMetricKey( $this->params['prefix'] );
  59                 } else {
  60                         $prefix = '';
  61                 }
  62
  63                 $contextStats = $this->collector->getContext()->getStats();
  64
  65                 foreach ( $stats as $stat ) {
  66                         $key = self::normalizeMetricKey( "{$prefix}.{$stat['name']}" );
  67
  68                         // Convert fractional seconds to whole milliseconds
  69                         $cpu = round( $stat['cpu'] * 1000 );
  70                         $real = round( $stat['real'] * 1000 );
  71
  72                         $contextStats->increment( "{$key}.calls" );
  73                         $contextStats->timing( "{$key}.cpu", $cpu );
  74                         $contextStats->timing( "{$key}.real", $real );
  75                 }
  76         }
  77 }