348 lines
8.9 KiB
PHP
348 lines
8.9 KiB
PHP
<?php
|
|
/**
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\debug\panels;
|
|
|
|
use Yii;
|
|
use yii\base\InvalidConfigException;
|
|
use yii\debug\Panel;
|
|
use yii\helpers\ArrayHelper;
|
|
use yii\log\Logger;
|
|
use yii\debug\models\search\Db;
|
|
|
|
/**
|
|
* Debugger panel that collects and displays database queries performed.
|
|
*
|
|
* @property array $profileLogs This property is read-only.
|
|
* @property string $summaryName Short name of the panel, which will be use in summary. This property is
|
|
* read-only.
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @since 2.0
|
|
*/
|
|
class DbPanel extends Panel
|
|
{
|
|
/**
|
|
* @var integer the threshold for determining whether the request has involved
|
|
* critical number of DB queries. If the number of queries exceeds this number,
|
|
* the execution is considered taking critical number of DB queries.
|
|
*/
|
|
public $criticalQueryThreshold;
|
|
/**
|
|
* @var string the name of the database component to use for executing (explain) queries
|
|
*/
|
|
public $db = 'db';
|
|
/**
|
|
* @var array the default ordering of the database queries. In the format of
|
|
* [ property => sort direction ], for example: [ 'duration' => SORT_DESC ]
|
|
* @since 2.0.7
|
|
*/
|
|
public $defaultOrder = [
|
|
'seq' => SORT_ASC
|
|
];
|
|
/**
|
|
* @var array the default filter to apply to the database queries. In the format
|
|
* of [ property => value ], for example: [ 'type' => 'SELECT' ]
|
|
* @since 2.0.7
|
|
*/
|
|
public $defaultFilter = [];
|
|
|
|
/**
|
|
* @var array db queries info extracted to array as models, to use with data provider.
|
|
*/
|
|
private $_models;
|
|
/**
|
|
* @var array current database request timings
|
|
*/
|
|
private $_timings;
|
|
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function init()
|
|
{
|
|
$this->actions['db-explain'] = [
|
|
'class' => 'yii\\debug\\actions\\db\\ExplainAction',
|
|
'panel' => $this,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function getName()
|
|
{
|
|
return 'Database';
|
|
}
|
|
|
|
/**
|
|
* @return string short name of the panel, which will be use in summary.
|
|
*/
|
|
public function getSummaryName()
|
|
{
|
|
return 'DB';
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function getSummary()
|
|
{
|
|
$timings = $this->calculateTimings();
|
|
$queryCount = count($timings);
|
|
$queryTime = number_format($this->getTotalQueryTime($timings) * 1000) . ' ms';
|
|
|
|
return Yii::$app->view->render('panels/db/summary', [
|
|
'timings' => $this->calculateTimings(),
|
|
'panel' => $this,
|
|
'queryCount' => $queryCount,
|
|
'queryTime' => $queryTime,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function getDetail()
|
|
{
|
|
$searchModel = new Db();
|
|
|
|
if (!$searchModel->load(Yii::$app->request->getQueryParams())) {
|
|
$searchModel->load($this->defaultFilter, '');
|
|
}
|
|
|
|
$models = $this->getModels();
|
|
$dataProvider = $searchModel->search($models);
|
|
$dataProvider->getSort()->defaultOrder = $this->defaultOrder;
|
|
$sumDuplicates = $this->sumDuplicateQueries($models);
|
|
|
|
return Yii::$app->view->render('panels/db/detail', [
|
|
'panel' => $this,
|
|
'dataProvider' => $dataProvider,
|
|
'searchModel' => $searchModel,
|
|
'hasExplain' => $this->hasExplain(),
|
|
'sumDuplicates' => $sumDuplicates,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Calculates given request profile timings.
|
|
*
|
|
* @return array timings [token, category, timestamp, traces, nesting level, elapsed time]
|
|
*/
|
|
public function calculateTimings()
|
|
{
|
|
if ($this->_timings === null) {
|
|
$this->_timings = Yii::getLogger()->calculateTimings(isset($this->data['messages']) ? $this->data['messages'] : []);
|
|
}
|
|
|
|
return $this->_timings;
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function save()
|
|
{
|
|
return ['messages' => $this->getProfileLogs()];
|
|
}
|
|
|
|
/**
|
|
* Returns all profile logs of the current request for this panel. It includes categories such as:
|
|
* 'yii\db\Command::query', 'yii\db\Command::execute'.
|
|
* @return array
|
|
*/
|
|
public function getProfileLogs()
|
|
{
|
|
$target = $this->module->logTarget;
|
|
|
|
return $target->filterMessages($target->messages, Logger::LEVEL_PROFILE, ['yii\db\Command::query', 'yii\db\Command::execute']);
|
|
}
|
|
|
|
/**
|
|
* Returns total query time.
|
|
*
|
|
* @param array $timings
|
|
* @return int total time
|
|
*/
|
|
protected function getTotalQueryTime($timings)
|
|
{
|
|
$queryTime = 0;
|
|
|
|
foreach ($timings as $timing) {
|
|
$queryTime += $timing['duration'];
|
|
}
|
|
|
|
return $queryTime;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of models that represents logs of the current request.
|
|
* Can be used with data providers such as \yii\data\ArrayDataProvider.
|
|
* @return array models
|
|
*/
|
|
protected function getModels()
|
|
{
|
|
if ($this->_models === null) {
|
|
$this->_models = [];
|
|
$timings = $this->calculateTimings();
|
|
$duplicates = $this->countDuplicateQuery($timings);
|
|
|
|
foreach ($timings as $seq => $dbTiming) {
|
|
$this->_models[] = [
|
|
'type' => $this->getQueryType($dbTiming['info']),
|
|
'query' => $dbTiming['info'],
|
|
'duration' => ($dbTiming['duration'] * 1000), // in milliseconds
|
|
'trace' => $dbTiming['trace'],
|
|
'timestamp' => ($dbTiming['timestamp'] * 1000), // in milliseconds
|
|
'seq' => $seq,
|
|
'duplicate' => $duplicates[$dbTiming['info']],
|
|
];
|
|
}
|
|
}
|
|
|
|
return $this->_models;
|
|
}
|
|
|
|
/**
|
|
* Return associative array, where key is query string
|
|
* and value is number of occurrences the same query in array.
|
|
*
|
|
* @param $timings
|
|
* @return array
|
|
* @since 2.0.13
|
|
*/
|
|
public function countDuplicateQuery($timings)
|
|
{
|
|
$query = ArrayHelper::getColumn($timings, 'info');
|
|
|
|
return array_count_values($query);
|
|
}
|
|
|
|
/**
|
|
* Returns sum of all duplicated queries
|
|
*
|
|
* @param $modelData
|
|
* @return int
|
|
* @since 2.0.13
|
|
*/
|
|
public function sumDuplicateQueries($modelData)
|
|
{
|
|
$numDuplicates = 0;
|
|
$duplicates = ArrayHelper::getColumn($modelData, 'duplicate');
|
|
foreach ($duplicates as $duplicate) {
|
|
if ($duplicate > 1) {
|
|
$numDuplicates++;
|
|
}
|
|
}
|
|
|
|
return $numDuplicates;
|
|
}
|
|
|
|
/**
|
|
* Returns database query type.
|
|
*
|
|
* @param string $timing timing procedure string
|
|
* @return string query type such as select, insert, delete, etc.
|
|
*/
|
|
protected function getQueryType($timing)
|
|
{
|
|
$timing = ltrim($timing);
|
|
preg_match('/^([a-zA-z]*)/', $timing, $matches);
|
|
|
|
return count($matches) ? mb_strtoupper($matches[0], 'utf8') : '';
|
|
}
|
|
|
|
/**
|
|
* Check if given queries count is critical according settings.
|
|
*
|
|
* @param int $count queries count
|
|
* @return bool
|
|
*/
|
|
public function isQueryCountCritical($count)
|
|
{
|
|
return (($this->criticalQueryThreshold !== null) && ($count > $this->criticalQueryThreshold));
|
|
}
|
|
|
|
/**
|
|
* Returns array query types
|
|
*
|
|
* @return array
|
|
* @since 2.0.3
|
|
*/
|
|
public function getTypes()
|
|
{
|
|
return array_reduce(
|
|
$this->_models,
|
|
function ($result, $item) {
|
|
$result[$item['type']] = $item['type'];
|
|
return $result;
|
|
},
|
|
[]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function isEnabled()
|
|
{
|
|
try {
|
|
$this->getDb();
|
|
} catch (InvalidConfigException $exception) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return bool Whether the DB component has support for EXPLAIN queries
|
|
* @since 2.0.5
|
|
*/
|
|
protected function hasExplain()
|
|
{
|
|
$db = $this->getDb();
|
|
if (!($db instanceof \yii\db\Connection)) {
|
|
return false;
|
|
}
|
|
switch ($db->getDriverName()) {
|
|
case 'mysql':
|
|
case 'sqlite':
|
|
case 'pgsql':
|
|
case 'cubrid':
|
|
return true;
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if given query type can be explained.
|
|
*
|
|
* @param string $type query type
|
|
* @return bool
|
|
*
|
|
* @since 2.0.5
|
|
*/
|
|
public static function canBeExplained($type)
|
|
{
|
|
return $type !== 'SHOW';
|
|
}
|
|
|
|
/**
|
|
* Returns a reference to the DB component associated with the panel
|
|
*
|
|
* @return \yii\db\Connection
|
|
* @since 2.0.5
|
|
*/
|
|
public function getDb()
|
|
{
|
|
return Yii::$app->get($this->db);
|
|
}
|
|
}
|