Logger.php 11.2 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
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8
namespace yii\log;
Qiang Xue committed
9

Qiang Xue committed
10 11 12
use Yii;
use yii\base\Component;
use yii\base\InvalidConfigException;
13

w  
Qiang Xue committed
14
/**
Qiang Xue committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
 * Logger records logged messages in memory and sends them to different targets as needed.
 *
 * Logger is registered as a core application component and can be accessed using `Yii::$app->log`.
 * You can call the method [[log()]] to record a single log message. For convenience, a set of shortcut
 * methods are provided for logging messages of various severity levels via the [[Yii]] class:
 *
 * - [[Yii::trace()]]
 * - [[Yii::error()]]
 * - [[Yii::warning()]]
 * - [[Yii::info()]]
 * - [[Yii::beginProfile()]]
 * - [[Yii::endProfile()]]
 *
 * When enough messages are accumulated in the logger, or when the current request finishes,
 * the logged messages will be sent to different [[targets]], such as log files, emails.
 *
 * You may configure the targets in application configuration, like the following:
 *
 * ~~~
Alexander Makarov committed
34 35 36 37 38
 * [
 *     'components' => [
 *         'log' => [
 *             'targets' => [
 *                 'file' => [
Qiang Xue committed
39
 *                     'class' => 'yii\log\FileTarget',
Alexander Makarov committed
40 41
 *                     'levels' => ['trace', 'info'],
 *                     'categories' => ['yii\*'],
Alexander Makarov committed
42
 *                 ],
Alexander Makarov committed
43
 *                 'email' => [
Qiang Xue committed
44
 *                     'class' => 'yii\log\EmailTarget',
Alexander Makarov committed
45 46 47 48 49 50 51
 *                     'levels' => ['error', 'warning'],
 *                     'emails' => ['admin@example.com'],
 *                 ],
 *             ],
 *         ],
 *     ],
 * ]
Qiang Xue committed
52 53 54 55 56 57 58 59
 * ~~~
 *
 * Each log target can have a name and can be referenced via the [[targets]] property
 * as follows:
 *
 * ~~~
 * Yii::$app->log->targets['file']->enabled = false;
 * ~~~
w  
Qiang Xue committed
60
 *
Qiang Xue committed
61 62
 * 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
63
 *
64 65 66 67
 * @property array $dbProfiling The first element indicates the number of SQL statements executed, and the
 * second element the total time spent in SQL execution. This property is read-only.
 * @property float $elapsedTime The total elapsed time in seconds for current request. This property is
 * read-only.
68 69
 * @property array $profiling The profiling results. Each array element has the following structure: `[$token,
 * $category, $time]`. This property is read-only.
70
 *
w  
Qiang Xue committed
71 72 73
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
Qiang Xue committed
74
class Logger extends Component
w  
Qiang Xue committed
75
{
Qiang Xue committed
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
	/**
	 * 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
110 111

	/**
Qiang Xue committed
112
	 * @var array logged messages. This property is managed by [[log()]] and [[flush()]].
w  
Qiang Xue committed
113 114 115
	 * Each log message is of the following structure:
	 *
	 * ~~~
Alexander Makarov committed
116
	 * [
Qiang Xue committed
117
	 *   [0] => message (mixed, can be a string or some complex data, such as an exception object)
Qiang Xue committed
118
	 *   [1] => level (integer)
w  
Qiang Xue committed
119 120
	 *   [2] => category (string)
	 *   [3] => timestamp (float, obtained by microtime(true))
121
	 *   [4] => traces (array, debug backtrace, contains the application code call stacks)
Alexander Makarov committed
122
	 * ]
w  
Qiang Xue committed
123
	 * ~~~
w  
Qiang Xue committed
124
	 */
Alexander Makarov committed
125
	public $messages = [];
Qiang Xue committed
126 127 128 129
	/**
	 * @var array debug data. This property stores various types of debug data reported at
	 * different instrument places.
	 */
Alexander Makarov committed
130
	public $data = [];
Qiang Xue committed
131
	/**
Qiang Xue committed
132
	 * @var array|Target[] the log targets. Each array element represents a single [[Target|log target]] instance
Qiang Xue committed
133
	 * or the configuration for creating the log target instance.
Qiang Xue committed
134
	 */
Alexander Makarov committed
135
	public $targets = [];
Qiang Xue committed
136 137 138 139 140 141 142 143
	/**
	 * @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;
144 145
	/**
	 * @var integer how much call stack information (file name and line number) should be logged for each message.
146 147 148 149
	 * If it is greater than 0, at most that number of call stacks will be logged. Note that only application
	 * call stacks are counted.
	 *
	 * If not set, it will default to 3 when `YII_ENV` is set as "dev", and 0 otherwise.
150
	 */
151
	public $traceLevel;
Qiang Xue committed
152

Qiang Xue committed
153 154 155 156 157 158
	/**
	 * Initializes the logger by registering [[flush()]] as a shutdown function.
	 */
	public function init()
	{
		parent::init();
159
		if ($this->traceLevel === null) {
160
			$this->traceLevel = YII_ENV_DEV ? 3 : 0;
161
		}
Qiang Xue committed
162 163 164 165 166
		foreach ($this->targets as $name => $target) {
			if (!$target instanceof Target) {
				$this->targets[$name] = Yii::createObject($target);
			}
		}
Alexander Makarov committed
167
		register_shutdown_function([$this, 'flush'], true);
Qiang Xue committed
168 169
	}

w  
Qiang Xue committed
170 171
	/**
	 * Logs a message with the given type and category.
172 173
	 * If [[traceLevel]] is greater than 0, additional call stack information about
	 * the application code will be logged as well.
w  
Qiang Xue committed
174
	 * @param string $message the message to be logged.
Qiang Xue committed
175 176 177
	 * @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
178 179
	 * @param string $category the category of the message.
	 */
Qiang Xue committed
180
	public function log($message, $level, $category = 'application')
w  
Qiang Xue committed
181
	{
Qiang Xue committed
182
		$time = microtime(true);
Alexander Makarov committed
183
		$traces = [];
184
		if ($this->traceLevel > 0) {
w  
Qiang Xue committed
185
			$count = 0;
186 187 188
			$ts = debug_backtrace();
			array_pop($ts); // remove the last trace since it would be the entry script, not very useful
			foreach ($ts as $trace) {
Qiang Xue committed
189
				if (isset($trace['file'], $trace['line']) && strpos($trace['file'], YII_PATH) !== 0) {
190 191 192
					unset($trace['object'], $trace['args']);
					$traces[] = $trace;
					if (++$count >= $this->traceLevel) {
w  
Qiang Xue committed
193 194 195 196 197
						break;
					}
				}
			}
		}
Alexander Makarov committed
198
		$this->messages[] = [$message, $level, $category, $time, $traces];
199
		if ($this->flushInterval > 0 && count($this->messages) >= $this->flushInterval) {
Qiang Xue committed
200
			$this->flush();
w  
Qiang Xue committed
201 202 203 204
		}
	}

	/**
205
	 * Flushes log messages from memory to targets.
Qiang Xue committed
206
	 * @param boolean $final whether this is a final call during a request.
w  
Qiang Xue committed
207
	 */
Qiang Xue committed
208
	public function flush($final = false)
w  
Qiang Xue committed
209
	{
Qiang Xue committed
210 211 212 213 214
		/** @var Target $target */
		foreach ($this->targets as $target) {
			if ($target->enabled) {
				$target->collect($this->messages, $final);
			}
Qiang Xue committed
215
		}
Alexander Makarov committed
216
		$this->messages = [];
w  
Qiang Xue committed
217 218 219 220 221 222
	}

	/**
	 * 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
223
	 * of [[BaseYii]] class file.
w  
Qiang Xue committed
224 225
	 * @return float the total elapsed time in seconds for current request.
	 */
Qiang Xue committed
226
	public function getElapsedTime()
w  
Qiang Xue committed
227 228 229 230 231 232
	{
		return microtime(true) - YII_BEGIN_TIME;
	}

	/**
	 * Returns the profiling results.
w  
Qiang Xue committed
233 234 235 236 237 238 239 240
	 *
	 * 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
241
	 * such as 'yii\db\Connection'.
242
	 * @param array $excludeCategories list of categories that you want to exclude
w  
Qiang Xue committed
243
	 * @return array the profiling results. Each array element has the following structure:
Alexander Makarov committed
244
	 *  `[$token, $category, $time]`.
w  
Qiang Xue committed
245
	 */
Alexander Makarov committed
246
	public function getProfiling($categories = [], $excludeCategories = [])
w  
Qiang Xue committed
247
	{
w  
Qiang Xue committed
248 249 250
		$timings = $this->calculateTimings();
		if (empty($categories) && empty($excludeCategories)) {
			return $timings;
w  
Qiang Xue committed
251
		}
w  
Qiang Xue committed
252 253 254 255 256

		foreach ($timings as $i => $timing) {
			$matched = empty($categories);
			foreach ($categories as $category) {
				$prefix = rtrim($category, '*');
Qiang Xue committed
257
				if (strpos($timing[1], $prefix) === 0 && ($timing[1] === $category || $prefix !== $category)) {
w  
Qiang Xue committed
258 259 260 261 262 263 264 265 266
					$matched = true;
					break;
				}
			}

			if ($matched) {
				foreach ($excludeCategories as $category) {
					$prefix = rtrim($category, '*');
					foreach ($timings as $i => $timing) {
Qiang Xue committed
267
						if (strpos($timing[1], $prefix) === 0 && ($timing[1] === $category || $prefix !== $category)) {
w  
Qiang Xue committed
268 269 270 271 272 273 274 275 276
							$matched = false;
							break;
						}
					}
				}
			}

			if (!$matched) {
				unset($timings[$i]);
w  
Qiang Xue committed
277 278
			}
		}
w  
Qiang Xue committed
279
		return array_values($timings);
w  
Qiang Xue committed
280 281
	}

282 283 284 285 286 287 288 289 290
	/**
	 * Returns the statistical results of DB queries.
	 * The results returned include the number of SQL statements executed and
	 * the total time spent.
	 * @return array the first element indicates the number of SQL statements executed,
	 * and the second element the total time spent in SQL execution.
	 */
	public function getDbProfiling()
	{
Alexander Makarov committed
291
		$timings = $this->getProfiling(['yii\db\Command::query', 'yii\db\Command::execute']);
292 293 294 295 296
		$count = count($timings);
		$time = 0;
		foreach ($timings as $timing) {
			$time += $timing[1];
		}
Alexander Makarov committed
297
		return [$count, $time];
298 299
	}

w  
Qiang Xue committed
300 301
	private function calculateTimings()
	{
Alexander Makarov committed
302 303
		$timings = [];
		$stack = [];
w  
Qiang Xue committed
304
		foreach ($this->messages as $log) {
Qiang Xue committed
305 306
			list($token, $level, $category, $timestamp) = $log;
			if ($level == self::LEVEL_PROFILE_BEGIN) {
w  
Qiang Xue committed
307
				$stack[] = $log;
Qiang Xue committed
308
			} elseif ($level == self::LEVEL_PROFILE_END) {
Qiang Xue committed
309
				if (($last = array_pop($stack)) !== null && $last[0] === $token) {
Alexander Makarov committed
310
					$timings[] = [$token, $category, $timestamp - $last[3]];
Qiang Xue committed
311
				} else {
Qiang Xue committed
312
					throw new InvalidConfigException("Unmatched profiling block: $token");
w  
Qiang Xue committed
313 314 315 316 317 318 319
				}
			}
		}

		$now = microtime(true);
		while (($last = array_pop($stack)) !== null) {
			$delta = $now - $last[3];
Alexander Makarov committed
320
			$timings[] = [$last[0], $last[2], $delta];
w  
Qiang Xue committed
321 322
		}

w  
Qiang Xue committed
323
		return $timings;
w  
Qiang Xue committed
324
	}
Qiang Xue committed
325 326 327 328 329 330 331 332

	/**
	 * Returns the text display of the specified level.
	 * @param integer $level the message level, e.g. [[LEVEL_ERROR]], [[LEVEL_WARNING]].
	 * @return string the text display of the level
	 */
	public static function getLevelName($level)
	{
Alexander Makarov committed
333
		static $levels = [
Qiang Xue committed
334 335 336 337 338 339
			self::LEVEL_ERROR => 'error',
			self::LEVEL_WARNING => 'warning',
			self::LEVEL_INFO => 'info',
			self::LEVEL_TRACE => 'trace',
			self::LEVEL_PROFILE_BEGIN => 'profile begin',
			self::LEVEL_PROFILE_END => 'profile end',
Alexander Makarov committed
340
		];
Qiang Xue committed
341 342
		return isset($levels[$level]) ? $levels[$level] : 'unknown';
	}
w  
Qiang Xue committed
343
}