|
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) 2019 nystudio107 |
|
|
|
|
|
|
9
|
|
|
*/ |
|
|
|
|
|
|
10
|
|
|
|
|
11
|
|
|
namespace nystudio107\webperf\models; |
|
12
|
|
|
|
|
13
|
|
|
use Craft; |
|
|
|
|
|
|
14
|
|
|
use craft\base\Model; |
|
|
|
|
|
|
15
|
|
|
use craft\validators\ColorValidator; |
|
|
|
|
|
|
16
|
|
|
|
|
17
|
|
|
use putyourlightson\blitz\Blitz; |
|
|
|
|
|
|
18
|
|
|
|
|
19
|
|
|
/** |
|
|
|
|
|
|
20
|
|
|
* @author nystudio107 |
|
|
|
|
|
|
21
|
|
|
* @package Webperf |
|
|
|
|
|
|
22
|
|
|
* @since 1.0.0 |
|
|
|
|
|
|
23
|
|
|
*/ |
|
|
|
|
|
|
24
|
|
|
class Settings extends Model |
|
25
|
|
|
{ |
|
26
|
|
|
// Constants |
|
27
|
|
|
// ========================================================================= |
|
28
|
|
|
|
|
29
|
|
|
const BLITZ_PLUGIN_HANDLE = 'blitz'; |
|
30
|
|
|
|
|
31
|
|
|
// Public Properties |
|
32
|
|
|
// ========================================================================= |
|
33
|
|
|
|
|
34
|
|
|
/** |
|
|
|
|
|
|
35
|
|
|
* @var string The public-facing name of the plugin |
|
36
|
|
|
*/ |
|
37
|
|
|
public $pluginName = 'Webperf'; |
|
38
|
|
|
|
|
39
|
|
|
/** |
|
|
|
|
|
|
40
|
|
|
* @var bool Whether or not to include the beacon on the page |
|
41
|
|
|
*/ |
|
42
|
|
|
public $includeBeacon = true; |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
|
|
|
|
|
45
|
|
|
* @var bool Whether or not to include the Craft profiling of pages |
|
46
|
|
|
*/ |
|
47
|
|
|
public $includeCraftProfiling = true; |
|
48
|
|
|
|
|
49
|
|
|
/** |
|
|
|
|
|
|
50
|
|
|
* @var bool If the site is static cached, turn this option on to prevent Webperf from generating a unique beacon token |
|
51
|
|
|
*/ |
|
52
|
|
|
public $staticCachedSite = false; |
|
53
|
|
|
|
|
54
|
|
|
/** |
|
|
|
|
|
|
55
|
|
|
* @var int The number of data samples to store |
|
56
|
|
|
*/ |
|
57
|
|
|
public $dataSamplesStoredLimit = 10000; |
|
58
|
|
|
|
|
59
|
|
|
/** |
|
|
|
|
|
|
60
|
|
|
* @var bool Whether the DataSamples should be trimmed after each new DataSample is added |
|
61
|
|
|
*/ |
|
62
|
|
|
public $automaticallyTrimDataSamples = true; |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
|
|
|
|
|
65
|
|
|
* @var int The number of milliseconds required between recording of frontend beacon data samples |
|
66
|
|
|
*/ |
|
67
|
|
|
public $rateLimitMs = 500; |
|
68
|
|
|
|
|
69
|
|
|
/** |
|
|
|
|
|
|
70
|
|
|
* @var string API Key for WebPageTest.org |
|
71
|
|
|
*/ |
|
72
|
|
|
public $webpageTestApiKey = ''; |
|
73
|
|
|
|
|
74
|
|
|
/** |
|
|
|
|
|
|
75
|
|
|
* @var bool Whether to filter bot user agents from generating profile hits or not |
|
76
|
|
|
* NOT visible in the GUI currently |
|
77
|
|
|
*/ |
|
78
|
|
|
public $filterBotUserAgents = true; |
|
79
|
|
|
|
|
80
|
|
|
/** |
|
|
|
|
|
|
81
|
|
|
* @var string The dashboard 'fast' color for charts |
|
82
|
|
|
*/ |
|
83
|
|
|
public $dashboardFastColor = '#00C800'; |
|
84
|
|
|
|
|
85
|
|
|
/** |
|
|
|
|
|
|
86
|
|
|
* @var string The dashboard 'average' color for charts |
|
87
|
|
|
*/ |
|
88
|
|
|
public $dashboardAverageColor = '#FFFF00'; |
|
89
|
|
|
|
|
90
|
|
|
/** |
|
|
|
|
|
|
91
|
|
|
* @var string The dashboard 'slow' color for charts |
|
92
|
|
|
*/ |
|
93
|
|
|
public $dashboardSlowColor = '#C80000'; |
|
94
|
|
|
|
|
95
|
|
|
// Public Methods |
|
96
|
|
|
// ========================================================================= |
|
97
|
|
|
|
|
98
|
|
|
public function init() |
|
|
|
|
|
|
99
|
|
|
{ |
|
100
|
|
|
parent::init(); |
|
101
|
|
|
// If Blitz is installed & enabled, flip the $staticCachedSite on |
|
102
|
|
|
$blitz = Craft::$app->getPlugins()->getPlugin(self::BLITZ_PLUGIN_HANDLE); |
|
103
|
|
|
if ($blitz && Blitz::$plugin->getSettings()->cachingEnabled) { |
|
104
|
|
|
$this->staticCachedSite = true; |
|
105
|
|
|
} |
|
106
|
|
|
} |
|
107
|
|
|
|
|
108
|
|
|
/** |
|
|
|
|
|
|
109
|
|
|
* @inheritdoc |
|
110
|
|
|
*/ |
|
|
|
|
|
|
111
|
|
|
public function rules() |
|
112
|
|
|
{ |
|
113
|
|
|
return [ |
|
114
|
|
|
['pluginName', 'string'], |
|
115
|
|
|
['pluginName', 'default', 'value' => 'Webperf'], |
|
116
|
|
|
['includeBeacon', 'boolean'], |
|
117
|
|
|
['includeCraftProfiling', 'boolean'], |
|
118
|
|
|
['staticCachedSite', 'boolean'], |
|
119
|
|
|
['dataSamplesStoredLimit', 'integer'], |
|
120
|
|
|
['dataSamplesStoredLimit', 'default', 'value' => 10000], |
|
121
|
|
|
['automaticallyTrimDataSamples', 'boolean'], |
|
122
|
|
|
['rateLimitMs', 'integer'], |
|
123
|
|
|
['rateLimitMs', 'default', 'value' => 500], |
|
124
|
|
|
['webpageTestApiKey', 'string'], |
|
125
|
|
|
['filterBotUserAgents', 'boolean'], |
|
126
|
|
|
['dashboardFastColor', 'default', 'value' => '#00C800'], |
|
127
|
|
|
['dashboardAverageColor', 'default', 'value' => '#FFFF00'], |
|
128
|
|
|
['dashboardSlowColor', 'default', 'value' => '#C80000'], |
|
129
|
|
|
[['dashboardFastColor', 'dashboardAverageColor', 'dashboardSlowColor'], ColorValidator::class], |
|
130
|
|
|
]; |
|
131
|
|
|
} |
|
132
|
|
|
} |
|
133
|
|
|
|
nystudio107 /
craft-webperf
Loading history...