Get notified and execute PHP callback when you have stuck jobs for a defined number of hours.
Notifications can be sent by mail, Slack and webhooks (chats often provide a webhook API).
Found this package helpful? Please consider supporting my work!
Compatibility
| Laravel version | PHP version | Package version |
|---|---|---|
| ^8.0 | ^9.0 | ^8.0 | ^8.1 | ^2.2 |
| ^7.0 | ^8.0 | ^7.4 | ^8.0 | ^2.1 |
| ^7.0 | ^8.0 | ^7.4 | ^2.0 |
| ^6.0 | ^7.0 | ^7.4 | ^1.0 |
Upgrade guide
Table of Contents
Installation
Install the package with composer:
composer require okipa/laravel-stuck-jobs-notifier
If you intend to send Slack notifications you will have to install:
composer require laravel/slack-notification-channel
If you intend to send webhook notifications you will have to install:
composer require laravel-notification-channels/webhook
Configuration
Publish the package configuration:
php artisan vendor:publish --tag=stuck-jobs-notifier:config
Translations
All words and sentences used in this package are translatable.
See how to translate them on the Laravel official documentation: https://laravel.com/docs/localization#using-translation-strings-as-keys.
Here is the list of the words and sentences available for translation by default:
* {1}[:app - :env] :count job is stuck in queue|[2,*][:app - :env] :count jobs are stuck in queue
* {1}We have detected that :count job is stuck in the [:app - :env](:url) queue since the :day at :hour.|[2,*]We have detected that :count jobs are stuck in the [:app - :env](:url) queue since the :day at :hour.
* Please check your stuck jobs connecting to your server and executing the "php artisan queue:failed" command.
* {1}`[:app - :env]` :count job is stuck in the :url queue since the :day at :hour.|[2,*]`[:app - :env]` :count jobs are stuck in the :url queue since the :day at :hour.
* {1}:count job is stuck in queue since the :day at :hour.|[2,*]:count jobs are stuck in queue since the :day at :hour.
* Notification test:
* Exception test:
Usage
Just add this command in the schedule() method of your \App\Console\Kernel class:
$schedule->command('queue:stuck:notify')->twiceDaily(10, 16);
And you will be notified as soon as some jobs will be stuck in the failed_jobs table for the number of days you configured.
Once everything has been set up, you can check if the configuration is correct by simulating stuck jobs detection:
php artisan queue:stuck:simulate
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.
2 Dec 1, 2021
9 Dec 9, 2022
1 Jan 7, 2022
173 Dec 17, 2022
1.4k Dec 26, 2022
5 Dec 15, 2022
2 May 2, 2022
1 Jul 4, 2022
68 Dec 21, 2022
13k Jan 8, 2023
1.9k Jan 1, 2023
1.5k Jan 3, 2023
1.7k Dec 14, 2022
11 Mar 15, 2022
5.7k Jan 9, 2023
26 Sep 9, 2022
6 Jan 16, 2022
87 Nov 26, 2022
3 Jul 27, 2021
748 Dec 16, 2022
8 Nov 8, 2022
1.2k Jan 2, 2023
1k Dec 25, 2022
220 Dec 25, 2022
69 Nov 18, 2022
103 Dec 7, 2022
15 Nov 9, 2022