yiisoft / log-target-file
Yii Logging Library - File Target
Fund package maintenance!
Opencollective
yiisoft
Installs: 217 025
Dependents: 31
Suggesters: 1
Security: 0
Stars: 21
Watchers: 17
Forks: 9
Open Issues: 0
Requires
- php: ^8.0
- ext-zlib: *
- yiisoft/files: ^1.0|^2.0
- yiisoft/log: ^2.0
Requires (Dev)
- maglnet/composer-require-checker: ^4.2
- phpunit/phpunit: ^9.5
- rector/rector: ^0.15.1
- roave/infection-static-analysis-plugin: ^1.25
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.30|^5.2
- yiisoft/aliases: ^3.0
- yiisoft/di: ^1.0
Suggests
- ext-zlib: Enabling gzip compression of rotated files.
README
Yii Logging Library - File Target
This package provides the File target for the yiisoft/log. The target:
- records log messages in a file
- allows you to configure log files rotation
- provides the ability to compress rotated log files
Requirements
- PHP 8.0 or higher.
Installation
The package could be installed with Composer:
composer require yiisoft/log-target-file
General usage
Creating a rotator:
$rotator = new \Yiisoft\Log\Target\File\FileRotator( $maxFileSize, $maxFiles, $fileMode, $compressRotatedFiles );
$maxFileSize (int)
- The maximum file size, in kilo-bytes. Defaults to10240
, meaning 10MB.$maxFiles (int)
- The number of files used for rotation. Defaults to5
.$fileMode (int|null)
- The permission to be set for newly created files. Defaults tonull
.$compressRotatedFiles (bool)
- Whether to compress rotated files with gzip. Defaults tofalse
.
Creating a target:
$fileTarget = new \Yiisoft\Log\Target\File\FileTarget( $logFile, $rotator, $dirMode, $fileMode );
$logFile (string)
- The log file path. Defaults to/tmp/app.log
.$rotator (\Yiisoft\Log\Target\File\FileRotatorInterface|null)
- Defaults tonull
, which means that log files will not be rotated.$dirMode (int)
- The permission to be set for newly created directories. Defaults to0775
.$fileMode (int|null)
- The permission to be set for newly created log files. Defaults tonull
.
Creating a logger:
$logger = new \Yiisoft\Log\Logger([$fileTarget]);
For use in the Yii framework, see the configuration files:
Documentation
For a description of using the logger, see the yiisoft/log package.
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii Logging Library - File Target is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.