flyingluscas / Laravel-BugNotifier

Get notified every time an exception is thrown in your application.
MIT License
24 stars 2 forks source link

BugNotifier

Latest Version on Packagist Software License Build Status StyleCI SensioLabs Insight Quality Score Total Downloads

This is a Laravel 5.x package to help you track down bugs on your applications by using notifications.

BugNotifier will catch the exceptions thrown by Laravel and notify you through e-mail.

Install

Via Composer

$ composer require flyingluscas/bug-notifier

Usage

1. Service Provider

Add the BugNotifierServiceProvider under the providers section on config/app.php file.

'providers' => [
    // ...
    FlyingLuscas\BugNotifier\BugNotifierServiceProvider::class,
],

2. Configuration

Run this command in your terminal to publish the configuration file.

$ php artisan vendor:publish --provider="FlyingLuscas\BugNotifier\BugNotifierServiceProvider"

This command will generate the config/bugnotifier.php config file.

Inside the configuration file, you can add the environments that BugNotifier should watch for exceptions, configure a list of exceptions that should be ignored and choose the driver used to send the notifications.

3. Setting up

Ok, now that our service provider is in place and our configuration file is set, let's set up the BugNotifier to watch for exceptions in our application.

Go to your app/Exceptions/Handler.php file, and scroll down to the report method, this method is very important, here you can intercept any exceptions thrown by Laravel, so use the Notify facade to set it up.

use FlyingLuscas\BugNotifier\Facades\Notify;

// ...

public function report(Exception $exception)
{
    parent::report($exception);

    Notify::exception($exception);
}

And that's it, you are ready to track down every exception thrown by your application and be notified about it, if you wanna build your own notification driver, see this wiki for more information.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email lucas.pires.mattos@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.