Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/squareboat/sneaker
An easy way to send emails whenever an exception occurs on server.
https://github.com/squareboat/sneaker
error-handling error-monitoring laravel laravel-5-package laravel-package
Last synced: 3 months ago
JSON representation
An easy way to send emails whenever an exception occurs on server.
- Host: GitHub
- URL: https://github.com/squareboat/sneaker
- Owner: squareboat
- License: mit
- Created: 2016-09-23T04:38:58.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T21:45:50.000Z (10 months ago)
- Last Synced: 2024-10-20T11:55:12.948Z (3 months ago)
- Topics: error-handling, error-monitoring, laravel, laravel-5-package, laravel-package
- Language: PHP
- Homepage:
- Size: 194 KB
- Stars: 222
- Watchers: 13
- Forks: 46
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Exception Notifications
An easy way to send emails with stack trace whenever an exception occurs on the server for Laravel applications.
## Install
### Install via Composer
#### For Laravel <= 5.2, please use the [v1 branch](https://github.com/squareboat/sneaker/tree/v1)!
#### For Laravel 5.2 < version <= 6.x, please use the [v5 branch](https://github.com/squareboat/sneaker/tree/v5)!
```
$ composer require squareboat/sneaker
```
### Configure Laravel
> If you are using __laravel 5.5__ or higher you should skip this step.
If you are using laravel 5.3 or 5.4, 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`:
```php
public function report(Exception $exception)
{
app('sneaker')->captureException($exception);
parent::report($exception);
}
```
### Configuration File
Create the Sneaker configuration file with this command:
```bash
$ 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,`.
```php
'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`.
```php
'capture' => [
Symfony\Component\Debug\Exception\FatalErrorException::class,
],
```
You can also use `'*'` in the `$capture` array which will in turn captures every exception.
```php
'capture' => [
'*'
],
```
To use this feature you should add the following code in `app/Exceptions/Handler.php`:
```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.
```php
'to' => [
// '[email protected]',
],
```
#### ignored_bots
This is the list of bots for which we should NOT send error emails.
```php
'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:
```bash
$ 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:
```bash
$ 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 [email protected] instead of using the issue tracker.
## Credits
- [Amit Gupta](https://github.com/akaamitgupta)
- [All Contributors](../../contributors)
## About SquareBoat
[SquareBoat](https://squareboat.com) is a startup focused, product development company based in Gurgaon, India. You'll find an overview of all our open source projects [on GitHub](https://github.com/squareboat).
# License
The MIT License. Please see [License File](LICENSE.md) for more information. Copyright © 2020 [SquareBoat](https://squareboat.com)