Logger.php 7.19 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7 8
 * @license http://www.yiiframework.com/license/
 */

namespace yii\logging;
Qiang Xue committed
9
use yii\base\InvalidConfigException;
10

w  
Qiang Xue committed
11 12 13
/**
 * Logger records logged messages in memory.
 *
Qiang Xue committed
14 15
 * When the application ends or [[flushInterval]] is reached, Logger will call [[flush()]]
 * to send logged messages to different log targets, such as file, email, Web.
w  
Qiang Xue committed
16 17 18 19 20 21
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Logger extends \yii\base\Component
{
Qiang Xue committed
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
	/**
	 * Error message level. An error message is one that indicates the abnormal termination of the
	 * application and may require developer's handling.
	 */
	const LEVEL_ERROR = 0x01;
	/**
	 * Warning message level. A warning message is one that indicates some abnormal happens but
	 * the application is able to continue to run. Developers should pay attention to this message.
	 */
	const LEVEL_WARNING = 0x02;
	/**
	 * Informational message level. An informational message is one that includes certain information
	 * for developers to review.
	 */
	const LEVEL_INFO = 0x04;
	/**
	 * Tracing message level. An tracing message is one that reveals the code execution flow.
	 */
	const LEVEL_TRACE = 0x08;
	/**
	 * Profiling message level. This indicates the message is for profiling purpose.
	 */
	const LEVEL_PROFILE = 0x40;
	/**
	 * Profiling message level. This indicates the message is for profiling purpose. It marks the
	 * beginning of a profiling block.
	 */
	const LEVEL_PROFILE_BEGIN = 0x50;
	/**
	 * Profiling message level. This indicates the message is for profiling purpose. It marks the
	 * end of a profiling block.
	 */
	const LEVEL_PROFILE_END = 0x60;

w  
Qiang Xue committed
56 57 58 59 60 61

	/**
	 * @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.
Qiang Xue committed
62
	 * A smaller value means less memory, but will increase the execution time due to the overhead of [[flush()]].
w  
Qiang Xue committed
63 64 65
	 */
	public $flushInterval = 1000;
	/**
Qiang Xue committed
66
	 * @var array logged messages. This property is mainly managed by [[log()]] and [[flush()]].
w  
Qiang Xue committed
67 68 69 70
	 * Each log message is of the following structure:
	 *
	 * ~~~
	 * array(
Qiang Xue committed
71
	 *   [0] => message (mixed, can be a string or some complex data, such as an exception object)
Qiang Xue committed
72
	 *   [1] => level (integer)
w  
Qiang Xue committed
73 74 75 76
	 *   [2] => category (string)
	 *   [3] => timestamp (float, obtained by microtime(true))
	 * )
	 * ~~~
w  
Qiang Xue committed
77 78
	 */
	public $messages = array();
Qiang Xue committed
79 80 81 82
	/**
	 * @var Router the log target router registered with this logger.
	 */
	public $router;
w  
Qiang Xue committed
83

Qiang Xue committed
84 85 86 87 88 89 90 91 92
	/**
	 * Initializes the logger by registering [[flush()]] as a shutdown function.
	 */
	public function init()
	{
		parent::init();
		register_shutdown_function(array($this, 'flush'), true);
	}

w  
Qiang Xue committed
93 94 95 96 97
	/**
	 * 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.
Qiang Xue committed
98 99 100
	 * @param integer $level the level of the message. This must be one of the following:
	 * `Logger::LEVEL_ERROR`, `Logger::LEVEL_WARNING`, `Logger::LEVEL_INFO`, `Logger::LEVEL_TRACE`,
	 * `Logger::LEVEL_PROFILE_BEGIN`, `Logger::LEVEL_PROFILE_END`.
w  
Qiang Xue committed
101 102
	 * @param string $category the category of the message.
	 */
Qiang Xue committed
103
	public function log($message, $level, $category = 'application')
w  
Qiang Xue committed
104
	{
Qiang Xue committed
105 106
		$time = microtime(true);
		if (YII_DEBUG && YII_TRACE_LEVEL > 0) {
w  
Qiang Xue committed
107 108 109
			$traces = debug_backtrace();
			$count = 0;
			foreach ($traces as $trace) {
Qiang Xue committed
110
				if (isset($trace['file'], $trace['line']) && strpos($trace['file'], YII_PATH) !== 0) {
Qiang Xue committed
111
					$message .= "\nin {$trace['file']} ({$trace['line']})";
w  
Qiang Xue committed
112 113 114 115 116 117
					if (++$count >= YII_TRACE_LEVEL) {
						break;
					}
				}
			}
		}
Qiang Xue committed
118
		$this->messages[] = array($message, $level, $category, $time);
119
		if ($this->flushInterval > 0 && count($this->messages) >= $this->flushInterval) {
Qiang Xue committed
120
			$this->flush();
w  
Qiang Xue committed
121 122 123 124
		}
	}

	/**
125
	 * Flushes log messages from memory to targets.
Qiang Xue committed
126
	 * This method will trigger an [[EVENT_FLUSH]] or [[EVENT_FINAL_FLUSH]] event depending on the $final value.
Qiang Xue committed
127
	 * @param boolean $final whether this is a final call during a request.
w  
Qiang Xue committed
128
	 */
Qiang Xue committed
129
	public function flush($final = false)
w  
Qiang Xue committed
130
	{
Qiang Xue committed
131 132 133
		if ($this->router) {
			$this->router->dispatch($this->messages, $final);
		}
w  
Qiang Xue committed
134
		$this->messages = array();
w  
Qiang Xue committed
135 136 137 138 139 140 141 142 143
	}

	/**
	 * 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.
	 */
Qiang Xue committed
144
	public function getElapsedTime()
w  
Qiang Xue committed
145 146 147 148 149 150
	{
		return microtime(true) - YII_BEGIN_TIME;
	}

	/**
	 * Returns the profiling results.
w  
Qiang Xue committed
151 152 153 154 155 156 157 158
	 *
	 * 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\',
Qiang Xue committed
159
	 * such as 'yii\db\Connection'.
160
	 * @param array $excludeCategories list of categories that you want to exclude
w  
Qiang Xue committed
161
	 * @return array the profiling results. Each array element has the following structure:
Qiang Xue committed
162
	 *  `array($token, $category, $time)`.
w  
Qiang Xue committed
163
	 */
w  
Qiang Xue committed
164
	public function getProfiling($categories = array(), $excludeCategories = array())
w  
Qiang Xue committed
165
	{
w  
Qiang Xue committed
166 167 168
		$timings = $this->calculateTimings();
		if (empty($categories) && empty($excludeCategories)) {
			return $timings;
w  
Qiang Xue committed
169
		}
w  
Qiang Xue committed
170 171 172 173 174

		foreach ($timings as $i => $timing) {
			$matched = empty($categories);
			foreach ($categories as $category) {
				$prefix = rtrim($category, '*');
Qiang Xue committed
175
				if (strpos($timing[1], $prefix) === 0 && ($timing[1] === $category || $prefix !== $category)) {
w  
Qiang Xue committed
176 177 178 179 180 181 182 183 184
					$matched = true;
					break;
				}
			}

			if ($matched) {
				foreach ($excludeCategories as $category) {
					$prefix = rtrim($category, '*');
					foreach ($timings as $i => $timing) {
Qiang Xue committed
185
						if (strpos($timing[1], $prefix) === 0 && ($timing[1] === $category || $prefix !== $category)) {
w  
Qiang Xue committed
186 187 188 189 190 191 192 193 194
							$matched = false;
							break;
						}
					}
				}
			}

			if (!$matched) {
				unset($timings[$i]);
w  
Qiang Xue committed
195 196
			}
		}
w  
Qiang Xue committed
197
		return array_values($timings);
w  
Qiang Xue committed
198 199 200 201
	}

	private function calculateTimings()
	{
w  
Qiang Xue committed
202
		$timings = array();
w  
Qiang Xue committed
203 204 205

		$stack = array();
		foreach ($this->messages as $log) {
Qiang Xue committed
206 207
			list($token, $level, $category, $timestamp) = $log;
			if ($level == self::LEVEL_PROFILE_BEGIN) {
w  
Qiang Xue committed
208
				$stack[] = $log;
Qiang Xue committed
209
			} elseif ($level == self::LEVEL_PROFILE_END) {
Qiang Xue committed
210 211 212
				if (($last = array_pop($stack)) !== null && $last[0] === $token) {
					$timings[] = array($token, $category, $timestamp - $last[3]);
				} else {
Qiang Xue committed
213
					throw new InvalidConfigException("Unmatched profiling block: $token");
w  
Qiang Xue committed
214 215 216 217 218 219 220
				}
			}
		}

		$now = microtime(true);
		while (($last = array_pop($stack)) !== null) {
			$delta = $now - $last[3];
Qiang Xue committed
221
			$timings[] = array($last[0], $last[2], $delta);
w  
Qiang Xue committed
222 223
		}

w  
Qiang Xue committed
224
		return $timings;
w  
Qiang Xue committed
225 226
	}
}