https://github.com/alleyinteractive/logger
A Monolog-based logging tool for WordPress. Supports storing log message in a custom post type or in individual posts and terms.
https://github.com/alleyinteractive/logger
logger logging monolog wordpress wordpress-plugin
Last synced: 3 months ago
JSON representation
A Monolog-based logging tool for WordPress. Supports storing log message in a custom post type or in individual posts and terms.
- Host: GitHub
- URL: https://github.com/alleyinteractive/logger
- Owner: alleyinteractive
- Created: 2016-09-10T22:21:24.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-20T16:53:20.000Z (7 months ago)
- Last Synced: 2025-03-12T21:48:20.227Z (4 months ago)
- Topics: logger, logging, monolog, wordpress, wordpress-plugin
- Language: PHP
- Homepage:
- Size: 3.77 MB
- Stars: 29
- Watchers: 49
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Logger
Providing a WordPress integration with Monolog, allowing site-wide and post and
term specific logging.
## Documentation
See the [wiki](https://github.com/alleyinteractive/logger/wiki) for complete information and more examples.
## Installation
Logger requires PHP 8.1 and Composer to run properly.
```bash
composer require alleyinteractive/logger
```
You can also install the plugin as a submodule by using the `*-built` tag of a
release.
## Usage
AI Logger is a complete interface to Monolog with some nice WordPress handlers built in.
```php
// Log site-wide to the ai_log post type.
ai_logger()->info( 'Log message...' );
\AI_Logger\AI_Logger::info( 'Another format for logging.' );
```
### Logging to a Specific Post
Logs will be appended to a post's meta for review.
```php
ai_logger_to_post( $post_id, 'meta-key' )->info( 'This will log to the for a specific post.' );
```
### Logging to a Specific Term
Logs will be appended to a term's meta for review.
```php
ai_logger_to_term( $term_id, 'meta-key' )->info( 'This will log to the for a specific term.' );
```
### Logging to Query Monitor
```php
ai_logger_to_qm()->info( 'This will show up in Query Monitor!' );
```
### Logging with Default Context
```php
ai_logger()->with_context( 'example-context' )->info( 'This will log to the example-context.' );
```
Also supports an array of default log context:
```php
ai_logger()->with_context(
[
'context' => 'example-context',
'key' => 'value',
]
)->info( 'This will log to the example-context with key=>value.' );
```
You can also pass the context to `ai_logger()` directly:
```php
ai_logger( 'example-context' )->info( 'This will log to the example-context.' );
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed
recently.
## Maintainers
This project is actively maintained by [Alley
Interactive](https://github.com/alleyinteractive). Like what you see? [Come work
with us](https://alley.com/careers/).
## License
This software is released under the terms of the GNU General Public License
version 2 or any later version.