README.md
# Kirby 3 Monolog
[](https://travis-ci.com/bnomei/kirby3-monolog)
[](https://coveralls.io/github/bnomei/kirby3-monolog)
[](https://codeclimate.com/github/bnomei/kirby3-monolog)
[](https://twitter.com/bnomei)
Use Monolog to log data to files/databases/notifications/...
## Quickstart
**site/templates/home.php**
```php
monolog()->info('test-' . md5((string) time()), [
'title' => $page->title(), // field will be normalized
'page' => $page->id(),
]);
```
**site/logs/2019-10-27.log**
> [2019-10-27 19:10:30] default.INFO: test-d4a22afc0f735f551748d17c959b3339 {"title":"Home","page":"home"} []
**Page-Method**
This plugin also registers a Page-Method. It will use the [AutoID](https://github.com/bnomei/kirby3-autoid) if available or fallback to hash based on the `page->uid()`.
```php
$page->monolog()->info('test-' . md5((string) time()), []);
```
**site/logs/{HASH}.log**
> [2019-10-27 19:10:30] {HASH}.INFO: test-d4a22afc0f735f551748d17c959b3339 {} []
## Commerical Usage
> <br>
> <b>Support open source!</b><br><br>
> This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.<br>
> If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?<br><br>
> Be kind. Share a little. Thanks.<br><br>
> ‐ Bruno<br>
>
| M | O | N | E | Y |
|---|----|---|---|---|
| [Github sponsor](https://github.com/sponsors/bnomei) | [Patreon](https://patreon.com/bnomei) | [Buy Me a Coffee](https://buymeacoff.ee/bnomei) | [Paypal dontation](https://www.paypal.me/bnomei/15) | [Hire me](mailto:b@bnomei.com?subject=Kirby) |
## Installation
- unzip [master.zip](https://github.com/bnomei/kirby3-monolog/archive/master.zip) as folder `site/plugins/kirby3-monolog` or
- `git submodule add https://github.com/bnomei/kirby3-monolog.git site/plugins/kirby3-monolog` or
- `composer require bnomei/kirby3-monolog`
## Similar Plugin
- [Log](https://github.com/bvdputte/kirby-log) is simpler and can just write to files
## Setup
Use the [default channel](https://github.com/bnomei/kirby3-monolog/blob/master/index.php#L11) provided by this plugin or define your own *Channels*. Monolog comes bundled with a lot of [handlers, formatters and processors](https://github.com/Seldaek/monolog/blob/master/doc/02-handlers-formatters-processors.md).
- write to file or syslogs
- send mails
- post to slack
- insert into local or remote databases
- format as JSON
- append file/class/method Introspection
- append a UUID
- append URI, post method and IP
- ... create your own
## Usecase
### Named Channel => Logger
```php
// write to channel 'default' which writes to file
// defined at 'bnomei.monolog.file' callback
$log = \Bnomei\Log::singleton()->channel('default');
// is same as
$log = monolog('default');
// or simply
$log = monolog();
// get a logger instance by channel by name
$securityLogger = monolog('security');
```
### Add records to the Logger
#### Message
```php
$log = monolog();
$log->warning('Foo');
// or with method chaining
monolog()->error('Bar');
```
#### Message and Context
```php
monolog()->info('Adding a new user', [
'username' => $user->name(),
]);
// increment Field `visits` in current Page
$page = $page->increment('visits');
monolog()->info('Incrementing Field', [
'page' => $page->id(),
'visits' => $page->visits()->toInt(),
]);
```
## Default Channel
The [default channel](https://github.com/bnomei/kirby3-monolog/blob/master/index.php#L11) provided by this plugin [writes file](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/StreamHandler.php) to the `site/logs` folder. It will be using the filename format `date('Y-m-d') . '.log'` and [normalizes the data](https://github.com/bnomei/kirby3-monolog/blob/master/classes/KirbyFormatter.php) to make logging Kirby Objects easier.
> HINT: Without that normalization you would have to call `->value()` or cast as `string` on every Kirby Field before adding its value as context data.
> HINT: The default channel logs will be generated at same folder level as your accounts, cache or sessions. This way server setups for zero-downtime deployments are supported out of the box.
## Custom Channel
**site/config/config.php**
```php
return [
// other config settings ...
// (optional) add custom channels
'bnomei.monolog.channels' => [
'security' => function() {
$logger = new \Monolog\Logger('security');
// add handlers, formatters, processors and then...
return $logger;
}
],
];
```
## Custom Channel Extends
**site/config/config.php**
```php
return [
// other config settings ...
// (optional) add custom channels from other plugins
'bnomei.monolog.channels.extends' => [
'myplugin.name.channels', // array of channel definitions in your other option
],
];
```
## Dependencies
- [Seldaek/monolog](https://github.com/Seldaek/monolog)
## Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/kirby3-monolog/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.