protected $profileID = false;
/** @var bool Whether MediaWiki is in a SkinTemplate output context */
protected $templated = false;
+ /** @var array All of the params passed from $wgProfiler */
+ protected $params = array();
/** @var TransactionProfiler */
protected $trxProfiler;
+ /**
+ * @var array Mapping of output type to class name
+ */
+ private static $outputTypes = array(
+ 'db' => 'ProfilerOutputDb',
+ 'text' => 'ProfilerOutputText',
+ 'udp' => 'ProfilerOutputUdp',
+ );
+
// @codingStandardsIgnoreStart PSR2.Classes.PropertyDeclaration.Underscore
/** @var Profiler Do not call this outside Profiler and ProfileSection */
public static $__instance = null;
if ( isset( $params['profileID'] ) ) {
$this->profileID = $params['profileID'];
}
+ $this->params = $params;
$this->trxProfiler = new TransactionProfiler();
}
if ( self::$__instance === null ) {
global $wgProfiler;
if ( is_array( $wgProfiler ) ) {
- if ( !isset( $wgProfiler['class'] ) ) {
+ $class = isset( $wgProfiler['class'] ) ? $wgProfiler['class'] : 'ProfilerStub';
+ $factor = isset( $wgProfiler['sampling'] ) ? $wgProfiler['sampling'] : 1;
+ if ( PHP_SAPI === 'cli' || mt_rand( 0, $factor - 1 ) != 0 ) {
$class = 'ProfilerStub';
- } else {
- $class = $wgProfiler['class'];
}
self::$__instance = new $class( $wgProfiler );
} else {
}
/**
- * Return whether this a stub profiler
- *
- * @return bool
- */
- abstract public function isStub();
-
- /**
- * Return whether this profiler stores data
- *
- * Called by Parser::braceSubstitution. If true, the parser will not
- * generate per-title profiling sections, to avoid overloading the
- * profiling data collector.
+ * Replace the current profiler with $profiler if no non-stub profiler is set
*
- * @see Profiler::logData()
- * @return bool
+ * @param Profiler $profiler
+ * @throws MWException
+ * @since 1.25
*/
- abstract public function isPersistent();
+ final public static function replaceStubInstance( Profiler $profiler ) {
+ if ( self::$__instance && !( self::$__instance instanceof ProfilerStub ) ) {
+ throw new MWException( 'Could not replace non-stub profiler instance.' );
+ } else {
+ self::$__instance = $profiler;
+ }
+ }
/**
* @param string $id
*/
abstract public function profileOut( $functionname );
+ /**
+ * Mark the start of a custom profiling frame (e.g. DB queries).
+ * The frame ends when the result of this method falls out of scope.
+ *
+ * @param string $section
+ * @return ScopedCallback|null
+ * @since 1.25
+ */
+ abstract public function scopedProfileIn( $section );
+
+ /**
+ * @param ScopedCallback $section
+ */
+ public function scopedProfileOut( ScopedCallback &$section ) {
+ $section = null;
+ }
+
/**
* @return TransactionProfiler
* @since 1.25
/**
* Log the data to some store or even the page output
+ *
+ * @throws MWException
+ * @since 1.25
+ */
+ public function logData() {
+ $output = isset( $this->params['output'] ) ? $this->params['output'] : null;
+
+ if ( !$output || $this instanceof ProfilerStub ) {
+ // return early when no output classes defined or we're a stub
+ return;
+ }
+
+ if ( !is_array( $output ) ) {
+ $output = array( $output );
+ }
+
+ foreach ( $output as $outType ) {
+ if ( !isset( self::$outputTypes[$outType] ) ) {
+ throw new MWException( "'$outType' is an invalid output type" );
+ }
+ $class = self::$outputTypes[$outType];
+
+ /** @var ProfilerOutput $profileOut */
+ $profileOut = new $class( $this, $this->params );
+ if ( $profileOut->canUse() ) {
+ $profileOut->log( $this->getFunctionStats() );
+ }
+ }
+ }
+
+ /**
+ * Get the content type sent out to the client.
+ * Used for profilers that output instead of store data.
+ * @return string
+ * @since 1.25
*/
- abstract public function logData();
+ public function getContentType() {
+ foreach ( headers_list() as $header ) {
+ if ( preg_match( '#^content-type: (\w+/\w+);?#i', $header, $m ) ) {
+ return $m[1];
+ }
+ }
+ return null;
+ }
/**
* Mark this call as templated or not
}
/**
- * Returns a profiling output to be stored in debug file
+ * Was this call as templated or not
*
- * @return string
- */
- abstract public function getOutput();
-
- /**
- * @return array
+ * @return bool
*/
- abstract public function getRawData();
+ public function getTemplated() {
+ return $this->templated;
+ }
/**
- * Get the initial time of the request, based either on $wgRequestTime or
- * $wgRUstart. Will return null if not able to find data.
+ * Get the aggregated inclusive profiling data for each method
*
- * @param string|bool $metric Metric to use, with the following possibilities:
- * - user: User CPU time (without system calls)
- * - cpu: Total CPU time (user and system calls)
- * - wall (or any other string): elapsed time
- * - false (default): will fall back to default metric
- * @return float|null
- */
- protected function getTime( $metric = 'wall' ) {
- if ( $metric === 'cpu' || $metric === 'user' ) {
- $ru = wfGetRusage();
- if ( !$ru ) {
- return 0;
- }
- $time = $ru['ru_utime.tv_sec'] + $ru['ru_utime.tv_usec'] / 1e6;
- if ( $metric === 'cpu' ) {
- # This is the time of system calls, added to the user time
- # it gives the total CPU time
- $time += $ru['ru_stime.tv_sec'] + $ru['ru_stime.tv_usec'] / 1e6;
- }
- return $time;
- } else {
- return microtime( true );
- }
- }
+ * The percent time for each time is based on the current "total" time
+ * used is based on all methods so far. This method can therefore be
+ * called several times in between several profiling calls without the
+ * delays in usage of the profiler skewing the results. A "-total" entry
+ * is always included in the results.
+ *
+ * When a call chain involves a method invoked within itself, any
+ * entries for the cyclic invocation should be be demarked with "@".
+ * This makes filtering them out easier and follows the xhprof style.
+ *
+ * @return array List of method entries arrays, each having:
+ * - name : method name
+ * - calls : the number of invoking calls
+ * - real : real time ellapsed (ms)
+ * - %real : percent real time
+ * - cpu : CPU time ellapsed (ms)
+ * - %cpu : percent CPU time
+ * - memory : memory used (bytes)
+ * - %memory : percent memory used
+ * @since 1.25
+ */
+ abstract public function getFunctionStats();
/**
- * Get the initial time of the request, based either on $wgRequestTime or
- * $wgRUstart. Will return null if not able to find data.
+ * Returns a profiling output to be stored in debug file
*
- * @param string|bool $metric Metric to use, with the following possibilities:
- * - user: User CPU time (without system calls)
- * - cpu: Total CPU time (user and system calls)
- * - wall (or any other string): elapsed time
- * - false (default): will fall back to default metric
- * @return float|null
- */
- protected function getInitialTime( $metric = 'wall' ) {
- global $wgRequestTime, $wgRUstart;
-
- if ( $metric === 'cpu' || $metric === 'user' ) {
- if ( !count( $wgRUstart ) ) {
- return null;
- }
-
- $time = $wgRUstart['ru_utime.tv_sec'] + $wgRUstart['ru_utime.tv_usec'] / 1e6;
- if ( $metric === 'cpu' ) {
- # This is the time of system calls, added to the user time
- # it gives the total CPU time
- $time += $wgRUstart['ru_stime.tv_sec'] + $wgRUstart['ru_stime.tv_usec'] / 1e6;
- }
- return $time;
- } else {
- if ( empty( $wgRequestTime ) ) {
- return null;
- } else {
- return $wgRequestTime;
- }
- }
- }
+ * @return string
+ */
+ abstract public function getOutput();
}
dépôts / lhc / web / wiklou.git / blobdiff