Download the PHP package code-distortion/clarity-logger without Composer
On this page you can find all versions of the php package code-distortion/clarity-logger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download code-distortion/clarity-logger
More information about code-distortion/clarity-logger
Files in code-distortion/clarity-logger
Package clarity-logger
Short Description A Laravel package that generates useful logs
License MIT
Homepage https://github.com/code-distortion/clarity-logger
Informations about the package clarity-logger
Clarity Logger - Useful Exception Logs
code-distortion/clarity-logger is a Laravel package that generates useful exception logs.
Clarity Suite
Clarity Logger is a part of the Clarity Suite, designed to let you manage exceptions more easily:
- Clarity Context - Understand Your Exceptions
- Clarity Logger - Useful Exception Logs
- Clarity Control - Handle Your Exceptions
Table of Contents
- Installation
- Config File
- Update Your Exception Handler
- Manual Logging
- Adding Some Context
Installation
Install the package via composer:
Config File
Use the following command if you would like to publish the config/code_distortion.clarity_logger.php
config file:
Update Your Exception Handler
Laravel projects use an exception handler class to log exceptions. You'll need to update this so Clarity Logger can log exceptions.
Add the following to the register()
method of app/Exceptions/Handler.php
.
If you use them, Laravel's own context details can be included by adding $this->exceptionContext($e)
.
By default, Laravel adds the PHP's stacktrace to the log afterwards. You can turn this off if you like by adding ->stop()
.
Laravel will now log exceptions using Clarity Logger.
See Laravel's documentation for more information about exception handling.
Manual Logging
If you catch an exception, or would like to just log a message, you can trigger the logging yourself:
You can specify the reporting level:
If you'd like to log to a particular channel, specify it before triggering the log action:
These methods can be chained:
Adding Some Context
If you add Clarity Context to your project (which lets you add context details to your code), Clarity Logger will include your context details automatically.
This can be a powerful tool when debugging exceptions. e.g.
Testing This Package
- Clone this package:
git clone https://github.com/code-distortion/clarity-logger.git .
- Run
composer install
to install dependencies - Run the tests:
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
SemVer
This library uses SemVer 2.0.0 versioning. This means that changes to X
indicate a breaking change: 0.0.X
, 0.X.y
, X.y.z
. When this library changes to version 1.0.0, 2.0.0 and so forth, it doesn't indicate that it's necessarily a notable release, it simply indicates that the changes were breaking.
Treeware
This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
Contributing
Please see CONTRIBUTING for details.
Code of Conduct
Please see CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.