Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okipa/laravel-stuck-jobs-notifier
Get notified when stuck jobs are detected.
https://github.com/okipa/laravel-stuck-jobs-notifier
detection failed job jobs laravel notification notifier php queue stuck
Last synced: 14 days ago
JSON representation
Get notified when stuck jobs are detected.
- Host: GitHub
- URL: https://github.com/okipa/laravel-stuck-jobs-notifier
- Owner: Okipa
- License: mit
- Created: 2020-05-05T12:52:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-19T19:59:25.000Z (over 1 year ago)
- Last Synced: 2024-10-03T19:24:04.274Z (about 1 month ago)
- Topics: detection, failed, job, jobs, laravel, notification, notifier, php, queue, stuck
- Language: PHP
- Homepage:
- Size: 142 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
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!
[](https://ko-fi.com/arthurlorent)
[](https://paypal.me/arthurlorent)
## Compatibility
| Laravel version | PHP version | Package version |
|-------------------|--------------------|-----------------|
| ^9.0 | ^10.0 | 8.1.* | 8.2.* | ^2.4 |
| ^8.0 | ^9.0 | ^8.1 | ^8.2 | ^2.3 |
| ^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
* [From v1 to V2](/docs/upgrade-guides/from-v1-to-v2.md)
* [From okipa/failed-jobs-notifier](/docs/upgrade-guides/from-failed-job-notifier.md)
## Table of Contents
* [Installation](#installation)
* [Configuration](#configuration)
* [Translations](#translations)
* [Usage](#usage)
* [Testing](#testing)
* [Changelog](#changelog)
* [Contributing](#contributing)
* [Credits](#credits)
* [Licence](#license)
## Installation
Install the package with composer:
```bash
composer require okipa/laravel-stuck-jobs-notifier
```
If you intend to send `Slack` notifications you will have to install:
* https://github.com/laravel/slack-notification-channel
```bash
composer require laravel/slack-notification-channel
```
If you intend to send `webhook` notifications you will have to install:
* https://github.com/laravel-notification-channels/webhook
```bash
composer require laravel-notification-channels/webhook
```
## Configuration
Publish the package configuration:
```bash
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:
```text
* {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:
```php
$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:
```bash
php artisan queue:stuck:simulate
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
* [Arthur LORENT](https://github.com/okipa)
* [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.