https://github.com/linkorb/flex-log
FlexLog: configurable logging for your application
https://github.com/linkorb/flex-log
Last synced: 3 months ago
JSON representation
FlexLog: configurable logging for your application
- Host: GitHub
- URL: https://github.com/linkorb/flex-log
- Owner: linkorb
- Created: 2019-04-26T08:02:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T09:26:44.000Z (over 2 years ago)
- Last Synced: 2024-09-22T10:17:00.390Z (8 months ago)
- Language: PHP
- Size: 3.91 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# flex-log
FlexLog: flexible configurable logging for your applications
Allows reconfiguring the handlers, processor and formatters of your application's loggers through environment variables and config files.
FlexLog is a very thin wrapper around the awesome [monolog-cascade](https://github.com/theorchard/monolog-cascade) library.
It adds:
* simple initialization based on the config file specified by the `FLEX_LOG` environment variable
* ensures that all loggers your application expects are always added to Monolog's Registry, even if no cascade config file is used, or it misses a definition for that logger name.
## Configuration
```
## Specify a cascade config file (yaml):
FLEX_LOG=/path/to/my/cascade.yaml
```
## Usage
At the earliest entry point in your application (index.php, bootstap.php, etc), add the following line to initialize FlexLog:
```php
use FlexLog\FlexLog;
FlexLog::initFromEnv()
FlexLog::ensureLoggers(['app', 'db', 'caching']); // ensures that loggers with these names exist and are registered
```
Then, from anywhere in your app, log to monolog as usual. For example by using Monolog's registry:
```php
$username = 'joe';
\Monolog\Registry::app()->info("User {username} logged in", ['username' => $username]);
```
A fully working example can be found in the test cases in `tests/`
## Tests
```
./vendor/bin/phpunit --bootstrap vendor/autoload.php tests/
```
## Links
* [Monolog Cascade](https://github.com/theorchard/monolog-cascade)
* [Monolog](https://github.com/Seldaek/monolog)