PHP Класс yii\log\Logger
A Logger instance can be accessed via
Yii::getLogger(). You can call the method
Logger::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()]]
For more details and usage information on Logger, see the
guide article on logging.
When the application ends or [[flushInterval]] is reached, Logger will call
Logger::flush
to send logged messages to different log targets, such as [[FileTarget|file]], [[EmailTarget|email]],
or [[DbTarget|database]], with the help of the [[dispatcher]].
Показать файл
Открыть проект
Примеры использования класса
Открытые свойства
| Свойство |
Тип |
Описание |
|
| $dispatcher |
|
the message dispatcher |
|
| $flushInterval |
|
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 Logger::flush. |
|
| $messages |
|
logged messages. This property is managed by Logger::log and Logger::flush.
Each log message is of the following structure:
[
[0] => message (mixed, can be a string or some complex data, such as an exception object)
[1] => level (integer)
[2] => category (string)
[3] => timestamp (float, obtained by microtime(true))
[4] => traces (array, debug backtrace, contains the application code call stacks)
]
|
|
| $traceLevel |
|
how much call stack information (file name and line number) should be logged for each message.
If it is greater than 0, at most that number of call stacks will be logged. Note that only application
call stacks are counted. |
|
Открытые методы
Описание методов
calculateTimings()
публичный Метод
Calculates the elapsed time for the given log messages.
|
public calculateTimings ( array $messages ) : array |
|
$messages |
array |
the log messages obtained from profiling |
| Результат |
array |
timings. Each element is an array consisting of these elements:
`info`, `category`, `timestamp`, `trace`, `level`, `duration`. |
Flushes log messages from memory to targets.
|
public flush ( boolean $final = false ) |
|
$final |
boolean |
whether this is a final call during a request. |
getDbProfiling()
публичный Метод
The results returned include the number of SQL statements executed and
the total time spent.
|
public getDbProfiling ( ) : array |
| Результат |
array |
the first element indicates the number of SQL statements executed,
and the second element the total time spent in SQL execution. |
getElapsedTime()
публичный Метод
This method calculates the difference between now and the timestamp
defined by constant
YII_BEGIN_TIME which is evaluated at the beginning
of
BaseYii class file.
getLevelName()
публичный статический Метод
Returns the text display of the specified level.
getProfiling()
публичный Метод
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.
|
public getProfiling ( array $categories = [], array $excludeCategories = [] ) : array |
|
$categories |
array |
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\Connection'. |
|
$excludeCategories |
array |
list of categories that you want to exclude |
| Результат |
array |
the profiling results. Each element is an array consisting of these elements:
`info`, `category`, `timestamp`, `trace`, `level`, `duration`. |
Initializes the logger by registering
Logger::flush as a shutdown function.
If [[traceLevel]] is greater than 0, additional call stack information about
the application code will be logged as well.
|
public log ( string | array $message, integer $level, string $category = 'application' ) |
|
$message |
string | array |
the message to be logged. This can be a simple string or a more
complex data structure that will be handled by a [[Target|log target]]. |
|
$level |
integer |
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`. |
|
$category |
string |
the category of the message. |
Описание свойств
$dispatcher публичное свойство
$flushInterval публичное свойство
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
Logger::flush.
$messages публичное свойство
logged messages. This property is managed by
Logger::log and
Logger::flush.
Each log message is of the following structure:
[
[0] => message (mixed, can be a string or some complex data, such as an exception object)
[1] => level (integer)
[2] => category (string)
[3] => timestamp (float, obtained by microtime(true))
[4] => traces (array, debug backtrace, contains the application code call stacks)
]
$traceLevel публичное свойство
how much call stack information (file name and line number) should be logged for each message.
If it is greater than 0, at most that number of call stacks will be logged. Note that only application
call stacks are counted.