1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Webperf plugin for Craft CMS 3.x |
4
|
|
|
* |
5
|
|
|
* Monitor the performance of your webpages through real-world user timing data |
6
|
|
|
* |
7
|
|
|
* @link https://nystudio107.com |
|
|
|
|
8
|
|
|
* @copyright Copyright (c) 2018 nystudio107 |
|
|
|
|
9
|
|
|
*/ |
|
|
|
|
10
|
|
|
|
11
|
|
|
namespace nystudio107\webperf\log; |
12
|
|
|
|
13
|
|
|
use nystudio107\webperf\Webperf; |
14
|
|
|
|
15
|
|
|
use yii\log\Target; |
|
|
|
|
16
|
|
|
use yii\log\Logger; |
|
|
|
|
17
|
|
|
|
18
|
|
|
/** |
|
|
|
|
19
|
|
|
* @author nystudio107 |
|
|
|
|
20
|
|
|
* @package Webperf |
|
|
|
|
21
|
|
|
* @since 1.0.0 |
|
|
|
|
22
|
|
|
*/ |
|
|
|
|
23
|
|
|
class ProfileTarget extends Target |
24
|
|
|
{ |
25
|
|
|
|
26
|
|
|
const PROFILE_CATEGORIES = [ |
27
|
|
|
'database' => [ |
28
|
|
|
'prefix' => 'yii\db', |
29
|
|
|
], |
30
|
|
|
'twig' => [ |
31
|
|
|
'prefix' => 'craft\web\twig\Template', |
32
|
|
|
], |
33
|
|
|
'other' => [ |
34
|
|
|
'prefix' => 'webperf-other', |
35
|
|
|
], |
36
|
|
|
]; |
37
|
|
|
|
38
|
|
|
// Public Properties |
39
|
|
|
// ========================================================================= |
40
|
|
|
|
41
|
|
|
public $stats = []; |
42
|
|
|
|
43
|
|
|
// Public Methods |
44
|
|
|
// ========================================================================= |
45
|
|
|
|
46
|
|
|
/** |
|
|
|
|
47
|
|
|
* @inheritdoc |
48
|
|
|
*/ |
|
|
|
|
49
|
|
|
public function init() |
50
|
|
|
{ |
51
|
|
|
parent::init(); |
52
|
|
|
foreach (self::PROFILE_CATEGORIES as $key => $value) { |
53
|
|
|
$this->stats[$key] = [ |
54
|
|
|
'count' => 0, |
55
|
|
|
'duration' => 0.0, |
56
|
|
|
'memory' => 0, |
57
|
|
|
]; |
58
|
|
|
} |
59
|
|
|
} |
60
|
|
|
|
61
|
|
|
/** |
62
|
|
|
* Processes the given log messages. |
63
|
|
|
* This method will filter the given messages with [[levels]] and [[categories]]. |
64
|
|
|
* And if requested, it will also export the filtering result to specific medium (e.g. email). |
65
|
|
|
* @param array $messages log messages to be processed. See [[Logger::messages]] for the structure |
|
|
|
|
66
|
|
|
* of each message. |
|
|
|
|
67
|
|
|
* @param bool $final whether this method is called at the end of the current application |
|
|
|
|
68
|
|
|
*/ |
|
|
|
|
69
|
|
|
public function collect($messages, $final) |
70
|
|
|
{ |
71
|
|
|
// Bail if either values are null |
72
|
|
|
if (($messages === null) || ($this->messages === null)) { |
73
|
|
|
return; |
74
|
|
|
} |
75
|
|
|
// Merge in any messages intended for us |
76
|
|
|
$this->messages = array_merge( |
|
|
|
|
77
|
|
|
$this->messages, |
78
|
|
|
static::filterMessages($messages, $this->getLevels(), $this->categories, $this->except) |
79
|
|
|
); |
80
|
|
|
// Calculate the timings from the messages, and then reset them |
81
|
|
|
$timings = $this->calculateTimings($this->messages); |
82
|
|
|
$this->messages = []; |
83
|
|
|
// Loop through and tally up all of the timings |
84
|
|
|
foreach ($timings as $timing) { |
85
|
|
|
$cat = 'other'; |
86
|
|
|
foreach (self::PROFILE_CATEGORIES as $key => $value) { |
87
|
|
|
if (strpos($timing['category'], $value['prefix']) === 0) { |
88
|
|
|
$cat = $key; |
89
|
|
|
} |
90
|
|
|
} |
91
|
|
|
$this->stats[$cat]['count']++; |
92
|
|
|
$this->stats[$cat]['duration'] += (float)$timing['duration'] * 1000; |
93
|
|
|
$this->stats[$cat]['memory'] += (int)$timing['memoryDiff']; |
94
|
|
|
} |
95
|
|
|
if ($final) { |
96
|
|
|
$this->export(); |
97
|
|
|
Webperf::$plugin->beacons->includeCraftBeacon(); |
98
|
|
|
} |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
/** |
|
|
|
|
102
|
|
|
* @inheritdoc |
103
|
|
|
*/ |
|
|
|
|
104
|
|
|
public function export() |
105
|
|
|
{ |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
// Protected Methods |
109
|
|
|
// ========================================================================= |
110
|
|
|
|
111
|
|
|
/** |
112
|
|
|
* Calculates the elapsed time for the given log messages. |
113
|
|
|
* @param array $messages the log messages obtained from profiling |
|
|
|
|
114
|
|
|
* @return array timings. Each element is an array consisting of these elements: |
|
|
|
|
115
|
|
|
* `info`, `category`, `timestamp`, `trace`, `level`, `duration`, `memory`, `memoryDiff`. |
116
|
|
|
* The `memory` and `memoryDiff` values are available since version 2.0.11. |
117
|
|
|
*/ |
118
|
|
|
protected function calculateTimings($messages): array |
119
|
|
|
{ |
120
|
|
|
$timings = []; |
121
|
|
|
$stack = []; |
122
|
|
|
|
123
|
|
|
foreach ($messages as $i => $log) { |
124
|
|
|
list($token, $level, $category, $timestamp, $traces) = $log; |
125
|
|
|
$memory = isset($log[5]) ? $log[5] : 0; |
126
|
|
|
$log[6] = $i; |
127
|
|
|
$hash = md5(json_encode($token)); |
128
|
|
|
if ($level == Logger::LEVEL_PROFILE_BEGIN) { |
129
|
|
|
$stack[$hash] = $log; |
130
|
|
|
} elseif ($level == Logger::LEVEL_PROFILE_END) { |
131
|
|
|
if (isset($stack[$hash])) { |
132
|
|
|
$timings[$stack[$hash][6]] = [ |
133
|
|
|
'category' => $stack[$hash][2], |
134
|
|
|
'timestamp' => $stack[$hash][3], |
135
|
|
|
'level' => count($stack) - 1, |
136
|
|
|
'duration' => $timestamp - $stack[$hash][3], |
137
|
|
|
'memory' => $memory, |
138
|
|
|
'memoryDiff' => $memory - (isset($stack[$hash][5]) ? $stack[$hash][5] : 0), |
139
|
|
|
]; |
140
|
|
|
unset($stack[$hash]); |
141
|
|
|
} |
142
|
|
|
} |
143
|
|
|
} |
144
|
|
|
|
145
|
|
|
return array_values($timings); |
146
|
|
|
} |
147
|
|
|
} |
148
|
|
|
|