1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2019 Zabbix SIA
**
** 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.
**/
class CProfiler {
/**
* Determines time for single sql query to be considered slow.
*
* @var float
*/
protected $slowSqlQueryTime = 0.01;
/**
* Determines time for single Elasticsearch query to be considered slow.
*
* @var float
*/
protected $slowElasticQueryTime = 0.01;
/**
* Contains all api requests info.
*
* @var array
*/
protected $apiLog = [];
/**
* Contains SQL queries info.
*
* @var array
*/
protected $sqlQueryLog = [];
/**
* Contains Elasticsearch queries info.
*
* @var array
*/
protected $elasticQueryLog = [];
/**
* Total time of all performed sql queries.
*
* @var float
*/
protected $sqlTotalTime = 0.0;
/**
* Total time of all performed Elasticsearch queries.
*
* @var float
*/
protected $elasticTotalTime = 0.0;
/**
* Timestamp of profiling start.
*
* @var float
*/
private $startTime;
/**
* Timestamp of profiling stop.
*
* @var float
*/
private $stopTime;
/**
* Instance of this class object.
*
* @var CProfiler
*/
private static $instance;
/**
* Root directory path
*
* @var string
*/
private $root_dir;
/**
* @static
*
* @return CProfiler
*/
public static function getInstance() {
if (self::$instance === null) {
self::$instance = new self;
}
return self::$instance;
}
/**
* Private constructor.
*/
private function __construct() {
$this->root_dir = realpath(dirname(__FILE__).'/../../..');
}
/**
* Start script profiling.
*/
public function start() {
$this->startTime = microtime(true);
}
/**
* Stop script profiling.
*/
public function stop() {
$this->stopTime = microtime(true);
}
/**
* Make profiling data.
*
* @return CPre
*/
public function make() {
global $DB;
$debug = [];
$debug[] = (new CLink())->setAttribute('name', 'debug');
$debug[] = '******************** '._('Script profiler').' ********************';
$debug[] = BR();
$debug[] = _s('Total time: %1$s', round($this->stopTime - $this->startTime, 6));
$debug[] = BR();
$debug[] = _s('Total SQL time: %1$s', $this->sqlTotalTime);
$debug[] = BR();
if ($this->elasticQueryLog) {
$debug[] = _s('Total Elasticsearch time: %1$s', $this->elasticTotalTime);
$debug[] = BR();
}
if (isset($DB) && isset($DB['SELECT_COUNT'])) {
$debug[] = _s('SQL count: %1$s (selects: %2$s | executes: %3$s)',
count($this->sqlQueryLog), $DB['SELECT_COUNT'], $DB['EXECUTE_COUNT']);
$debug[] = BR();
}
$debug[] = _s('Peak memory usage: %1$s', mem2str($this->getMemoryPeak()));
$debug[] = BR();
$debug[] = _s('Memory limit: %1$s', ini_get('memory_limit'));
$debug[] = BR();
$debug[] = BR();
foreach ($this->apiLog as $i => $apiCall) {
list($class, $method, $params, $result, $file, $line) = $apiCall;
// api method
$debug[] = ($i + 1).'. ';
$debug[] = bold($class.'.'.$method);
$debug[] = ($file !== null ? ' ['.$file.':'.$line.']' : null);
$debug[] = BR();
$debug[] = BR();
// parameters, result
$debug[] = (new CTable())
->addRow([
[_('Parameters').':', BR(), print_r($params, true)],
[_('Result').':', BR(), print_r($result, true)]
]);
$debug[] = BR();
}
$debug[] = BR();
foreach ($this->sqlQueryLog as $query) {
$time = $query[0];
$sql = [
'SQL ('.$time.'): ',
(new CSpan($query[1]))
->addClass(substr($query[1], 0, 6) === 'SELECT' ? ZBX_STYLE_GREEN : ZBX_STYLE_BLUE),
BR()
];
if ($time > $this->slowSqlQueryTime) {
$sql = bold($sql);
}
$debug[] = $sql;
$debug[] = $this->formatCallStack($query[2]);
$debug[] = BR();
$debug[] = BR();
}
$debug[] = BR();
foreach ($this->elasticQueryLog as $query) {
$time = $query[0];
$record = [
'Elasticsearch ('.$time.'): ',
$query[1].' ',
(new CSpan($query[2]))->addClass(ZBX_STYLE_BLUE),
BR(),
'Request: ',
(new CSpan($query[3]))->addClass(ZBX_STYLE_GREEN),
BR()
];
if ($time > $this->slowElasticQueryTime) {
$sql = bold($record);
}
$debug[] = $record;
$debug[] = $this->formatCallStack($query[4]);
$debug[] = BR();
$debug[] = BR();
}
return (new CPre())
->addClass(ZBX_STYLE_DEBUG_OUTPUT)
->setAttribute('name', 'zbx_debug_info')
->addItem($debug);
}
/**
* Output profiling data.
*/
public function show() {
return $this->make()->show();
}
/**
* Store sql query data.
*
* @param float $time
* @param string $sql
*/
public function profileSql($time, $sql) {
$time = round($time, 6);
$this->sqlTotalTime += $time;
$this->sqlQueryLog[] = [
$time,
$sql,
array_slice(debug_backtrace(), 1)
];
}
/**
* Store api call data.
*
* @param string $class
* @param string $method
* @param array $params
* @param array $result
*/
public function profileApiCall($class, $method, $params, $result) {
$backtrace = debug_backtrace();
// Use the file name and line number from the first call to the API wrapper object.
// Due to a bug earlier versions of PHP 5.3 did not provide the file name and line number
// of calls to magic methods.
if (isset($backtrace[2]['file'])) {
$file = basename($backtrace[2]['file']);
$line = basename($backtrace[2]['line']);
}
else {
$file = null;
$line = null;
}
$this->apiLog[] = [
$class,
$method,
$params,
$result,
$file,
$line
];
}
/**
* Store Elasticsearch query data.
*
* @param float $time
* @param string $method
* @param string $endpoint
* @param string $query
*/
public function profileElasticsearch($time, $method, $endpoint, $query) {
if (!is_null(CWebUser::$data) && isset(CWebUser::$data['debug_mode'])
&& CWebUser::$data['debug_mode'] == GROUP_DEBUG_MODE_DISABLED) {
return;
}
$time = round($time, 6);
$this->elasticTotalTime += $time;
$this->elasticQueryLog[] = [
$time,
$method,
$endpoint,
$query,
array_slice(debug_backtrace(), 1)
];
}
/**
* Return memory used by PHP.
*
* @return int
*/
private function getMemoryPeak() {
return function_exists('memory_get_peak_usage') ? memory_get_peak_usage(true) : memory_get_usage(true);
}
/**
* Formats the function call stack and returns it as a string.
*
* The call stack can be obtained from Exception::getTrace() or from an API result debug stack trace. If no call
* stack is given, it will be taken from debug_backtrace().
*
* @param array $callStack
*
* @return string
*/
public function formatCallStack(array $callStack = null) {
if (!$callStack) {
$callStack = debug_backtrace(false);
// never show the call to this method
array_shift($callStack);
}
$functions = [];
$callWithFile = [];
$callStack = array_reverse($callStack);
$firstCall = reset($callStack);
foreach ($callStack as $call) {
// do not show the call to the error handler function
if ($call['function'] != 'zbx_err_handler') {
if (array_key_exists('class', $call)) {
$functions[] = $call['class'].$call['type'].$call['function'].'()';
}
else {
$functions[] = $call['function'].'()';
}
}
// if the error is caused by an incorrect function call - the location of that call is contained in
// the call of that function
// if it's caused by something else (like an undefined index) - the location of the call is contained in the
// call to the error handler function
// to display the location we use the last call where this information is present
if (array_key_exists('file', $call)) {
$callWithFile = $call;
}
}
$callStackString = '';
if ($functions) {
$callStackString .= pathinfo($firstCall['file'], PATHINFO_BASENAME).':'.$firstCall['line'].' → '.
implode(' → ', $functions);
}
if ($callWithFile) {
$file_name = $callWithFile['file'];
if (substr_compare($file_name, $this->root_dir, 0, strlen($this->root_dir)) === 0) {
$file_name = substr($file_name, strlen($this->root_dir) + 1);
}
$callStackString .= ' in '.$file_name.':'.$callWithFile['line'];
}
return $callStackString;
}
}
|