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 <?php
namespace Alpha\Util\Logging;
use Alpha\Model\Type\Timestamp;
use Alpha\Model\Type\SmallText;
use Alpha\Util\Helper\Validator;
use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Service\ServiceFactory;
/**
* A Key Performance Indicator (KPI) logging class.
*
* @since 1.1
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
class KPI
{
/**
* The date/time of the KPI event.
*
* @var \Alpha\Model\Type\Timestamp
*
* @since 1.1
*/
private $timeStamp;
/**
* The name of the KPI.
*
* @var \Alpha\Model\Type\SmallText
*
* @since 1.1
*/
private $name;
/**
* The session ID of the current HTTP session.
*
* @var string
*
* @since 1.1
*/
private $sessionID;
/**
* The start time of the KPI event (UNIX timestamp in seconds).
*
* @var float
*
* @since 1.1
*/
private $startTime;
/**
* The end time of the KPI event (UNIX timestamp in seconds).
*
* @var float
*
* @since 1.1
*/
private $endTime;
/**
* The duration in seconds.
*
* @var float
*
* @since 1.1
*/
private $duration;
/**
* Constructor.
*
* @param string $name The name of the KPI which is used in the log files, must only be letters and/or numbers.
*
* @throws \Alpha\Exception\IllegalArguementException
*
* @since 1.1
*/
public function __construct($name)
{
$config = ConfigProvider::getInstance();
$this->name = new SmallText();
$this->name->setRule(Validator::REQUIRED_ALPHA_NUMERIC);
$this->name->setHelper('The KPI name can only contain letters and numbers');
$this->name->setValue($name);
$this->timeStamp = new Timestamp(date('Y-m-d H:i:s'));
$this->startTime = microtime(true);
$sessionProvider = $config->get('session.provider.name');
$session = ServiceFactory::getInstance($sessionProvider, 'Alpha\Util\Http\Session\SessionProviderInterface');
// a startTime value may have been passed from a previous request
if ($session->get($name.'-startTime') !== false) {
$this->startTime = $session->get($name.'-startTime');
$session->delete($name.'-startTime');
}
$this->sessionID = $session->getID();
}
/**
* Stores the current startTime for the KPI in the session, useful for multi-request KPI tracking.
*
* @since 1.0
*/
public function storeStartTimeInSession()
{
$config = ConfigProvider::getInstance();
$sessionProvider = $config->get('session.provider.name');
$session = ServiceFactory::getInstance($sessionProvider, 'Alpha\Util\Http\Session\SessionProviderInterface');
$session->set($this->name->getValue().'-startTime', $this->startTime);
}
/**
* Writes the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does
* not exist.
*
* @since 1.1
*/
public function log()
{
$config = ConfigProvider::getInstance();
$this->endTime = microtime(true);
$this->duration = $this->endTime-$this->startTime;
$logfile = new LogProviderFile();
$logfile->setPath($config->get('app.file.store.dir').'logs/kpi-'.$this->name->getValue().'.csv');
$logfile->setMaxSize($config->get('app.log.file.max.size'));
$logfile->writeLine(array($this->timeStamp, $this->name->getValue(), $this->sessionID, $this->startTime, $this->endTime, $this->duration));
}
/**
* Writes a step in the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does
* not exist.
*
* @since 1.1
*/
public function logStep($stepName)
{
$config = ConfigProvider::getInstance();
$this->endTime = microtime(true);
$this->duration = $this->endTime-$this->startTime;
$logfile = new LogProviderFile();
$logfile->setPath($config->get('app.file.store.dir').'logs/kpi-'.$this->name->getValue().'.csv');
$logfile->setMaxSize($config->get('app.log.file.max.size'));
$logfile->writeLine(array($this->timeStamp, $this->name->getValue().' ['.$stepName.']', $this->sessionID, $this->startTime, $this->endTime, $this->duration));
}
}