Track Job Progress and Status in Laravel with the Laravel Job Status Package

The laravel-job-status package provides a simple way to track the status and progress of your queued jobs. The package automatically saves job statuses into the database, allowing you to query and display the current progress, status, and results of any background job in your application.

You can track a queue job's status by adding the Trackable trait provided by this package:

use Imtigger\LaravelJobStatus\Trackable;
 
class MyJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels, Trackable;
 
    public function __construct(array $params)
    {
        $this->prepareStatus();
        // ...
    }
 
    public function handle()
    {
        $this->setProgressNow(10, 100); // Set current progress
        $this->setProgressMax(100); // Set max progress
 
        // Do some work...
 
        $this->setOutput(['message' => 'Job finished!']);
    }
}

When a job uses the Trackable trait, it automatically creates a database record when dispatched. You can retrieve the job status using the getJobStatusId() method on your job:

use DispatchesJobs;
 
$job = new TrackableJob([]);
$this->dispatch($job);
 
$jobStatusId = $job->getJobStatusId();
$jobStatus = JobStatus::find($jobStatusId);
 
// Model properties
$jobStatus->job_id
$jobStatus->type
$jobStatus->queue
$jobStatus->status
$jobStatus->attempts
$jobStatus->progress_now
$jobStatus->progress_max
$jobStatus->input
$jobStatus->output
$jobStatus->created_at
$jobStatus->updated_at
$jobStatus->started_at
$jobStatus->finished_at