flyingluscas/bug-notifier

Get notified every time an exception is thrown in your application.

BugNotifier

![Software License][ico-license] ![StyleCI][ico-styleci] ![SensioLabs Insight][ico-sensiolabs] ![Total Downloads][ico-downloads], _(*1)

This is a Laravel 5.x package to help you track down bugs on your applications by using notifications., _(*2)

BugNotifier will catch the exceptions thrown by Laravel and notify you through e-mail., _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require flyingluscas/bug-notifier, <sub>(*5)</sub>

## Usage

### 1. Service Provider
Add the `BugNotifierServiceProvider` under the `providers` section on `config/app.php` file.

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

2. Configuration

Run this command in your terminal to publish the configuration file., <sub>(*6)</sub>

``` bash $ php artisan vendor:publish --provider="FlyingLuscas\BugNotifier\BugNotifierServiceProvider", <sub>(*7)</sub>

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.

``` php
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., <sub>(*8)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*9)</sub>

Testing

bash $ composer test, <sub>(*10)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*11)</sub>

Security

If you discover any security related issues, please email lucas.pires.mattos@gmail.com instead of using the issue tracker., <sub>(*12)</sub>

Credits

• Lucas Pires
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*13)</sub>