cesargb / laravel-logs-rotate
Rotate files log with compression
Installs: 31 677
Dependents: 0
Suggesters: 0
Security: 0
Stars: 22
Watchers: 4
Forks: 2
Open Issues: 2
Requires
- php: ^8.0
- cesargb/php-log-rotation: ^2.7
- illuminate/config: ^10.0|^11.0
- illuminate/console: ^10.0|^11.0
- illuminate/log: ^10.0|^11.0
- illuminate/support: ^10.0|^11.0
- monolog/monolog: ^2.0|^3.0|^11.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.13
- larastan/larastan: ^2.0
- orchestra/testbench: ^8.0|^9.0
- phpunit/phpunit: ^10.5
README
This package allows you to rotate the Laravel record file with compression. This method is useful if you use logger channel single
(StreamHandler)
Installation
This package can be used in Laravel 5.5 or higher.
You can install the package via composer:
composer require cesargb/laravel-logs-rotate
Usage
At this moment, every day at 00:00 your application executes a schedule to rotate the Laravel record files.
Configuration
If you need to change the frequency or another function, you can modify the config file.
You can publish config file with:
php artisan vendor:publish --provider="Cesargb\LaravelLog\RotateServiceProvider" --tag=config
This is the contents of the published config/rotate.php config file:
<?php return [ /* |-------------------------------------------------------------------------- | Compression Enable |-------------------------------------------------------------------------- | | This option defines if the file rotated must be compressed. | If you prefer not compress file, set this value at false. */ 'log_compress_files' => true, /* |-------------------------------------------------------------------------- | Schedule Rotate |-------------------------------------------------------------------------- | | Determine when must be run the cron. | You can disable the schedule change the option enable at false. | You can change the frequency with option cron. | */ 'schedule' => [ 'enable' => true, 'cron' => '0 0 * * *', ], /* |-------------------------------------------------------------------------- | Max Files Rotated |-------------------------------------------------------------------------- | | This value determine the max number of files rotated in the archive folder. | */ 'log_max_files' => env('LOG_MAX_FILES', 5), /* |-------------------------------------------------------------------------- | Other files to rotated |-------------------------------------------------------------------------- | | Array the other foreing files | | Example: | 'foreign_files' => [ storage_path('/logs/worker.log') | ] | */ 'foreign_files' => [] ];
Command
You have a command to rotate other files, rotate:files
php artisan rotate:files --help Description: Rotate files Usage: rotate:files [options] Options: -f, --file[=FILE] Files to rotate (multiple values allowed) -c, --compress[=COMPRESS] Compress the file rotated [default: "true"] -m, --max-files[=MAX-FILES] Max files rotated [default: "5"] -d, --dir[=DIR] Dir where archive the file rotated
Events
Every time a file is rotated one of these events occurs:
RotateWasSuccessful
Cesargb\LaravelLog\Events\RotateWasSuccessful
This event will be fired when rotated was successful.
It has two public properties:
- filename: the full path of file to rotate
- filenameTarget: the full path of file rotated
RotateHasFailed
Cesargb\LaravelLog\Events\RotativeHandler
This event will be fired when an error occurs while rotated
It has two public properties:
- filename: the full path of file to rotate
- exception: an object that extends PHP's Exception class.
About
You can only rotate the logs file was generate with logger channel StreamHandler.
Test
Run test with:
composer test
Upgrading
Please see UPGRADING for details.
Contributing
Any contributions are welcome.
License
The MIT License (MIT). Please see License File for more information.