Download the PHP package yiisoft/log without Composer
On this page you can find all versions of the php package yiisoft/log. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package log
Yii Logging Library
This package provides a PSR-3 compatible logging library. It is used extensively in the Yii Framework but it can also be used as a separate package.
The logger sends or passes messages to multiple targets. Each target may filter these messages according to their severity level, and category, and then export them to some medium such as a file, an email or a syslog.
Requirements
- PHP 8.0 or higher.
Installation
The package can be installed with Composer:
General usage
Creating a logger:
Writing logs:
Message Flushing and Exporting
Log messages are collected and stored in memory. To limit memory consumption, the logger will flush
the recorded messages to the log targets each time a certain number of log messages accumulate.
You can customize this number by calling the \Yiisoft\Log\Logger::setFlushInterval()
method:
Each log target also collects and stores messages in memory.
Message exporting in a target follows the same principle as in the logger.
To change the number of stored messages, call the \Yiisoft\Log\Target::setExportInterval()
method:
Note: All message flushing and exporting also occurs when the application ends.
Logging targets
This package contains two targets:
Yiisoft\Log\PsrTarget
- passes log messages to another PSR-3 compatible logger.Yiisoft\Log\StreamTarget
- writes log messages to the specified output stream.
Extra logging targets are implemented as separate packages:
Context providers
Context providers are used to provide additional context data for log messages. You can define your own context provider
in the Logger
constructor:
Out of the box, the following context providers are available:
SystemContextProvider
— adds system information (time, memory usage, trace, default category);CommonContextProvider
— adds common data;CompositeContextProvider
— allows combining multiple context providers.
By default, the logger uses the built-in SystemContextProvider
.
SystemContextProvider
The SystemContextProvider
adds the following data to the context:
time
— current Unix timestamp with microseconds (float value);trace
— array of call stack information;memory
— memory usage in bytes.category
— category of the log message (always "application").
Yiisoft\Log\ContextProvider\SystemContextProvider
constructor parameters:
traceLevel
— how much call stack information (file name and line number) should be logged for each log message. If the traceLevel is greater than 0, a similar number of call stacks will be logged at most. Note that only application call stacks are counted.excludedTracePaths
— array of paths to exclude from tracing when tracing is enabled withtraceLevel
.
An example of custom parameters' usage:
CommonContextProvider
The CommonContextProvider
allows the adding of additional common information to the log context, for example:
CompositeContextProvider
The CompositeContextProvider
allows the combining of multiple context providers into one, for example:
Documentation
- Yii guide to logging
- Internals
If you need help or have a question, the Yii Forum is available. You may also check out other Yii Community Resources.
License
The Yii Logging Library is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.