Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johannschopplich/kirbylog
🪃 Zero-dependency global `kirbylog()` helper for any content
https://github.com/johannschopplich/kirbylog
kirby-cms kirby-plugin
Last synced: 7 days ago
JSON representation
🪃 Zero-dependency global `kirbylog()` helper for any content
- Host: GitHub
- URL: https://github.com/johannschopplich/kirbylog
- Owner: johannschopplich
- License: mit
- Created: 2021-08-23T11:35:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-16T13:27:37.000Z (about 1 year ago)
- Last Synced: 2024-11-02T04:51:48.798Z (14 days ago)
- Topics: kirby-cms, kirby-plugin
- Language: PHP
- Homepage: https://kirby.tools
- Size: 694 KB
- Stars: 20
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```php
// Anywhere in your code
kirbylog('Something happened');
```
… will produce this example output `site/logs/2023-08-23.log`:
```log
[2023-08-23 09:28:04] INFO Something happened
```
## Key features
- 🪃 Global `kirbylog()` helper usable anywhere
- 💬 Arrays will be converted to JSON
- 🧩 Dependency-free, based solely on Kirby internals
- 🔢 Supports logging levels
## Installation
### Composer
```bash
composer require johannschopplich/kirbylog
```
### Download
Download and copy this repository to `/site/plugins/kirbylog`.
## Usage
This plugin registers a global `kirbylog` function, callable anywhere.
```php
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](http://tools.ietf.org/html/rfc5424). Of course, you can tailor them to your needs.
```php
kirbylog($response->code(), 'error');
```
Generated log file:
```log
[2023-08-23 12:43:56] ERROR 401
```
## Options
> All options have to prefixed with `johannschopplich.kirbylog.` in your `config.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` | `date('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](https://github.com/johannschopplich/kirbylog/blob/main/index.php#L15) | `array` | List of logging levels. By default, `kirbylog` supports the logging levels described by [RFC 5424](http://tools.ietf.org/html/rfc5424). |
Configuration example for your `site/config/config.php` file:
```php
return [
'johannschopplich.kirbylog' => [
'filename' => 'test.log'
]
]
```
## Alternatives
- [bnomei/kirby3-monolog](https://github.com/bnomei/kirby3-monolog) – Use Monolog to log data to files, databases, create notifications etc.
- [bvdputte/kirby-log](https://github.com/bvdputte/kirby-log) – Another logger in the Kirby-sphere, wrapping the [KLogger](https://github.com/katzgrau/KLogger) library.
## License
[MIT](./LICENSE) License © 2022-PRESENT [Johann Schopplich](https://github.com/johannschopplich)