Kirbylog
The most simple, Kirby-esque way to log content to file.
Most of the time, I just want to log some string or array to a file. That's what this plugin does. The given input:
// Anywhere in your code
kirbylog('Something happened');
… will produce this example output site/logs/2021-08-23.log:
[2021-08-23 09:28:04] INFO Something happened
Key features
-
🪃 Globalkirbylog()helper usable anywhere -
💬 Arrays will be converted to JSON -
🧩 Dependency-free, based solely on Kirby internals -
🔢 Supports logging levels
Installation
Download
Download and copy this repository to /site/plugins/kirbylog.
Git submodule
git submodule add https://github.com/johannschopplich/kirbylog.git site/plugins/kirbylog
Composer
composer require johannschopplich/kirbylog
Usage
This plugin registers a global kirbylog function, callable anywhere.
kirbylog('Log this to file');
Logging level
Pass the logging level of your choice as the second parameter (upper or lower case is irrelevant). By default, content will be logged with the INFO level. This plugin uses logging levels described by RFC 5424. Of course, you can tailor them to your needs.
kirbylog($response->code(), 'error');
Generated log file:
[2021-08-23 12:43:56] ERROR 401
Options
All options have to prefixed with
johannschopplich.kirbylog.in yourconfig.php.
| Option | Default | Type | Description |
|---|---|---|---|
dir |
fn () => kirby()->root('logs') |
string or function |
Root directory for your logs. Note: Wrap kirby() calls in a function, because Kirby hasn't initialized in config.php yet. |
filename |
strftime('%Y-%m-%d') . '.log' |
string |
Filename to write logged content to. |
defaultLevel |
info |
string |
Default logging level to use. Doesn't need to be case sensitive. |
levels |
Source reference | array |
List of logging levels. By default, kirbylog supports the logging levels described by RFC 5424. |
Configuration example for your site/config/config.php file:
return [
'johannschopplich' => [
'kirbylog' => [
'filename' => 'test.log'
]
]
]
Alternatives
- bnomei/kirby3-monolog – Use Monolog to log data to files, databases, create notifications etc.
- bvdputte/kirby-log – Another logger in the Kirby-sphere, wrapping the KLogger library.
License
MIT
12 Nov 15, 2022
242 Dec 26, 2022
106 Sep 30, 2022
797 Jan 5, 2023
13 Dec 19, 2022
28 Nov 15, 2022
342 Dec 30, 2022
3 Aug 24, 2021
13 Nov 9, 2022
3 Feb 22, 2022
12 Nov 3, 2022
5 Dec 16, 2022
13 May 24, 2022
18 Aug 17, 2021
1.2k Jan 4, 2023
865 Dec 26, 2022
194 Dec 27, 2022
273 Jan 4, 2023
507 Dec 27, 2022