Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-failed-job-monitor
Get notified when a queued job fails
https://github.com/spatie/laravel-failed-job-monitor
laravel monitor notifications php queue slack
Last synced: 3 days ago
JSON representation
Get notified when a queued job fails
- Host: GitHub
- URL: https://github.com/spatie/laravel-failed-job-monitor
- Owner: spatie
- License: mit
- Created: 2016-02-18T12:40:13.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T07:57:41.000Z (4 months ago)
- Last Synced: 2024-10-25T02:39:11.025Z (10 days ago)
- Topics: laravel, monitor, notifications, php, queue, slack
- Language: PHP
- Homepage: https://freek.dev/390-get-notified-when-a-queued-job-fails
- Size: 130 KB
- Stars: 905
- Watchers: 17
- Forks: 52
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-laravel-framework - Laravel Failed Job Monitor - Get notified when a queued job fails (Popular Packages)
- awesome-laravel - Laravel Failed Job Monitor - Reciba notificaciones cuando falle un trabajo en cola (Paquetes utiles)
- laravel-awesome - Laravel Failed Job Monitor - Get notified when a queued job fails (Popular Packages)
- awesome-laravel - Laravel Failed Job Monitor - Get notified when a queued job fails (Popular Packages)
README
# Get notified when a queued job fails
[](https://packagist.org/packages/spatie/laravel-failed-job-monitor)
[](LICENSE.md)
[](https://packagist.org/packages/spatie/laravel-failed-job-monitor)
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.
## Support us
[
](https://spatie.be/github-ad-click/laravel-failed-job-monitor)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
> For Laravel versions 5.8 and 6.x, use v3.x of this package.
You can install the package via composer:
``` bash
composer require spatie/laravel-failed-job-monitor
```
If you intend to use Slack notifications you should also install the guzzle client:
``` bash
composer require guzzlehttp/guzzle
```
The service provider will automatically be registered.
Next, you must publish the config file:
```bash
php artisan vendor:publish --tag=failed-job-monitor-config
```
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.
```php
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,
/*
* By default notifications are sent for all failures. You can pass a callable to filter
* out certain notifications. The given callable will receive the notification. If the callable
* return false, the notification will not be sent.
*/
'notificationFilter' => null,
/**
* The channels to which the notification will be sent.
*/
'channels' => ['mail', 'slack'],
'mail' => [
'to' => ['[email protected]'],
],
'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.
```php
// config/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.
```php
// config/failed-job-monitor.php
return [
'notifiable' => \App\CustomNotifiableForFailedJobMonitor::class,
...
```
### Filtering the notifications
To filter the notifications, pass a closure to the `notificationFilter`.
```php
// config/failed-job-monitor.php
return [
...
'notificationFilter' => function (Spatie\FailedJobMonitor\Notification $notification): bool
{
return true;
}
...
```
The above works only that Laravel doesn't support closure serialization. Thus you will get the following error when you run `php artisan config:cache`
```
LogicException : Your configuration files are not serializable.
```
It would thus be better to create a separate class and use a callable as the callback.
```php
[App\Notifications\FailedJobNotification::class, 'notificationFilter'],
...
```
## Usage
If you configured the package correctly, you're done. You'll receive a notification when a queued job fails.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
composer test
```
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
A big thank you to [Egor Talantsev](https://github.com/spyric) for his help creating `v2` of the package.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.