yiisoft / log-target-file
Yii Logging Library - File Target
Fund package maintenance!
Open Collective
yiisoft
Installs: 26 911
Dependents: 22
Suggesters: 1
Security: 0
Stars: 17
Watchers: 12
Forks: 6
Open Issues: 0
Requires
- php: ^7.4|^8.0
- yiisoft/files: ^1.0
- yiisoft/log: ^1.0
Requires (Dev)
- phpunit/phpunit: ^9.4
- roave/infection-static-analysis-plugin: ^1.5
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.2
Suggests
- ext-zlib: Enabling gzip compression of rotated files.
This package is auto-updated.
Last update: 2021-04-10 07:18:42 UTC
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
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, $rotateByCopy, $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
.$rotateByCopy (bool|null)
- Whether to rotate files by copy and truncate in contrast to rotation by renaming files. Defaults totrue
for Windows systems that do not play well with rename on open files. The default for other systems isfalse
, as rotation by renaming is slightly faster.$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 a description of using the logger, see the yiisoft/log package.
For use in the Yii framework, see the configuration files:
See Yii guide to logging for more info.
Unit testing
The package is tested with PHPUnit. To run tests:
./vendor/bin/phpunit
Mutation testing
The package tests are checked with Infection mutation framework. To run it:
./vendor/bin/infection
Static analysis
The code is statically analyzed with Psalm. To run static analysis:
./vendor/bin/psalm
Support the project
Follow updates
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.