Add queue jobs check

[stfndamjanovic]

This PR is adding the possibility to monitor queue jobs. It is working almost the same as the scheduled check. The only difference is that this check will just dispatch a job, and detects if the queue job is run within five minutes. If not, the check will fail.

This is how it can be registered.

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\QueueCheck;

Health::checks([
    QueueCheck::new(),
]);

And you can change the heartbeat check as you can do with the schedule check.

QueueCheck::new()->heartbeatMaxAgeInMinutes(10),

Also, one additional cron job needs to be registered in order to dispatch the heartbeat queue job.

// in app/Console/Kernel.php
use \Spatie\Health\Commands\QueueCheckHeartbeatCommand;

public function schedule(Schedule $schedule) {
    // your other commands

    $schedule->command(QueueCheckHeartbeatCommand::class)->everyMinute();
}

Not sure if 5 minutes would work for everyone, but let's discuss it only if this PR is acceptable to you. 🙂

[freekmurze]

I like the functionality 👍 Could you also add an example on how to track different queues?

The introduction of an HeartbeatCheck interface seems a bit overkill to me. Let's remove that and keep the different checks that rely on a heartbeat be independent of each other.

[stfndamjanovic]

Hey @freekmurze, glad to hear that you like the functionality!

I have just two questions. By tracking different queues, do you mean something like this?

Health::checks([
    QueueCheck::new()->onQueue('email'),
]);

Or do you want the possibility to track many different queues? Something like this.

Health::checks([
    QueueCheck::new()->onQueues(['email', 'payment']),
]);

And the second question is, do you want to remove just the HeartbeatCheck interface and keep the HasHeartbeatCheck trait and abstract class HeartbeatCommand, or do you want to remove them as well?

[freekmurze]

Ideally, both of your code examples would work 🙂

I would remove both the abstract class and the trait. I like to keep all the check independent from each other.

[stfndamjanovic]

Thanks for the clarification Freek.

Both abstract class and trait have been removed. Examples of tracking different queues are part of the docs file.

How it's working now? If you specify more than one queue that you want to track and if any of them fail, the result will be failed and in meta will be explained which queue failed and why. If all queues are fine, the result will be a success.

Let me know if anything else should be changed, or improved.

[freekmurze]

Thank you, I'll polish this a bit an release it 👍