wiki.techinc.nl/includes/profiler/output/ProfilerOutput.php
Timo Tijhof 063a528bc8 profiler: Use PSR-3 logging in Profiler and ProfilerOutput classes
* Use the "profiler" channel consistently within this component,
  and set it in the constructor of the base classes.

* Fold legacy "profilererror" channel into "profiler".
  Previously, the wfDebugLog wrapper was using the INFO severity,
  which is the default given wfDebugLog does not support severity.

Change-Id: I1e7dcbc221b395a4ea792e18f4d4da36b5ee40df
2020-08-12 03:51:29 +00:00

74 lines
2 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\Logger\LoggerFactory;
use Psr\Log\LoggerInterface;
/**
* Base class for profiling output.
*
* @ingroup Profiler
* @since 1.25
*/
abstract class ProfilerOutput {
/** @var Profiler */
protected $collector;
/** @var LoggerInterface */
protected $logger;
/** @var array Configuration of $wgProfiler */
protected $params;
/**
* @param Profiler $collector The actual profiler
* @param array $params Configuration array, passed down from $wgProfiler
*/
public function __construct( Profiler $collector, array $params ) {
$this->collector = $collector;
$this->params = $params;
$this->logger = LoggerFactory::getInstance( 'profiler' );
}
/**
* Can this output type be used?
* @return bool
*/
public function canUse() {
return true;
}
/**
* May the log() try to write to standard output?
* @return bool
* @since 1.33
*/
public function logsToOutput() {
return false;
}
/**
* Log MediaWiki-style profiling data.
*
* For classes that enable logsToOutput(), this must not
* be called unless Profiler::setAllowOutput is enabled.
*
* @param array $stats Result of Profiler::getFunctionStats()
*/
abstract public function log( array $stats );
}