Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature(profiler): allow capture/display of crude profiling data
Via `$CONFIG` options, sites can enable the display of profiling data in the console. Data is available as a tree or a flattened list sorted by duration. Refs Elgg#9293
- Loading branch information
Showing
14 changed files
with
271 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| <?php | ||
| namespace Elgg; | ||
|
|
||
| /** | ||
| * Analyzes duration of functions, queries, and processes | ||
| * | ||
| * @access private | ||
| */ | ||
| class Profiler { | ||
|
|
||
| public $percentage_format = "%01.2f"; | ||
| public $duration_format = "%01.6f"; | ||
| public $minimum_percentage = 0.2; | ||
|
|
||
| private $total; | ||
|
|
||
| public function buildTree($times = null) { | ||
| if ($times === null) { | ||
| $times = $GLOBALS['_ELGG_MICROTIMES']; | ||
| } | ||
|
|
||
| if (!isset($times[':end'])) { | ||
| $times[':end'] = microtime(); | ||
| } | ||
|
|
||
| $begin = $this->findBeginTime($times); | ||
| $end = $this->findEndTime($times); | ||
| $this->total = $this->diffMicrotime($begin, $end); | ||
|
|
||
| return $this->analyzePeriod('', $times); | ||
| } | ||
|
|
||
| public function flattenTree(array &$list = [], array $tree, $prefix = '') { | ||
| $is_root = empty($list); | ||
|
|
||
| if (isset($tree['periods'])) { | ||
| foreach ($tree['periods'] as $period) { | ||
| $this->flattenTree($list, $period, "{$prefix} {$period['name']}"); | ||
| } | ||
| unset($tree['periods']); | ||
| } | ||
| $tree['name'] = trim($prefix); | ||
| $list[] = $tree; | ||
|
|
||
| if ($is_root) { | ||
| usort($list, function ($a, $b) { | ||
| if ($a['duration'] == $b['duration']) { | ||
| return 0; | ||
| } | ||
| return ($a['duration'] > $b['duration']) ? -1 : 1; | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| public function formatTree(array $tree) { | ||
| $tree['duration'] = sprintf($this->duration_format, $tree['duration']); | ||
| if (isset($tree['percentage'])) { | ||
| $tree['percentage'] = sprintf($this->percentage_format, $tree['percentage']); | ||
| } | ||
| if (isset($tree['periods'])) { | ||
| $tree['periods'] = array_map([$this, 'formatTree'], $tree['periods']); | ||
| } | ||
| return $tree; | ||
| } | ||
|
|
||
| public static function handlePageOutput($hook, $type, $html, $params) { | ||
| $profiler = new self(); | ||
| $min_percentage = elgg_get_config('profiling_minimum_percentage'); | ||
| if ($min_percentage !== null) { | ||
| $profiler->minimum_percentage = $min_percentage; | ||
| } | ||
|
|
||
| $tree = $profiler->buildTree(); | ||
| $tree = $profiler->formatTree($tree); | ||
| $data['tree'] = $tree; | ||
| $data['total'] = $tree['duration'] . " seconds"; | ||
|
|
||
| $list = []; | ||
| $profiler->flattenTree($list, $tree); | ||
|
|
||
| $list = array_map(function ($period) { | ||
| return "{$period['percentage']}% ({$period['duration']}) {$period['name']}"; | ||
| }, $list); | ||
|
|
||
| $data['list'] = $list; | ||
|
|
||
| $html .= "<script>"; | ||
| $html .= "console.log(" . json_encode($data) . ");"; | ||
| $html .= "</script>"; | ||
| return $html; | ||
| } | ||
|
|
||
| private function analyzePeriod($name, array $times) { | ||
| $begin = $this->findBeginTime($times); | ||
| $end = $this->findEndTime($times); | ||
| if ($begin === false || $end === false) { | ||
| return false; | ||
| } | ||
| unset($times[':begin'], $times[':end']); | ||
|
|
||
| $total = $this->diffMicrotime($begin, $end); | ||
| $ret = [ | ||
| 'name' => $name, | ||
| 'percentage' => 100, // may be overwritten by parent | ||
| 'duration' => $total, | ||
| ]; | ||
|
|
||
| foreach ($times as $times_key => $period) { | ||
| $period = $this->analyzePeriod($times_key, $period); | ||
| if ($period === false) { | ||
| continue; | ||
| } | ||
| $period['percentage'] = 100 * $period['duration'] / $this->total; | ||
| if ($period['percentage'] < $this->minimum_percentage) { | ||
| continue; | ||
| } | ||
| $ret['periods'][] = $period; | ||
| } | ||
|
|
||
| if (isset($ret['periods'])) { | ||
| usort($ret['periods'], function ($a, $b) { | ||
| if ($a['duration'] == $b['duration']) { | ||
| return 0; | ||
| } | ||
| return ($a['duration'] > $b['duration']) ? -1 : 1; | ||
| }); | ||
| } | ||
|
|
||
| return $ret; | ||
| } | ||
|
|
||
| private function findBeginTime(array $times) { | ||
| if (isset($times[':begin'])) { | ||
| return $times[':begin']; | ||
| } | ||
| unset($times[':begin'], $times[':end']); | ||
| $first = reset($times); | ||
| if (is_array($first)) { | ||
| return $this->findBeginTime($first); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private function findEndTime(array $times) { | ||
| if (isset($times[':end'])) { | ||
| return $times[':end']; | ||
| } | ||
| unset($times[':begin'], $times[':end']); | ||
| $last = end($times); | ||
| if (is_array($last)) { | ||
| return $this->findEndTime($last); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Calculate a precise time difference. | ||
| * | ||
| * @param string $start result of microtime() | ||
| * @param string $end result of microtime() | ||
| * | ||
| * @return float difference in seconds, calculated with minimum precision loss | ||
| */ | ||
| private function diffMicrotime($start, $end) { | ||
| list($start_usec, $start_sec) = explode(" ", $start); | ||
| list($end_usec, $end_sec) = explode(" ", $end); | ||
| $diff_sec = (int)$end_sec - (int)$start_sec; | ||
| $diff_usec = (float)$end_usec - (float)$start_usec; | ||
| return (float)$diff_sec + $diff_usec; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.