https://github.com/bnomei/kirby3-monolog
Use Monolog to log data to files/databases/notifications/...
https://github.com/bnomei/kirby3-monolog
formatters handlers kirby3 kirby3-cms kirby3-plugin log log-file logging monolog processors psr-3 wrappers
Last synced: 9 months ago
JSON representation
Use Monolog to log data to files/databases/notifications/...
- Host: GitHub
- URL: https://github.com/bnomei/kirby3-monolog
- Owner: bnomei
- License: mit
- Created: 2019-08-18T10:34:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-02T10:17:28.000Z (over 2 years ago)
- Last Synced: 2024-10-11T03:07:33.512Z (about 1 year ago)
- Topics: formatters, handlers, kirby3, kirby3-cms, kirby3-plugin, log, log-file, logging, monolog, processors, psr-3, wrappers
- Language: PHP
- Homepage:
- Size: 1.32 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Kirby Monolog
[](https://getkirby.com)
[](https://codeclimate.com/github/bnomei/kirby3-monolog)
[](https://codeclimate.com/github/bnomei/kirby3-monolog/issues)
[](https://discordapp.com/users/bnomei)
[](https://www.buymeacoffee.com/bnomei)
Use Monolog to log data to files/databases/notifications/...
## 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`
## Quickstart
**site/templates/home.php**
```php
monolog()->info('test-' . md5((string) time()), [
'title' => $page->title(), // field will be normalized
'page' => $page->id(),
]);
```
**site/logs/2024-10-27.log**
```log
[2024-10-27 19:10:30] default.INFO: test-d4a22afc0f735f551748d17c959b3339 {"title":"Home","page":"home"} []
```
**Page-Method**
This plugin also registers a Page-Method which will use the UUID of the page as a `channel`. You can use it like this:
```php
$page->monolog()->info('test-' . md5((string) time()), [/*...*/]);
```
**site/logs/2024-10-27.log**
```log
[2024-10-27 19:10:30] {UUID_of_page}.INFO: test-d4a22afc0f735f551748d17c959b3339 {} []
```
## 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.
- write to file or syslogs
- send mails
- post to Slack/Discord
- 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 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.
> [!NOTE]
> Without that normalization you would have to call `->value()` or cast as `string` on every Kirby Field before adding its value as context data.
## 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.