Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/log-target-file
Yii Logging Library - File Target
https://github.com/yiisoft/log-target-file
file hacktoberfest log psr-3 yii3
Last synced: 4 days ago
JSON representation
Yii Logging Library - File Target
- Host: GitHub
- URL: https://github.com/yiisoft/log-target-file
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-04-12T14:19:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-02T14:45:56.000Z (6 months ago)
- Last Synced: 2024-10-29T14:35:39.014Z (2 months ago)
- Topics: file, hacktoberfest, log, psr-3, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 167 KB
- Stars: 21
- Watchers: 17
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Logging Library - File Target
[](https://packagist.org/packages/yiisoft/log-target-file)
[](https://packagist.org/packages/yiisoft/log-target-file)
[](https://github.com/yiisoft/log-target-file/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/log-target-file)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/log-target-file/master)
[](https://github.com/yiisoft/log-target-file/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/log-target-file)
This package provides the File target for the [yiisoft/log](https://github.com/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](https://getcomposer.org):
```shell
composer require yiisoft/log-target-file
```
## General usage
Creating a rotator:
```php
$rotator = new \Yiisoft\Log\Target\File\FileRotator(
$maxFileSize,
$maxFiles,
$fileMode,
$compressRotatedFiles
);
```
- `$maxFileSize (int)` - The maximum file size, in kilo-bytes. Defaults to `10240`, meaning 10MB.
- `$maxFiles (int)` - The number of files used for rotation. Defaults to `5`.
- `$fileMode (int|null)` - The permission to be set for newly created files. Defaults to `null`.
- `$compressRotatedFiles (bool)` - Whether to compress rotated files with gzip. Defaults to `false`.
Creating a target:
```php
$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 to `null`,
which means that log files will not be rotated.
- `$dirMode (int)` - The permission to be set for newly created directories. Defaults to `0775`.
- `$fileMode (int|null)` - The permission to be set for newly created log files. Defaults to `null`.
Creating a logger:
```php
$logger = new \Yiisoft\Log\Logger([$fileTarget]);
```
For use in the [Yii framework](https://www.yiiframework.com/), see the configuration files:
- [`config/di.php`](https://github.com/yiisoft/log-target-file/blob/master/config/di.php)
- [`config/params.php`](https://github.com/yiisoft/log-target-file/blob/master/config/params.php)
## Documentation
For a description of using the logger, see the [yiisoft/log](https://github.com/yiisoft/log) package.
- [Yii guide to logging](https://github.com/yiisoft/docs/blob/master/guide/en/runtime/logging.md)
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Logging Library - File Target is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)