Get notified when a queued job fails
This package sends notifications if a queued job fails. Out of the box it can send a notification via mail and/or Slack. It leverages Laravel's native notification system.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Installation
You can install the package via composer:
composer require spatie/laravel-failed-job-monitor
If you intend to use Slack notifications you should also install the guzzle client:
composer require guzzlehttp/guzzle
The service provider will automatically be registered.
Next, you must publish the config file:
php artisan vendor:publish --provider="Spatie\FailedJobMonitor\FailedJobMonitorServiceProvider"
This is the contents of the default configuration file. Here you can specify the notifiable to which the notifications should be sent. The default notifiable will use the variables specified in this config file.
return [
/**
* The notification that will be sent when a job fails.
*/
'notification' => \Spatie\FailedJobMonitor\Notification::class,
/**
* The notifiable to which the notification will be sent. The default
* notifiable will use the mail and slack configuration specified
* in this config file.
*/
'notifiable' => \Spatie\FailedJobMonitor\Notifiable::class,
/**
* The channels to which the notification will be sent.
*/
'channels' => ['mail', 'slack'],
'mail' => [
'to' => 'email@example.com',
],
'slack' => [
'webhook_url' => env('FAILED_JOB_SLACK_WEBHOOK_URL'),
],
];
Configuration
Customizing the notification
The default notification class provided by this package has support for mail and Slack.
If you want to customize the notification you can specify your own notification class in the config file.
// config/laravel-failed-job-monitor.php
return [
...
'notification' => \App\Notifications\CustomNotificationForFailedJobMonitor::class,
...
Customizing the notifiable
The default notifiable class provided by this package use the channels
, mail
and slack
keys from the config
file to determine how notifications must be sent
If you want to customize the notifiable you can specify your own notifiable class in the config file.
// config/laravel-failed-job-monitor.php
return [
'notifiable' => \App\CustomNotifiableForFailedJobMonitor::class,
...
Usage
If you configured the package correctly, you're done. You'll receive a notification when a queued job fails.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
All postcards are published on our website.
Credits
A big thank you to Egor Talantsev for his help creating v2
of the package.
Support us
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon.
All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
License
The MIT License (MIT). Please see License File for more information.