README

This package sends notifications if a queued job fails. However sometimes there are jobs that will trigger far too many notifications when failing and therefore throttling for those would be desirable. Out of the box it can send a notification via mail, Slack, and Microsoft Teams. It leverages Laravel's native notification system.

This package is heavily based on Laravel failed job monitor by Spatie

Installation

You can install the package via composer:

composer require talvbansal/laravel-throttled-failed-jobs

The service provider will automatically be registered.

Next, you must publish the config file:

php artisan vendor:publish --provider="TalvBansal\ThrottledFailedJobMonitor\FailedThrottledJobsServiceProvider"

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' => \TalvBansal\ThrottledFailedJobMonitor\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' => \TalvBansal\ThrottledFailedJobMonitor\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', 'msteams'],

    'mail' => [
        'to' => 'email@example.com',
    ],

    'slack' => [
        'webhook_url' => env('FAILED_JOB_SLACK_WEBHOOK_URL'),
    ],

    'ms-teams' => [
        'webhook_url' => env('MS_TEAMS_WEBHOOK_URL'),
    ],

    /*
     * The length of the throttle window in minutes. Eg: 10 would mean
     * only one notification of certain type would be actually sent
     * within a 10 minute window...
     */
    'throttle_decay' => 10,
];

Configuration

Customizing the notification

The default notification class provided by this package has support for mail, Slack and MS Teams.

If you want to customize the notification you can specify your own notification class in the config file.

// config/throttled-failed-jobs.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/throttled-failed-jobs.php
return [
    'notifiable' => \App\CustomNotifiableForFailedJobMonitor::class,
    ...

Customizing the throttle window

The default config sets a window of 10 minutes per notification type. You can easily change the length of that window so that you only receive 1 notification of a given type per x number of minutes in the config file.

// config/throttled-failed-jobs.php
return [
        'throttle_decay' => 10,
    ...

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

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

Please see this repo for instructions on how to submit a channel proposal.

talvbansal / laravel-throttled-failed-jobs

Maintainers

Details