squareboat/sneaker

An easy way to send emails with stack trace whenever an exception occurs on the server for Laravel Applications.

v2.0.2 2017-04-01 14:50 UTC

README

An easy way to send emails with stack trace whenever an exception occurs on the server for Laravel applications.

sneaker example image

Install

Install via Composer

For Laravel <= 5.2, please use the v1 branch!

$ composer require squareboat/sneaker

Configure Laravel

Once installation operation is complete, simply add the service provider to your project's config/app.php file:

Service Provider

SquareBoat\Sneaker\SneakerServiceProvider::class,

Add Sneaker's Exception Capturing

Add exception capturing to app/Exceptions/Handler.php:

public function report(Exception $exception)
{
    app('sneaker')->captureException($exception);

    parent::report($exception);
}

Configuration File

Create the Sneaker configuration file with this command:

$ php artisan vendor:publish --provider="SquareBoat\Sneaker\SneakerServiceProvider"

The config file will be published in config/sneaker.php

Following are the configuration attributes used for the Sneaker.

silent

The package comes with 'silent' => true, configuration by default, since you probably don't want error emailing enabled on your development environment. Especially if you've set 'debug' => true,.

'silent' => env('SNEAKER_SILENT', true),

For sending emails when an exception occurs set SNEAKER_SILENT=false in your .env file.

capture

It contains the list of the exception types that should be captured. You can add your exceptions here for which you want to send error emails.

By default, the package has included Symfony\Component\Debug\Exception\FatalErrorException::class.

'capture' => [
    Symfony\Component\Debug\Exception\FatalErrorException::class,
],

You can also use '*' in the $capture array which will in turn captures every exception.

'capture' => [
    '*'
],

To use this feature you should add the following code in app/Exceptions/Handler.php:

public function report(Exception $exception)
{
    if ($this->shouldReport($exception)) {
        app('sneaker')->captureException($exception);
    }

    parent::report($exception);
}

to

This is the list of recipients of error emails.

'to' => [
    // 'hello@example.com',
],

ignored_bots

This is the list of bots for which we should NOT send error emails.

'ignored_bots' => [
    'googlebot',        // Googlebot
    'bingbot',          // Microsoft Bingbot
    'slurp',            // Yahoo! Slurp
    'ia_archiver',      // Alexa
],

Customize

If you need to customize the subject and body of email, run following command:

$ php artisan vendor:publish --provider="SquareBoat\Sneaker\SneakerServiceProvider"

Note - Don't run this command again if you have run it already.

Now the email's subject and body view are located in the resources/views/vendor/sneaker directory.

We have passed the thrown exception object $exception in the view which you can use to customize the view to fit your needs.

Sneak

Test your integration

To verify that Sneaker is configured correctly and our integration is working, use sneaker:sneak Artisan command:

$ php artisan sneaker:sneak

A SquareBoat\Sneaker\Exceptions\DummyException class will be thrown and captured by Sneaker. The captured exception will appear in your configured email immediately.

Security

If you discover any security related issues, please email amit.gupta@squareboat.com instead of using the issue tracker.

Credits

About SquareBoat

SquareBoat is a startup focused, product development company based in Gurgaon, India. You'll find an overview of all our open source projects on GitHub.

License

The MIT License. Please see License File for more information. Copyright © 2016 SquareBoat