Yii2 Bootstrap 3
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

278 lines
8.9 KiB

13 years ago
<?php
/**
* Logger class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright &copy; 2008-2012 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\logging;
/**
* Logger records logged messages in memory.
*
* When [[flushInterval]] is reached or when application terminates, it will
* call [[flush]] to send logged messages to different log targets, such as
* file, email, Web.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class Logger extends \yii\base\Component
{
13 years ago
const LEVEL_ERROR = 'error';
const LEVEL_WARNING = 'warning';
const LEVEL_INFO = 'info';
const LEVEL_TRACE = 'trace';
const LEVEL_PROFILE_BEGIN = 'profile-begin';
const LEVEL_PROFILE_END = 'profile-end';
13 years ago
/**
* @var integer how many messages should be logged before they are flushed from memory and sent to targets.
* Defaults to 1000, meaning the [[flush]] method will be invoked once every 1000 messages logged.
* Set this property to be 0 if you don't want to flush messages until the application terminates.
* This property mainly affects how much memory will be taken by the logged messages.
* A smaller value means less memory, but will increase the execution time due to the overhead of [[flush]].
*/
public $flushInterval = 1000;
/**
* @var boolean this property will be passed as the parameter to [[flush]] when it is
13 years ago
* called due to the [[flushInterval]] is reached. Defaults to true, meaning the flushed
* messages will be exported to the actual storage medium (e.g. DB, email) defined by each
* log target. If false, the flushed messages will be kept in the memory of each log target.
13 years ago
* @see flushInterval
*/
13 years ago
public $autoExport = true;
13 years ago
/**
* @var array logged messages. This property is mainly managed by [[log]] and [[flush]].
13 years ago
* Each log message is of the following structure:
*
* ~~~
* array(
* [0] => message (string)
* [1] => level (string)
* [2] => category (string)
* [3] => timestamp (float, obtained by microtime(true))
* )
* ~~~
13 years ago
*/
public $messages = array();
/**
* Logs an error message.
* An error message is typically logged when an unrecoverable error occurs
* during the execution of an application.
* @param string $message the message to be logged.
* @param string $category the category of the message.
*/
public function error($message, $category = 'application')
{
$this->log($message, self::LEVEL_ERROR, $category);
}
/**
* Logs a trace message.
* Trace messages are logged mainly for development purpose to see
* the execution work flow of some code.
* @param string $message the message to be logged.
* @param string $category the category of the message.
*/
public function trace($message, $category = 'application')
{
$this->log($message, self::LEVEL_TRACE, $category);
}
/**
* Logs a warning message.
* A warning message is typically logged when an error occurs while the execution
* can still continue.
* @param string $message the message to be logged.
* @param string $category the category of the message.
*/
13 years ago
public function warning($message, $category = 'application')
13 years ago
{
$this->log($message, self::LEVEL_TRACE, $category);
}
/**
* Logs an informative message.
* An informative message is typically logged by an application to keep record of
* something important (e.g. an administrator logs in).
* @param string $message the message to be logged.
* @param string $category the category of the message.
*/
public function info($message, $category = 'application')
{
$this->log($message, self::LEVEL_TRACE, $category);
}
/**
* Marks the beginning of a code block for profiling.
* This has to be matched with a call to [[endProfile]] with the same category name.
* The begin- and end- calls must also be properly nested. For example,
13 years ago
* @param string $token token for the code block
* @param string $category the category of this log message
13 years ago
* @see endProfile
*/
13 years ago
public function beginProfile($token, $category)
13 years ago
{
13 years ago
$this->log($token, self::LEVEL_PROFILE_BEGIN, $category);
13 years ago
}
/**
* Marks the end of a code block for profiling.
* This has to be matched with a previous call to [[beginProfile]] with the same category name.
13 years ago
* @param string $token token for the code block
* @param string $category the category of this log message
13 years ago
* @see beginProfile
*/
13 years ago
public function endProfile($token, $category)
13 years ago
{
13 years ago
$this->log($token, self::LEVEL_PROFILE_END, $category);
13 years ago
}
/**
* Logs a message with the given type and category.
* If `YII_DEBUG` is true and `YII_TRACE_LEVEL` is greater than 0, then additional
* call stack information about application code will be appended to the message.
* @param string $message the message to be logged.
* @param string $level the level of the message. This must be one of the following:
13 years ago
* 'trace', 'info', 'warning', 'error', 'profile'.
13 years ago
* @param string $category the category of the message.
*/
public function log($message, $level, $category)
{
13 years ago
if (YII_DEBUG && YII_TRACE_LEVEL > 0 && $level <= self::LEVEL_TRACE) {
13 years ago
$traces = debug_backtrace();
$count = 0;
foreach ($traces as $trace) {
13 years ago
if (isset($trace['file'], $trace['line']) && strpos($trace['file'], YII_PATH) !== 0) {
13 years ago
$message .= "\nin " . $trace['file'] . ' (' . $trace['line'] . ')';
if (++$count >= YII_TRACE_LEVEL) {
break;
}
}
}
}
$this->messages[] = array($message, $level, $category, microtime(true));
if (count($this->messages) >= $this->flushInterval && $this->flushInterval > 0) {
$this->flush($this->autoExport);
}
}
/**
13 years ago
* Removes all recorded messages from the memory.
* This method will raise an {@link onFlush} event.
* The attached event handlers can process the log messages before they are removed.
* @param boolean $export whether to notify log targets to export the filtered messages they have received.
13 years ago
*/
13 years ago
public function flush($export = false)
13 years ago
{
13 years ago
$this->onFlush(new \yii\base\Event($this, array('export' => $export, 'flush' => true)));
$this->messages = array();
13 years ago
}
/**
13 years ago
* Raises an `onFlush` event.
* @param \yii\base\Event $event the event parameter
13 years ago
*/
13 years ago
public function onFlush($event)
13 years ago
{
13 years ago
$this->raiseEvent('onFlush', $event);
13 years ago
}
/**
* Returns the total elapsed time since the start of the current request.
* This method calculates the difference between now and the timestamp
* defined by constant `YII_BEGIN_TIME` which is evaluated at the beginning
* of [[YiiBase]] class file.
* @return float the total elapsed time in seconds for current request.
*/
public function getExecutionTime()
{
return microtime(true) - YII_BEGIN_TIME;
}
/**
* Returns the profiling results.
13 years ago
*
* By default, all profiling results will be returned. You may provide
* `$categories` and `$excludeCategories` as parameters to retrieve the
* results that you are interested in.
*
* @param array $categories list of categories that you are interested in.
* You can use an asterisk at the end of a category to do a prefix match.
* For example, 'yii\db\*' will match categories starting with 'yii\db\',
* such as 'yii\db\dao\Connection'.
* @param array $excludeCategories list of categories that you are interested in.
* @return array the profiling results. Each array element has the following structure:
13 years ago
* `array($token, $category, $time)`.
13 years ago
*/
13 years ago
public function getProfiling($categories = array(), $excludeCategories = array())
13 years ago
{
13 years ago
$timings = $this->calculateTimings();
if (empty($categories) && empty($excludeCategories)) {
return $timings;
13 years ago
}
13 years ago
foreach ($timings as $i => $timing) {
$matched = empty($categories);
foreach ($categories as $category) {
$prefix = rtrim($category, '*');
13 years ago
if (strpos($timing[1], $prefix) === 0 && ($timing[1] === $category || $prefix !== $category)) {
13 years ago
$matched = true;
break;
}
}
if ($matched) {
foreach ($excludeCategories as $category) {
$prefix = rtrim($category, '*');
foreach ($timings as $i => $timing) {
13 years ago
if (strpos($timing[1], $prefix) === 0 && ($timing[1] === $category || $prefix !== $category)) {
13 years ago
$matched = false;
break;
}
}
}
}
if (!$matched) {
unset($timings[$i]);
13 years ago
}
}
13 years ago
return array_values($timings);
13 years ago
}
private function calculateTimings()
{
13 years ago
$timings = array();
13 years ago
$stack = array();
foreach ($this->messages as $log) {
13 years ago
if ($log[1] === self::LEVEL_PROFILE_BEGIN) {
13 years ago
$stack[] = $log;
13 years ago
} elseif ($log[1] === self::LEVEL_PROFILE_END) {
list($token, $level, $category, $timestamp) = $log;
13 years ago
if (($last = array_pop($stack)) !== null && $last[0] === $token) {
$timings[] = array($token, $category, $timestamp - $last[3]);
} else {
throw new \yii\base\Exception("Unmatched profiling block: $token");
13 years ago
}
}
}
$now = microtime(true);
while (($last = array_pop($stack)) !== null) {
$delta = $now - $last[3];
13 years ago
$timings[] = array($last[0], $last[2], $delta);
13 years ago
}
13 years ago
return $timings;
13 years ago
}
}